v1
latestOpenAPI 3.0.12026-07-261451591021.8 KBConsulta resultado CPF
Onboarding PF - Consulta resultado CPF<br/>Permite que os parceiros consultem o status de andamento da consulta iniciada de um CPF.<br/><br/>Requisição<br/><table><thead><tr><th>Campo</th><th>Tipo</th><th>Descrição</th><th>Obrigatoriedade</th></tr></thead><tbody><tr><td>accountUuid</td><td>Texto</td><td>Uuid identificador da abertura de conta.</td><td>Sim</td></tr><tr><td>cpf</td><td>Texto</td><td>Cpf informado na consulta.</td><td>Sim</td></tr></tbody></table><br/><br/>Resposta - Sucesso (200)<br/><table><thead><tr><th>Campo</th><th>Tipo</th><th>Descrição</th></tr></thead><tbody><tr><td>message</td><td>Texto</td><td>Mensagem de confirmação do cadastro</td></tr><tr><td>data.contaUuid</td><td>Texto</td><td>Uuid da conta</td></tr><tr><td>data.nomeCliente</td><td>Texto</td><td>Nome do conta</td></tr><tr><td>data.numeroConta</td><td>Texto</td><td>Numero da conta</td></tr><tr><td>data.statusConta</td><td>Texto</td><td>Status da conta (Processo de Abertura Iniciado, Aguardando Análise KYC, Análise KYC Aprovada, Análise KYC Recusada, Aguardando Análise CAF, Análise CAF Aprovada, Análise CAF Recusada, Aguardando Abertura de Conta, Abertura de Conta Aprovada, Abertura de Conta Recusada)</td></tr><tr><td>data.statusContaEnum</td><td>Texto</td><td>Status ENUM da conta (started, awaiting_kyc_analysis, kyc_analysis_approved, kyc_analysis_refused, awaiting_caf_analysis, caf_analysis_approved, caf_analysis_refused, awaiting_account_opening, account_opening_approved, account_opening_refused)</td></tr><tr><td>data.statusPessoa</td><td>Texto</td><td>Resultado da consulta de pessoa (PROCESSANDO, APROVADO, REPROVADO)</td></tr><tr><td>data.resultadoPessoa</td><td>Texto</td><td>Mensagem da consulta de pessoa</td></tr><tr><td>statusCode</td><td>Inteiro</td><td>Código HTTP da resposta</td></tr><tr><td>status</td><td>Booleano</td><td>Status lógico da operação</td></tr></tbody></table>
Query parameters
UUID da conta a ser consultada
CPF informado na consulta
Headers
Client ID enviado no header
Response
Status consultado com sucesso.
Example response
{
"message": "Status consultado com sucesso.",
"data": {
"contaUuid": "5d1d8c55-fee5-48fb-89da-827ac0a5326b",
"nomeCliente": "Usuário Teste",
"numeroConta": "0540274760",
"statusConta": "Aguardando Abertura de Conta",
"statusContaEnum": "started/awaiting_kyc_analysis/kyc_analysis_approved/kyc_analysis_refused/awaiting_caf_analysis/caf_analysis_approved/caf_analysis_refused/awaiting_account_opening/account_opening_approved/account_opening_refused",
"statusPessoa": "PROCESSANDO/APROVADO/REPROVADO",
"resultadoPessoa": "Cliente aprovado em todas as políticas de crédito e fraude."
},
"statusCode": 200,
"status": true
}