Onboarding PF

Consulta CPF na SERPRO

Onboarding PF - Consulta de CPF na SERPRO<br/>Permite que parceiros consultem um CPF diretamente na SERPRO, informando apenas o CPF e a data de nascimento (não está vinculada a uma abertura de conta). O resultado é retornado de forma síncrona na própria requisição.<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>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 da consulta</td></tr><tr><td>data.nome</td><td>Texto</td><td>Nome da pessoa retornado pela SERPRO</td></tr><tr><td>data.cpf</td><td>Texto</td><td>CPF consultado</td></tr><tr><td>data.tipoDocumento</td><td>Texto</td><td>Tipo do documento (CPF)</td></tr><tr><td>data.statusPessoa</td><td>Texto</td><td>Código da situação cadastral do CPF na SERPRO</td></tr><tr><td>data.descricaoStatus</td><td>Texto</td><td>Descrição da situação cadastral (ex.: Regular)</td></tr><tr><td>data.dataNascimento</td><td>Texto</td><td>Data de nascimento retornada (Y-m-d)</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>

post/api/v1/onboarding-pf/consulta-cpf-serpro

Request

  • Base URL
    https://api-clientes.meuk8.com.br
  • URL
    https://api-clientes.meuk8.com.br/api/v1/onboarding-pf/consulta-cpf-serpro
  • Auth
    HTTP bearer

Headers

client-idstring uuid required
Example:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Client ID enviado no Header

Request body

cpfstring
dataNascimentostring

Example request

{
  "cpf": "12345678900",
  "dataNascimento": "Y-m-d"
}

Response

Consulta realizada com sucesso.

messagestring
errorsstring nullable
statusCodeinteger
statusboolean

Example response

{
  "message": "Consulta de CPF na SERPRO realizada com sucesso.",
  "data": {
    "nome": "João da Silva",
    "cpf": "12345678900",
    "tipoDocumento": "CPF",
    "statusPessoa": "0",
    "descricaoStatus": "Regular",
    "dataNascimento": "1990-05-20"
  },
  "statusCode": 200,
  "status": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.