Pular para o conteúdo principal
GET
curl
Cada tentativa é registrada, incluindo as novas tentativas automáticas que a Didit faz após uma resposta 5xx ou 404. Assim, uma entrega com falha seguida de uma nova tentativa bem-sucedida aparece como duas entradas com o mesmo event_id dentro de request_body. Para inspecionar uma entrega, use Obter entrega de webhook da sessão. Para reenviá-la depois de corrigir o seu endpoint, use Reenviar entrega de webhook da sessão.

Autorizações

​
x-api-key
string
header
obrigatório

Chave de API da sua aplicação, em Developers -> API keys no Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter escopo restrito: nenhum acesso, leitura ou escrita por recurso, limitada a alguns fluxos ou a sessões aprovadas, a uma lista de endereços IP e a uma data de validade. 401 significa que a chave está errada, revogada ou expirada; 403 significa que nenhuma chave foi enviada, que a chave não tem acesso a este recurso ou ação, ou que a requisição veio de um endereço fora da sua lista de IPs; 404 em uma rota de sessão significa que a sessão está fora dos fluxos ou status da chave. Uma chave sem acesso a mídia recebe URLs de imagem, vídeo e PDF como null, e uma chave sem permissão de escrita em sessões recebe links e tokens de sessão como null. Consulte https://docs.didit.me/console/api-keys.

Parâmetros de caminho

​
sessionId
string<uuid>
obrigatório

UUID da sessão de verificação, de usuário (KYC) ou de empresa (KYB): o session_id retornado por POST /v3/session/. O servidor o resolve entre os dois tipos de sessão.

Deve ser um UUID válido. A rota só corresponde a UUIDs bem formados, então um valor malformado é rejeitado pelo roteador de URLs antes que qualquer código da aplicação seja executado, e a resposta é uma página HTML 404 em vez do envelope JSON {"detail": ...} mostrado abaixo.

Resposta

Todas as entregas registradas para a sessão, da mais recente para a mais antiga.

​
uuid
string<uuid>
obrigatório

ID da entrega. Use-o como {webhook_uuid} para obter ou reenviar esta entrega.

​
session_id
string<uuid>
obrigatório

A sessão à qual a entrega pertence (a sessão no caminho).

​
request_url
string<uri> | null
obrigatório

URL para a qual a entrega foi enviada.

​
response_status
integer | null
obrigatório

Status HTTP que seu endpoint retornou. null enquanto a entrega está na fila e ainda não foi tentada. Quando nenhuma resposta HTTP é recebida, a Didit registra um status próprio: 504 quando seu endpoint não respondeu em 5 segundos, 503 para falha de conexão, 400 quando a URL foi recusada como insegura (por exemplo, um endereço privado ou interno) e 404 para qualquer outro erro de requisição. 400 ou acima conta como entrega com falha.

​
status
string | null
obrigatório

Status da sessão quando o evento foi gerado, por exemplo In Progress, Approved ou Declined.

​
webhook_type
enum<string>
obrigatório

Nome de evento de webhook compatível. Use exatamente estas strings em subscribed_events; valores não compatíveis são rejeitados.

Opções disponíveis:
status.updated,
data.updated,
user.status.updated,
user.data.updated,
business.status.updated,
business.data.updated,
activity.created,
transaction.created,
transaction.status.updated,
travel_rule.status.updated,
workflow.compliance_changed,
transaction_rule_suggestions.created,
auth.signup,
auth.login,
auth.login_failed,
auth.password_reset_requested,
auth.password_reset_completed,
auth.mfa_changed,
auth.new_device,
auth.account_locked,
investigator.report.ready,
investigator.decision.automated,
investigator.decision.overridden,
investigator.decision.contested,
investigator.question.raised,
investigator.automation.paused,
investigator.rfi.answered,
investigator.rfi.overdue,
investigator.drift.detected,
investigator.sla.breached,
investigator.qa.failed,
investigator.external.report.ready
​
request_header
string
obrigatório

Texto JSON (uma string) dos cabeçalhos da requisição que a Didit enviou: Content-Type, X-Signature, X-Signature-V2, X-Signature-Simple, X-Timestamp e User-Agent. Analise-o com um parser JSON. Ele contém assinaturas, nunca o segredo de assinatura.

​
request_body
string
obrigatório

Texto JSON (uma string) do payload exato que a Didit enviou, com as chaves ordenadas, incluindo event_id e timestamp. Analise-o com um parser JSON; consulte Formato do payload. Para uma chave com escopo sem media: read, as URLs de mídia dentro dele são null; sem sessions: write, os tokens de sessão e os links de verificação hospedados são null. Um corpo alterado dessa forma não corresponde mais às suas assinaturas. A Didit não registra o corpo da resposta que o seu endpoint retornou.

​
created_at
string<date-time>
obrigatório

Quando a entrega foi criada.

Última modificação em 1 de novembro de 2026