Por que testar com cURL ou Postman primeiro
Antes de integrar uma API de consulta CPF em PHP, Python ou Node.js, é útil validar URL, chave de autenticação e estrutura JSON em uma ferramenta de HTTP. cURL mostra exatamente o request enviado; Postman ajuda a organizar ambientes, coleções e exemplos. Em ambos, evite compartilhar dados pessoais reais e credenciais.
A URL documentada é https://api.apicpf.dev/consulta?cpf=, com chave em X-API-KEY. Consulte o contrato completo em Docs.
Consultar CPF com cURL
Configure a chave em variável de ambiente e faça uma requisição GET. O CPF abaixo aparece nos exemplos públicos da documentação.
curl --request GET \
'https://api.apicpf.dev/consulta?cpf=52998224725' \
--header "X-API-KEY: $APICPF_KEY" \
--header 'Accept: application/json' \
--connect-timeout 3 --max-time 10
Em Windows PowerShell, a referência à variável de ambiente normalmente é $env:APICPF_KEY em vez de $APICPF_KEY. Evite salvar a chave em arquivos .sh compartilhados; scripts com valor literal podem acabar em repositórios e capturas de tela.
Configurar a requisição no Postman
- Crie uma requisição GET com a URL
https://api.apicpf.dev/consulta. - Em Params, adicione
cpfe um valor de demonstração válido. - Em Headers, adicione
X-API-KEYcom referência a uma variável de ambiente privada. - Adicione
Accept: application/json. - Envie o request e confira o status HTTP e o objeto
data.
Não exporte coleções com chaves preenchidas nem compartilhe capturas de resultados que contenham CPF e nome. Trate os exemplos como testes técnicos, não como autorização de acesso a dados de terceiros.
Como deve vir a resposta
No sucesso documentado, code é 200 e data possui campos como cpf, nome, mae, genero e data_nascimento. Se você receber 401, confira header e chave; com 402, verifique créditos; com 429, diminua a taxa. Leia o guia completo de erros HTTP.
Teste também a validação sem consumir crédito
A API oferece /v1/validate?cpf= para verificar dígitos e formato. Isso permite separar a etapa matemática da consulta de dados. Um CPF válido por dígitos não significa identificação confirmada.
Perguntas frequentes
Devo enviar a chave pela URL?
Prefira X-API-KEY no header. Tokens em URLs podem ser capturados em logs e ferramentas de monitoramento.
Posso testar o endpoint no navegador?
Evite chamadas de consulta no browser com sua credencial. Use cURL, Postman privado ou seu backend.
