KYC
Como solicitar e acompanhar a análise de KYC de uma operação de crédito.
Quando disparar
Diferente do onboarding totalmente automático de outras soluções de crédito da Geru, na LaaS o KYC (Know Your Customer) é uma ação explícita do parceiro: ele decide o momento de disparar a análise dentro do seu próprio fluxo de originação.
Solicitando o KYC
POST /credit-operations/{externalContractId}/kycRegras importantes:
- É executado uma única vez por operação — uma segunda chamada para a mesma operação não reinicia a análise.
- É bloqueado se a operação já estiver em um status terminal (
DISBURSED,REJECTED,CANCELLED).
Consultando o resultado
GET /credit-operations/{externalContractId}/kycRetorna 404 Not Found se o KYC nunca foi solicitado para essa operação.
Resposta (KycResult):
| Campo | Tipo | Descrição |
|---|---|---|
externalContractId | string | Identificador do contrato no sistema do parceiro. |
status | enum | Status atual da análise — veja tabela abaixo. |
requestedAt | datetime | Timestamp de quando a análise foi solicitada (UTC). |
completedAt | datetime ou null | Timestamp de conclusão da análise. Nulo enquanto em andamento. |
rejectionReason | string ou null | Motivo da reprovação, preenchido apenas quando status é REJECTED. |
Status (KycStatus)
KycStatus)| Status | Significado |
|---|---|
PENDING | Solicitado, aguardando processamento. |
IN_PROGRESS | Em análise pelo provedor de KYC. |
APPROVED | Aprovado. |
REJECTED | Reprovado — verifique rejectionReason. |
FAILED | Falha técnica no processamento (diferente de reprovação). |
Acompanhando via webhook
Em vez de fazer polling em GET .../kyc, assine o evento KYC_REQUESTED para ser notificado assim que o resultado estiver disponível.
Updated 19 days ago
Did this page help you?