Pular para o conteúdo principal

Recursos de Webhook

Esta seção descreve os comportamentos específicos do recebimento de respostas via Webhook (Assíncrono).

Para consultar o formato JSON detalhado das respostas (que é o mesmo para chamadas síncronas e assíncronas), visite a página:

Documentação das Estruturas de Resposta

👉 Estruturas de Resposta da API

Fluxo de Recebimento​

Requisito de Resposta

Após receber os dados, seu endpoint deve retornar HTTP 200 imediatamente para confirmar o recebimento. Caso contrário, o SantoID considerará falha na entrega e iniciará o processo de retentativa.

Documentação Detalhada por Tipo​

Abaixo estão os links rápidos para os detalhes dos objetos que compõem a resposta padrão.

Estrutura Completa do Labels

Melhores Práticas
  1. Implemente validação de requestId para evitar processamento duplicado.
  2. Armazene executionDatetime considerando o fuso horário UTC.
  3. Para Workflow, sempre verifique rejectedReasons mesmo em caso de sucesso.
  4. Para FaceMatch, considere limiares (thresholds) personalizados para match.