Skip to content

Consultar informações de pessoas físicas

Request

Busca informações detalhadas de pessoa física por CPF.

Formato da resposta: a API sempre devolve uma lista de objetos (normalmente com um único item), nunca um objeto único. Acesse o primeiro elemento antes de ler os campos.

Cobrança e carência de 24 horas: cada consulta com retorno debita 1 crédito, exceto quando o mesmo CPF já foi consultado pela sua empresa nas últimas 24 horas — nesse caso a resposta vem completa, sem novo débito. A carência é por documento e vale para a conta inteira: consultas feitas por chaves de API diferentes da mesma empresa compartilham a mesma janela. Consulta sem retorno não gera cobrança nem inicia a carência, e o documento com ou sem pontuação conta como o mesmo CPF.

Campo ip: o primeiro item da lista recebe um campo extra ip, com o IP de origem registrado na operação. É um dado de auditoria da operação, não da pessoa, e não aparece nos demais itens. Numa consulta isenta pela carência, o valor é o IP da operação que gerou a cobrança original.

Security
ApiKeyAuth
Query
cpfstring^\d{11}$required

CPF da pessoa (apenas números). Envie sempre o documento completo, com os zeros à esquerda; a API normaliza a entrada para dígitos. O CPF devolvido na resposta deve ser tratado como string.

Example:cpf=12345678901
fieldsstring

Campos específicos a retornar (separados por vírgula)

Example:fields=name,cpf,emails,addresses
curl -i -X GET \
  'https://docs.datastone.com.br/_mock/api/persons/?cpf=12345678901&fields=name%2Ccpf%2Cemails%2Caddresses' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Informações da pessoa retornadas com sucesso

Bodyapplication/json
Array [
cpfstring
Example:"11111111111"
namestring
Example:"FULANO DE TAL EXEMPLO"
mother_namestring
Example:"MARIA EXEMPLO"
birthdaystring, (date)
Example:"1993-01-01"
agestring
Example:"30"
genderstring
Enum:"M""F"
Example:"M"
signstring
Example:"Capricórnio"
registry_situationstring
Example:"REGULAR"
pepboolean
Example:false
pep_typestring
Example:""
possibly_deadboolean
Example:false
retiredboolean
Example:false
bolsa_familiaboolean
Example:false
estimated_incomestring
Example:"ATÉ R$ 1.000,00"
cbo_codestring
Example:"999999"
cbo_descriptionstring
Example:"EMPRESÁRIO"
rgstring or null
addressesArray of objects
emailsArray of objects
mobile_phonesArray of objects
land_linesArray of objects
family_personsArray of objects
related_companiesArray of objects
employerArray of objects
ipstring
Example:"127.0.0.1"
planstring
Example:"Consulta Premium"
]
Response
[
  {
    "cpf": "11111111111",
    "name": "FULANO DE TAL EXEMPLO",
    "mother_name": "MARIA EXEMPLO",
    "birthday": "1993-01-01",
    "age": "30",
    "gender": "M",
    "sign": "Capricórnio",
    "registry_situation": "REGULAR",
    "pep": false,
    "pep_type": "",
    "possibly_dead": false,
    "retired": false,
    "bolsa_familia": false,
    "estimated_income": "ATÉ R$ 1.000,00",
    "cbo_code": "999999",
    "cbo_description": "EMPRESÁRIO",
    "rg": "string",
    "addresses": [ … ],
    "emails": [ … ],
    "mobile_phones": [ … ],
    "land_lines": [ … ],
    "family_persons": [ … ],
    "related_companies": [ … ],
    "employer": [ … ],
    "ip": "127.0.0.1",
    "plan": "Consulta Premium"
  }
]