Webhooks em termos simples, são a forma como todas as decisões e eventos são comunicados pela Veriff.
Embora mais esteja por vir no futuro, atualmente temos 4 tipos diferentes de webhooks, e eles são:
Webhook de evento - onde publicamos eventos durante o ciclo de vida de uma verificação
Webhook de decisão - onde publicamos decisões sobre verificações
Webhook de triagem de lista de observação - onde publicamos eventos relacionados aos resultados iniciais e monitorados das verificações de PPE, sanções e mídia adversa.
Webhook de Registro de Transporte (se aplicável) - onde enviamos o resultado da resposta do registro da carteira de habilitação (válido, inválido, não suportado, inconclusivo)
Para o webhook de PPE e Sanções, é importante notar que é enviado quando as verificações de PPE e Sanção foram realizadas. Esse webhook é enviado independentemente dos Webhooks de Evento e Decisão descritos acima. Para detalhes do payload, por favor, consulte nossa documentação do webhook de triagem de lista de observação.
Configurar Webhooks
Quer entender como configurar webhooks e receber atualizações de verificação em tempo real?
💡 Assista a este vídeo para aprender como:
✅ Configure Webhooks. Configure o Veriff para enviar automaticamente respostas de eventos e decisões para seu sistema.
✅ Personalize notificações. Escolha entre webhooks de eventos, decisões e PPE & sanções para se manter informado.
✅ Otimize seu fluxo de trabalho. Envie atualizações em tempo real para sua equipe ou integre diretamente à sua plataforma.
Este vídeo o guia pelo processo de configuração de webhooks no Veriff Station.
🎥 Assista agora e comece a automatizar seu processo de verificação!
Quando os Webhooks são acionados?
Se o status de uma sessão de verificação mudar, um webhook de evento será enviado. Quando a decisão final é feita, um webhook de decisão com todos os dados relacionados é enviado para você. Alguns serviços, como PEP e Sanções possuem um webhook separado.
Os webhooks também podem ser visualizados na área administrativa na visualização da sessão de verificação. De lá, se necessário, todos os webhooks também podem ser reenviados.
Você pode receber uma decisão específica com um webhook de decisão ao testar nossos serviços (na Integração de Teste). Para o teste, basta inserir a decisão que você deseja receber juntamente com o webhook de decisão ao lado do campo "Nome" no payload ao criar uma sessão. Você pode inserir "Aprovado", "Reenvio" ou "Recusa" dependendo da decisão que você deseja obter.
Códigos de Webhook
O código do webhook de evento pode ser um dos seguintes:
7001 - Iniciado: a sessão de verificação foi acessada pelo cliente mas ainda não foi submetida para revisão.
7002 - Submetido: a sessão de verificação foi submetida à Veriff e estamos no processo de verificar o cliente
O código do webhook de decisão pode ser um dos seguintes:
9001 - Positivo: o cliente foi verificado, o processo foi concluído corretamente e a decisão é "Aprovado".
9102 - Negativo: o cliente não foi verificado, o processo foi concluído, mas a verificação é "Recusada".
9103 - Reenviado: o cliente foi solicitado a fazer um reenvio, pois algo estava faltando e a Veriff não pôde fornecer uma decisão conclusiva.
9104 - Negativo: a sessão de verificação expirou. Se o cliente acessou a sessão de verificação mas não concluiu o processo, o status será "Abandonado". Caso o cliente nunca tenha chegado ao nosso ambiente, o status será "Expirado".
Os dados de Comprovante de endereço são sempre fornecidos dentro do webhook de decisão.
Reenviando Webhooks
Quando não recebemos uma resposta bem-sucedida do backend do cliente. Esse é tipicamente o comportamento de webhook não entregue. → Nesses casos, reenviamos o webhook com falha por até uma semana. O reenvio automático é interrompido assim que há uma resposta bem-sucedida.
Você pode ler mais sobre webhooks em nossa documentação da API.
Recomendamos fortemente que você use SSL para pontos finais de webhook no ambiente de produção, pois dados sensíveis estão sendo transmitidos.