Consultar status do KYC da subconta
GET
/api/subaccounts/{{subaccount_id}}/kyc
Autenticação
subaccounts:read e a conta precisa da flag white-label habilitada. Sem a flag, a rota responde 404 (invisível).Consultar status do KYC da subconta
subaccounts:readkycStatus macro, a submissão atual (current) e o histórico (history) de submissões anteriores, em ordem decrescente de criação.Privacidade: a resposta não expõe URLs nem chaves dos documentos enviados — apenas o status. Os arquivos ficam em storage privado, acessíveis somente ao operador Dotfy.
Resposta
200 OK com:| Campo | Tipo | Descrição |
|---|---|---|
kycStatus | string | Estado macro da subconta: PENDING / IN_REVIEW / APPROVED / REJECTED / PRE_APPROVED. |
current | object|null | Submissão mais recente, ou null se nunca houve envio. |
current.id | string | ID da submissão. |
current.status | string | Status da submissão: RECEIVED / IN_REVIEW / APPROVED / REJECTED. |
current.rejectionReason | string|null | Motivo da recusa (quando REJECTED). |
current.createdAt | string (ISO) | Data de envio. |
current.reviewedAt | string|null (ISO) | Data da análise (quando concluída). |
history | array | Submissões anteriores (mesma forma de current). |
Códigos de erro
| HTTP | Quando |
|---|---|
401 | Sem header Authorization ou chave inválida/revogada. |
403 | Chave sem o escopo subaccounts:read (insufficient_scope). |
404 | Flag white-label desabilitada, subconta inexistente ou não pertence ao master. |
Exemplo cURL
Requisição
Parâmetros Header
Respostas
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --globoff '/api/subaccounts/{{subaccount_id}}/kyc' \
--header 'Authorization: Bearer <token>'Response Response Example
200 - Sucesso (200) — em análise
{
"kycStatus": "IN_REVIEW",
"current": {
"id": "clkycsub0002",
"status": "RECEIVED",
"rejectionReason": null,
"createdAt": "2026-06-13T14:20:00.000Z",
"reviewedAt": null
},
"history": [
{
"id": "clkycsub0001",
"status": "REJECTED",
"rejectionReason": "Selfie ilegível — reenvie com melhor iluminação.",
"createdAt": "2026-06-10T09:05:00.000Z",
"reviewedAt": "2026-06-11T16:30:00.000Z"
}
]
}Modificado em 2026-07-02 06:57:27