Consulta CPF

Onboarding PF - Consulta de CPF
Permite que parceiros iniciem uma consulta de cpf.

Requisição

CampoTipoDescriçãoObrigatoriedade
cpfTextoCPF do cliente (com ou sem máscara).Sim
accountUuidTextoUuid da conta.Sim
dataNascimentoDateData de nascimento do cpf informado (Y-m-d).Sim


Resposta - Sucesso (200)
CampoTipoDescrição
messageTextoMensagem de confirmação do cadastro
data.contaUuidTextoUuid da conta
data.nomeClienteTextoNome do conta
data.numeroContaTextoNumero da conta
data.statusContaTextoStatus da conta
data.statusContaEnumTextoStatus ENUM da conta
statusCodeInteiroCódigo HTTP da resposta
statusBooleanoStatus lógico da operação

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
length ≤ 14
string
string
Headers
uuid
required

Client ID enviado no Header

Responses

401

Invalid client data.

403

Invalid token.

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json