Skip to main content
Webhook é o caminho recomendado para produção. O fluxo é simples:

Passo 1: Configure o endpoint (uma vez)

No dashboard kycert, vá em Integrações & API → Webhooks e cadastre o URL HTTPS do seu servidor. O kycert enviará todos os resultados para esse endpoint. Alternativamente, passe webhook_url no corpo de cada POST /runs para sobrescrever o endpoint por requisição.
Se você tiver um endpoint permanente configurado no dashboard e passar webhook_url na requisição, o kycert usará a URL do override mas assinará com o segredo do endpoint permanente. Evite misturar as duas abordagens — prefira o endpoint permanente em produção e omita webhook_url completamente nas chamadas da API.

Passo 2: Criar o run

Resposta:

Passo 3–4: kycert processa e entrega o resultado

O kycert consulta as fontes em paralelo e entrega o resultado no seu endpoint quando pronto. Você não precisa fazer nada neste passo.

Passo 5: Receber e verificar o webhook

Sempre verifique a assinatura. Qualquer pessoa na internet pode fazer POST para o seu endpoint — a verificação garante que o evento veio realmente do kycert.

Passo 6: Agir com base na decision

Payload completo do webhook

Ver referência completa de campos → — descrição semântica de cada campo do envelope e do objeto data, incluindo todos os valores possíveis de status, decision e checks_summary.

Boas práticas

  • Responda 200 imediatamente e processe de forma assíncrona — seu endpoint tem 30 segundos antes do kycert considerar falha
  • Seja idempotente — o mesmo evento pode ser entregue mais de uma vez em caso de retry
  • Registre o id do evento para deduplicação
  • Retorne sempre 2xx — o kycert retenta em qualquer non-2xx (incluindo 4xx e 5xx). Se o processamento falhar internamente, responda 200 e trate o erro de forma assíncrona para não consumir as 3 tentativas desnecessariamente
Consulte a política completa de retry em Webhooks → Overview.