v1
latestOpenAPI 3.0.12026-07-261451591021.8 KBConsulta CPF
Onboarding PF - Consulta de CPF<br/>Permite que parceiros iniciem uma consulta de 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>cpf</td><td>Texto</td><td>CPF do cliente (com ou sem máscara).</td><td>Sim</td></tr><tr><td>accountUuid</td><td>Texto</td><td>Uuid da conta.</td><td>Sim</td></tr><tr><td>dataNascimento</td><td>Date</td><td>Data de nascimento do cpf informado (Y-m-d).</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</td></tr><tr><td>data.statusContaEnum</td><td>Texto</td><td>Status ENUM da conta</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>
Headers
Client ID enviado no Header
Request body
Example request
{
"cpf": "12345678900",
"accountUuid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"dataNascimento": "Y-m-d"
}Response
Dados recebidos com sucesso.
Example response
{
"message": "Consulta de pessoa iniciada com sucesso.",
"data": {
"contaUuid": "8df1498b-c443-4573-9bd1-87fbf7215671",
"nomeCliente": "João da Silva",
"statusConta": "Aguardando análise KYC",
"statusContaEnum": "awaiting_kyc_analysis"
},
"statusCode": 200,
"status": true
}