Resultado de KYC Disponível

Webhook disparado quando o resultado da análise de KYC de uma operação de crédito é concluído.

Categoria: KYC
Evento: Resultado de KYC Disponível

Nome do Evento

KYC_REQUESTED

Disparado quando a análise de KYC solicitada via POST /credit-operations/{externalContractId}/kyc é concluída pelo provedor (aprovada, reprovada ou com falha técnica). É o complemento assíncrono à consulta GET /credit-operations/{externalContractId}/kyc — evita a necessidade de polling.

Estrutura do Payload

Diferente dos demais eventos, o data deste evento tem o formato de KycResult, não de CreditOperation:

{
  "eventType": "string",
  "entityId": "uuid",
  "occurredAt": "date-time",
  "data": {
    "externalContractId": "string",
    "status": "PENDING | IN_PROGRESS | APPROVED | REJECTED | FAILED",
    "requestedAt": "date-time",
    "completedAt": "date-time | null",
    "rejectionReason": "string | null"
  }
}

Tabela de Descrição dos Campos

CampoTipoDescrição
eventTypestringSempre "KYC_REQUESTED".
entityIduuidID interno da operação de crédito associada ao KYC.
occurredAtdatetimeMomento em que o status do KYC mudou (UTC).
data.externalContractIdstringIdentificador do contrato no sistema do parceiro.
data.statusenumStatus da análise no momento do evento — veja KYC.
data.requestedAtdatetimeQuando a análise foi solicitada.
data.completedAtdatetime ou nullQuando a análise foi concluída. Nulo enquanto em andamento.
data.rejectionReasonstring ou nullMotivo da reprovação, preenchido apenas quando status é REJECTED.

Exemplo de Payload

Exemplo ilustrativo — construído a partir do schema KycResult, não extraído literalmente do OpenAPI. Validar com o time antes de publicar — em especial se este evento dispara uma vez por mudança de status do KYC ou apenas na conclusão final.

{
  "eventType": "KYC_REQUESTED",
  "entityId": "8f14e45f-ceea-467e-95b7-1c9f4e6d4a6b",
  "occurredAt": "2026-08-06T13:30:00Z",
  "data": {
    "externalContractId": "ctr-98421",
    "status": "APPROVED",
    "requestedAt": "2026-08-06T13:05:00Z",
    "completedAt": "2026-08-06T13:30:00Z",
    "rejectionReason": null
  }
}

Did this page help you?