Skip to main content
Consulta de CPF é o conferente de identidade no cadastro: antes de liberar benefício, crédito ou acesso, você confere se o CPF e a data de nascimento são válidos — e, no modo completo, se o par existe na base de dados oficial do governo, acessada por parceria da plataforma. Use no painel em Add-ons → Consulta de CPF ou integre no fluxo de onboarding.

​
O que é?

É um add-on que responde: este CPF e esta data de nascimento são válidos? No modo completo, também responde: o par existe na base oficial e quais dados cadastrais estão disponíveis? Você envia CPF + data de nascimento — os dois são obrigatórios em ambos os modos. Diferente de validar e-mail ou telefone, aqui o foco é identidade fiscal brasileira em cadastros, KYC leve e higienização de bases com documento.

​
Por que usar?

​
Dois modos de consulta

A consulta completa acessa dados cadastrais oficiais por meio de parceria da plataforma com fontes autorizadas — você não precisa contratar integração própria. Valores em GET /v1/pricing ou na API de preços.
Use rápida para filtrar formato inválido em listas grandes ou no primeiro passo do cadastro. Use completa quando a aprovação depende de confirmar o CPF na base oficial (KYC, crédito, benefícios).

​
Formatos de data de nascimento

Na API e no painel, aceitamos:

​
Painel vs API

No painel: uma linha por consulta, no formato CPF,data — por exemplo 12345678909,1990-01-01 ou 123.456.789-09,01/01/1990. Escolha Rápida ou Completa antes de consultar. Envie "mode": "quick" ou "mode": "full" no body da API (padrão: quick).

​
O que significa cada status

​
Modo rápida

​
Modo completa

Cada item traz resultCode (1 a 8) para automação:

​
Campos no modo completa (found)

No modo rápida, nome e situação cadastral vêm null — só status, resultCode e creditsCharged importam. Em minorBlocked, apenas status, resultCode e reason são retornados — sem nome nem situação (LGPD).

​
Escopo da API Key

Rotas de CPF exigem validations:cpf — separado de validations:email, validations:phone e dos canais de envio.

​
Próximos passos