Bureau PF
Este endpoint realiza a busca de dados pessoais da Receita Federal referentes ao CPF informado.
Request
GET/bureau/natural-person/{CPF}Parâmetros
| Parâmetro | Descrição | Obrigatório |
|---|---|---|
| CPF | CPF da pessoa consultada | Sim |
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 | String |
| data.mothersName | Nome da mãe encontrado | String |
| data.birthdate | Data de nascimento encontrada | Number |
| metadata | Objeto com os metadatas da requisição | Object |
| metadata.timeSpent | Tempo da requisição | Number |
Exemplo Request
GET /bureau/natural-person/111.111.111-11
TIP
O CPF pode ser passado com ou sem máscara (111.111.111-11 ou 11111111111) e deve ser passado com os 11 chars, incluindo os zeros à esquerda.
Exemplos JSON
Veja alguns exemplos em JSON da resposta.
- Exemplo quando CPF encontrado
json
{
"id": "13cfec7c-b238-4820-a4d1-5173e4c1418e",
"version": "v2",
"data": {
"name": "JOAO DA SILVA",
"federalRevenueNumber": "12345678990",
"mothersName": "MARIA DA SILVA",
"birthdate": 19990201
},
"metadata": {
"timeSpent": 10000
}
}- Exemplo quando CPF não encontrado
json
{
"id": "13cfec7c-b238-4820-a4d1-5173e4c1418e",
"version": "v2",
"data": {},
"metadata": {
"timeSpent": 10000
}
}