Pular para o conteúdo principal

Finalizar processo de mensagem

Este artigo explica como finalizar um processo de mensagem em aberto através da REST API do Unico Check.

Como usar?

Faça uma requisição POST para o endpoint /messages/{processoId}

Com o token de acesso válido, faça uma requisição para o endpoint (POST/messages/{processoId}).

Parametros:

  • HEADER PARAMETERS
NomeTipoMandatorio/OpcionalDescrição
APIKEYStringMandatórioAPI key
AuthorizationStringMandatórioToken de acesso
  • PATH PARAMETERS
NomeTipoMandatorio/OpcionalDescrição
processoIdStringMandatórioNumero do processo

Requisição com Sucesso

Se a requisição foi executada com sucesso, a resposta de retorno é um JSON contendo o ID do processo criado com o envio da foto como a seguir:

{
"id": "6ab1771e-dfab-4e47-8316-2452268e5481"
}

Erro na Requisição

Caso ocorra algum erro, a resposta de retorno é um JSON contendo o código e descrição do erro:

{
"Error": {
"code": "40004",
"description": "Descrição do erro"
}
}

Para mais infomações sobre os erros retornados, consulte a lista disponível no artigo Response Errors.

Dúvidas?

Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da Central de Ajuda.