Autenticação
Todas as requisições à API do CPFHub.io precisam ser autenticadas com uma API Key enviada no header x-api-key.
Obtendo sua API Key
- Acesse app.cpfhub.io e crie uma conta gratuita.
- No dashboard, vá em Configurações → API Keys.
- Clique em Nova API Key, dê um nome e salve.
- Copie a chave gerada - ela não será exibida novamente.
⚠
Guarde sua chave com segurança
Nunca exponha sua API Key em código client-side, repositórios públicos ou logs. Use variáveis de ambiente.
Enviando a API Key
Inclua o header x-api-key em todas as requisições:
bash
curl -X GET "https://api.cpfhub.io/cpf/12345678909" \
-H "x-api-key: cpfh_sua_api_key_aqui"URL base
Todas as requisições devem usar HTTPS:
https://api.cpfhub.ioRequisições via HTTP são redirecionadas para HTTPS automaticamente.
Autenticação com SDKs
Se você estiver usando um SDK oficial, passe a chave no construtor. O SDK cuida dos headers automaticamente:
TypeScript
import { CPFHub } from '@cpfhub/sdk'
const client = new CPFHub({
apiKey: process.env.CPFHUB_API_KEY,
})Python
from cpfhub import CPFHub
client = CPFHub(api_key=os.environ["CPFHUB_API_KEY"])Erros de autenticação
| Código | Significado |
|---|---|
401 | API Key ausente ou inválida |
403 | API Key suspensa ou sem permissão |
Para detalhes completos sobre todos os erros, veja Códigos de Erro.
Atualizado em 12 de maio de 2026