Consulta cadastral
Consulta de CPF
Dados cadastrais oficiais de uma pessoa física a partir do CPF e da data de nascimento.
/openapi/v3/consultas/cpf/{cpf}/{nascimento}token, timestamp e sign, veja Autenticação.Devolve os dados cadastrais de um CPF de 11 dígitos mais a data de nascimento: nome, situação cadastral e data de nascimento. A fonte upstream valida CPF e data de nascimento como um par; um par divergente e um CPF inexistente devolvem o mesmo código 10016003, propositalmente indistinguíveis (veja Consulta cadastral).
Requisição GET: o corpo assinado é a string vazia e as duas variáveis de caminho fazem parte do caminho assinado. A resposta é um objeto simples, sem envelope da plataforma.
Parâmetros de caminho
cpf* | string | CPF |
nascimento* | string | Data de nascimento |
* Campo obrigatório
ni | string | CPF |
nome | string | Nome completo |
| object | Situação cadastral |
nascimento | string | Data de nascimento |
A fonte upstream responde pela faixa etária do titular e a plataforma repassa o código de status upstream sem alteração. O message das faixas de bloqueio é o texto legal fixado pela fonte (português) e não é traduzido pelo cabeçalho Language; ramifique por code.
Cobrança: 422, 451 e não encontrado / data de nascimento divergente (400 + 10016003) são cobrados por chamada; 428 e indisponibilidade upstream (503) não são cobrados. A plataforma não armazena nada para as faixas de bloqueio. Erros de formato e de dígito verificador são rejeitados localmente e não são cobrados.
Adulto (18 anos ou mais): HTTP 200
Nome, situação cadastral e data de nascimento, como de costume.
{ "ni": "40710536828", "nome": "DANILO HIDEO CORREA", "situacao": { "codigo": "0", "descricao": "REGULAR" }, "nascimento": "09011997" }
16 a 17 anos: HTTP 422
Código 10016005, sem nenhum campo pessoal. Não repita: a idade não muda com a nova tentativa e cada chamada é cobrada.
{ "code": 10016005, "message": "LGPD: menor de idade" }
Menos de 16 anos: HTTP 451
Código 10016004, sem nenhum campo pessoal. Não repita.
{ "code": 10016004, "message": "LGPD: menor de 16 anos (Lei Felca)" }
Idade não verificável: HTTP 428
Código 10016006, sem nenhum campo pessoal. A base upstream não tem a data de nascimento do titular; a plataforma já reverificou uma vez com a data que você informou, dentro da mesma chamada. Um 428 persistente significa que a fonte oficial também não conseguiu verificar; repetir é inútil.
{ "code": 10016006, "message": "LGPD: idade nao verificavel - informe a data de nascimento para completar a verificacao" }
situacao.codigoSituação cadastral do CPF
Quando o código não é 0, cabe a você decidir se o fluxo continua; a plataforma repassa a situação sem julgá-la.
| Valores | Significado |
|---|---|
| 0 | REGULAR: regular |
| 2 | SUSPENSA: suspensa |
| 3 | TITULAR FALECIDO: titular falecido |
| 4 | PENDENTE DE REGULARIZACAO: pendente de regularização |
| 5 | CANCELADA POR MULTIPLICIDADE: cancelada por inscrição duplicada |
| 8 | NULA: nula |
| 9 | CANCELADA DE OFICIO: cancelada de ofício |
| Código | HTTP | |
|---|---|---|
| 10016000 | 400 | Formato de CPF inválido (11 dígitos obrigatórios). Verifique caracteres de formatação indevidos ou comprimento errado. |
| 10016001 | 400 | Dígitos verificadores do CPF inválidos. Valide localmente com o algoritmo mod-11 para evitar chamadas inúteis. |
| 10016002 | 400 | Data de nascimento inválida (DDMMYYYY válido obrigatório). Observe a ordem dia-mês-ano e que a data precisa existir. |
| 10016003 | 400 | CPF não encontrado: o CPF não existe ou o CPF e a data de nascimento não coincidem (propositalmente indistinguíveis). Cobrado por chamada. |
| 10016005 | 422 | LGPD: menor de idade: titular com 16 a 17 anos. Dados legalmente retidos pela fonte upstream, sem campos pessoais; não repita. Cobrado por chamada. |
| 10016004 | 451 | LGPD: menor de 16 anos (Lei Felca): titular com menos de 16 anos. Dados legalmente retidos, sem campos pessoais; não repita. Cobrado por chamada. |
| 10016006 | 428 | LGPD: idade nao verificavel - informe a data de nascimento para completar a verificacao: idade não verificável. A plataforma já reverificou uma vez com a data de nascimento informada; não repita. Não cobrado. |
| 10016020 | 503 | Fonte de dados upstream temporariamente indisponível. Repita com backoff exponencial (inicie em 1 s, dobre até 30 s, adicione jitter); se persistir, contate a plataforma. Não cobrado. |