Skip to main content
Sete eventos, na ordem da jornada. Você escolhe quais receber ao cadastrar o endpoint.

O envelope

Todo evento chega na mesma forma. Nenhum dado da pessoa atravessa o webhook.
Campos novos podem aparecer. Não valide com schema que rejeita desconhecidos.

Eventos sem corpo extra

Chegam só com o envelope. Servem para acompanhar o progresso da jornada.
evento
O seu backend chamou POST /public/verifications com sucesso. A pessoa ainda não abriu nada.
evento
A pessoa abriu a verificação e a primeira etapa carregou. O status passa a started.
evento
Uma imagem de documento foi enviada. Frente e verso disparam duas vezes. Não traz resultado: a análise é assíncrona e termina em verification.document_processed.
evento
A análise do documento terminou. Fala só do documento: a verificação ainda não foi decidida.
evento
A prova de vida chegou a um desfecho, aprovada ou recusada.

Eventos com corpo extra

verification.decided

O desfecho da verificação. É o único evento com o veredito no corpo, e o que a maioria das integrações escuta.
review não é recusa. Quando um analista decide no dashboard, este evento dispara de novo com o status final. O seu handler precisa aceitar verification.decided duas vezes para a mesma verificação.

verification.scored

Em implementação. O envelope abaixo é o contrato acordado; a entrega do bloco score ainda não está disponível em produção.
Os dois scores e o resultado de cada regra. Independente de verification.decided: não assuma ordem entre os dois.
MATCHED significa que a regra encontrou um sinal contra a jornada. INSUFFICIENT_DATA não é aprovação: a regra não teve o que avaliar. As catorze regras estão em score.

Próximo passo

Segurança

Confira a assinatura antes de confiar em qualquer um destes corpos.