Webhooks

Receba notificações automáticas e redundância de status.

O Webhook é o mecanismo primário de confirmação de status. Mesmo que a conexão caia durante o envio do documento, o Webhook garante que o resultado da análise (Aprovado/Rejeitado) chegue ao seu sistema.

Lógica de Aprovação via Webhook

O seu sistema considerará a conta Verificada automaticamente se receber um evento com uma das seguintes condições:

  • O campo status for igual a "approved".
  • OU o campo data.face_match.match for igual a true.

Payload do Evento

Exemplo do JSON enviado para sua URL de callback:

{
  "event": "verification.completed",
  "verification_id": 150,
  "user_reference": "1203",  // O ID do usuário enviado na Query String
  "status": "approved",      // Status principal
  "data": {
    "face_match": {
      "match": true,         // Indicador de biometria facial
      "distance": 0.42,      // Nível de similaridade
      "approved": true
    },
    "document_data": {
       "nome": "GABRIEL DOS REIS DA SILVA",
       "cpf": "000.000.000-00",
       "data_nascimento": "04/05/2005"
    },
    "ocr_result": {
       // Dados brutos do OCR...
    }
  },
  "timestamp": "2025-12-08T10:30:00Z"
}

Identificação do Usuário

O campo user_reference é crucial. Ele retorna o valor passado na URL de envio (?user_reference=ID), permitindo que seu sistema identifique exatamente qual usuário deve ser aprovado, mesmo que a sessão do navegador tenha expirado.