Documentação da API
Integre nossa API de consulta de CPF de forma simples e rápida. Abaixo você encontrará todos os detalhes necessários para começar.
Autenticação
Nossa API utiliza chaves de API para autenticar as requisições. A chave deve ser fornecida diretamente na URL como parte do caminho (path).
API Key na URLObrigatório
Exemplo: https://api.smartcpf.com.br/b980db7b-d8dc-477f-a76b-63c45653a91d/...
API Endpoint
O ponto de acesso principal para consultas de CPF é:
GET
https://api.smartcpf.com.br/{api_key}/{search_code}/{cpf}Parâmetros e Cabeçalhos
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| api_key | Path | Sim | Sua chave de API (UUID) |
| search_code | Path | Sim | Código da pesquisa: 0 (A), 1 (B) ou 2 (C) |
| cpf | Path | Sim | Número do CPF (apenas números) |
Dica
O código da pesquisa deve ser especificado como: 0 para Pesquisa A, 1 para Pesquisa B, ou 2 para Pesquisa C.
Campos por Tipo de Consulta
Tipo A
Consulta Básica
- Nome Completo
Tipo B
Intermediária
- Nome Completo
- Data de Nascimento
Tipo C
Completa
- Nome Completo
- Data de Nascimento
- Nome da Mãe
- Gênero
Exemplo de Requisição
cURL
curl --location 'https://api.smartcpf.com.br/b980db7b-d8dc-477f-a76b-63c45653a91d/2/45474101007'JavaScript (Fetch)
fetch('https://api.smartcpf.com.br/b980db7b-d8dc-477f-a76b-63c45653a91d/2/45474101007')
.then(response => response.json())
.then(data => console.log(data));