Bureau PF

Este endpoint realiza a busca de dados pessoais da Receita Federal referentes ao CPF informado.

Existe uma versão online desta consulta, o Bureau PF Online, que busca o dado na origem no momento da chamada e devolve também a situação cadastral do CPF. Ela é tarifada à parte. A comparação entre as duas está em Qual dos dois usar.

Request

GET /bureau/v2/natural-person/{CPF}

Parâmetros

Parâmetro	Descrição	Obrigatório
CPF	CPF da pessoa consultada	Sim

TIP

O CPF pode ser passado com ou sem máscara (123.456.789-09 ou 12345678909) e deve ser passado com os 11 chars, incluindo os zeros à esquerda.

Um CPF que não passa na validação do dígito verificador devolve 422 antes de qualquer consulta.

Headers

Authorization: ApiKey <sua-chave-de-api>

Exemplo Request

GET /bureau/v2/natural-person/123.456.789-09

curl -i 'https://api.nxcd.app/bureau/v2/natural-person/12345678909' \
  --header 'Authorization: ApiKey SUA_CHAVE_AQUI'

Response

Campo	Descrição	Tipo
id	ID único da requisição	String
version	Versão da API	String
data	Objeto com o resultado da busca	Object
data.name	Nome encontrado	String
data.federalRevenueNumber	CPF encontrado, sem máscara	String
data.mothersName	Nome da mãe encontrado	String
data.birthdate	Data de nascimento encontrada, no formato AAAAMMDD	Number
metadata	Objeto com os metadados da requisição	Object
metadata.timeSpent	Tempo da requisição, em milissegundos	Number

Este endpoint não devolve a situação cadastral

O campo status não faz parte desta resposta. Para obtê-lo, use o Bureau PF Online.

Exemplos JSON

Veja alguns exemplos em JSON da resposta.

1. Exemplo quando CPF encontrado

Status Code: 200

{
  "id": "13cfec7c-b238-4820-a4d1-5173e4c1418e",
  "version": "v2",
  "data": {
    "name": "JOAO DA SILVA",
    "federalRevenueNumber": "12345678909",
    "mothersName": "MARIA DA SILVA",
    "birthdate": 19990201
  },
  "metadata": {
    "timeSpent": 10000
  }
}

2. Exemplo quando CPF não encontrado

Status Code: 200

{
  "id": "13cfec7c-b238-4820-a4d1-5173e4c1418e",
  "version": "v2",
  "data": {},
  "metadata": {
    "timeSpent": 10000
  }
}

3. Exemplo quando o CPF é de menor de idade

Os dados pessoais vêm mascarados: name vira menor de idade, e mothersName e birthdate viram ****. Atenção ao tipo: mascarado, o birthdate vem como texto, não como número.

Status Code: 200

{
  "id": "13cfec7c-b238-4820-a4d1-5173e4c1418e",
  "version": "v2",
  "data": {
    "name": "menor de idade",
    "federalRevenueNumber": "12345678909",
    "mothersName": "****",
    "birthdate": "****"
  },
  "metadata": {
    "timeSpent": 10000
  }
}

Headers de resposta

Header	Quando aparece
Nextid-ReqId	Em todas as respostas. Traz o identificador da requisição, o mesmo do campo id do corpo.

Erros

Código	Quando ocorre
401 Unauthorized	Chave de API ausente, inválida, ou sem a permissão nextid.bureaus.naturalPersonBureau.
404 Not Found	A versão informada na URL não existe. Só v2 é aceita.
422 Unprocessable Entity	CPF que não passa na validação do dígito verificador.
500 Internal Server Error	Falha inesperada durante o processamento.

Exemplo de resposta com CPF inválido:

Status Code: 422

{
  "id": "13cfec7c-b238-4820-a4d1-5173e4c1418e",
  "error": {
    "statusCode": 422,
    "error": "Unprocessable Entity",
    "message": "Invalid Federal Revenue Number"
  }
}

O formato das respostas de erro está descrito em Códigos HTTP das respostas.

Versões

A única versão é a v2, e ela é a que atende quando a versão é omitida na URL. /bureau/natural-person/{CPF} e /bureau/v2/natural-person/{CPF} são equivalentes.

Versão	Situação	O que muda
v2	Recomendada	Única versão. É o que responde quando a versão é omitida na URL.

Qualquer outro valor no lugar de v2 devolve 404 com a mensagem API version not found.

Endpoint relacionado

Para os endereços conhecidos deste CPF, veja Endereços da PF.