Webhooks

A Combateafraude.com irá notificar atualizações em uma execução através de webhooks.

Configurando o webhook

Para configurar a URL padrão do webhook de um relatório basta acessar a área do cliente em Menu principal > Produtos.

• Cada relatório possui uma URL de webhook diferente (você pode usar a mesma);
• Este webhook configurado deve esperar uma requisição do tipo POST;
• Uma execução pode receber como atributo opcional uma URL de webhook (returnUrl). Ao utilizar esse parâmetro, a URL padrão não será utilizada. Para mais detalhes, acesse Envio de documentos para análise.

Quando eu receberei uma notificação?

Alteração de status

Quando acontecer uma alteração de status você receberá uma notificação do tipo status_updated.

O status de uma execução é definido com base nas validações configuradas no relatório.

Enviado para documentoscopia

Quando o documento for enviado para documentoscopia você receberá uma notificação do tipo documentscopy_requested. O status da execução continua como PROCESSANDO até que a perícia documental seja concluída.

Exemplo de resposta

{
  "type": "status_updated",
  "report": "xxxxxxxxxxxxxxxxx",
  "uuid": "yyyyyyyyyyyyyyyyy",
  "status": "APROVADO",
  "date": "2019-08-01T18:01:38.413Z"
}

Tabela de descrição da resposta do webhook

Atributo	Tipo	Observação
type	String	Tipo do evento (process_started, status_updated ou documentscopy_requested)
report	String	Identificador do relatório
uuid	String	Identificador da execução
onboardingId	String	Identificador do link de onboarding utilizado na captura dos dados, quando houver
status	String	Status da execução (PROCESSANDO, APROVADO, REPROVADO, PENDENTE ou PENDENTE OCR)
date	String	Data de realização do evento

Tipos

process_started: Notificação enviada somente quando uma execução é originada de um link de onboarding. Significa que os documentos foram capturados e foram enviados para análise.

status_updated: Notificação enviada sempre que uma execução mudar de status.

documentscopy_requested: Notificação enviada quando uma execução for enviada para o processo de documentoscopia (perícia documental).

E se acontecer algum erro no meu webhook?

Caso não consigamos nos comunicar com o seu webhook, iremos realizar até 5 retentativas em um prazo máximo de 5 horas. Durante este intervalo das requisições, podem ocorrer mudanças no status de uma execução. Caso a entrega das notificações ocorra fora da ordem cronólogica, o status pode não ser o mais atualizado. Por isso, recomenda-se considerar o atributo date e consultar sempre a versão mais recente da execução.