Documentação
Base URL https://api.apicpf.dev · autentique e consulte CPF em JSON.
Toda chamada à API é autenticada por uma API Key no formato sk-live_…. Você recebe a chave ao criar a conta e pode regenerá-la no painel.
X-API-KEY: sk-live_sua_chave_aqui
Também aceitamos Authorization: Bearer sk-live_… ou ?token= / ?api_key= na URL.
Nunca exponha a API Key no frontend ou em repositório público. Faça as chamadas no seu servidor.
| Código | Significado |
|---|---|
401 | Header ausente ou API Key inválida |
403 | Conta bloqueada |
Consulta dados cadastrais do CPF. Consome 1 crédito. Resposta média em ~2ms quando há cache.
https://api.apicpf.dev/consulta?cpf=
Consulta CPF via query string (cache local ou provedor).
cpf
string
obrigatório
CPF com ou sem máscara. Ex.: 52998224725 ou 529.982.247-25.
{
"code": 200,
"data": {
"cpf": "52998224725",
"nome": "Maria Aparecida da Silva",
"mae": "Ana da Silva",
"genero": "F",
"data_nascimento": "1988-03-12"
}
}
Checa formato e dígitos verificadores sem debitar crédito. Ideal antes da consulta completa.
https://api.apicpf.dev/v1/validate?cpf=
Validação de dígitos. Também disponível em /validate.
cpf
string
obrigatório
CPF a validar. Aceita máscara.
{
"code": 200,
"valid": true,
"cpf": "52998224725",
"formatted": "529.982.247-25"
}
Atalho REST com o CPF no path. Consome crédito como a consulta padrão.
https://api.apicpf.dev/cpf/{digits}
Substitua {digits} pelo CPF (apenas números ou com máscara).
{
"code": 200,
"data": {
"cpf": "52998224725",
"nome": "Maria Aparecida da Silva"
}
}
Healthcheck público da API. Não exige autenticação.
https://api.apicpf.dev/health
Retorna status do serviço.
{
"code": 200,
"service": "apicpf",
"ok": true
}
Snippets prontos para colar. Troque sk-live_sua_chave_aqui pela sua chave.
curl -X GET 'https://api.apicpf.dev/consulta?cpf=52998224725' \ -H 'X-API-KEY: sk-live_sua_chave_aqui' \ -H 'Accept: application/json'
curl -X GET 'https://api.apicpf.dev/v1/validate?cpf=529.982.247-25'
curl -X GET 'https://api.apicpf.dev/cpf/52998224725' \ -H 'X-API-KEY: sk-live_sua_chave_aqui'
$ch = curl_init('https://api.apicpf.dev/consulta?cpf=52998224725');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'X-API-KEY: sk-live_sua_chave_aqui',
'Accept: application/json',
],
]);
$response = curl_exec($ch);
curl_close($ch);
$json = file_get_contents('https://api.apicpf.dev/v1/validate?cpf=52998224725');
$ch = curl_init('https://api.apicpf.dev/cpf/52998224725');
curl_setopt($ch, CURLOPT_HTTPHEADER, ['X-API-KEY: sk-live_sua_chave_aqui']);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
const res = await fetch('https://api.apicpf.dev/consulta?cpf=52998224725', {
headers: {
'X-API-KEY': 'sk-live_sua_chave_aqui',
'Accept': 'application/json',
},
});
const data = await res.json();
const res = await fetch('https://api.apicpf.dev/v1/validate?cpf=52998224725');
const data = await res.json();
const res = await fetch('https://api.apicpf.dev/cpf/52998224725', {
headers: { 'X-API-KEY': 'sk-live_sua_chave_aqui' },
});
Respostas de erro sempre incluem code e message.
| Código | Significado |
|---|---|
400 | CPF inválido ou mal formatado |
401 | API Key ausente ou inválida |
403 | Conta bloqueada ou IP fora da allowlist |
404 | Rota não encontrada |
429 | Limite de taxa (RPM / diário) |
402 | Sem créditos disponíveis |
500 | Erro interno / banco indisponível |
{
"code": 401,
"message": "API key não fornecida"
}
Gere sua chave no painel e faça o primeiro request em minutos.
Criar conta