Como consultar CPF via API usando Postman e cURL

Introdução

A consulta de CPF via API é um processo essencial para empresas que precisam validar identidades de forma rápida e segura. Ferramentas como Postman e cURL são ótimas para testar e integrar APIs antes de implementá-las em produção.

Neste guia, mostramos como consultar um CPF via API usando essas duas ferramentas, com exemplos práticos e explicações detalhadas.

1. O que é o Postman e o cURL?

Postman

O Postman é uma plataforma popular para desenvolvimento e testes de APIs. Ele permite enviar requisições HTTP, visualizar respostas e depurar problemas com facilidade.

✅ Vantagens:

• Interface gráfica intuitiva.

• Suporte a diferentes métodos HTTP (GET, POST, PUT, DELETE, etc.).

• Permite salvar e compartilhar coleções de requisições.

cURL

O cURL é uma ferramenta de linha de comando que permite fazer requisições HTTP diretamente do terminal.

✅ Vantagens:

• Simples e rápido para testar APIs.

• Funciona em qualquer sistema operacional.

• Facilmente integrável com scripts automatizados.

2. Configuração inicial da API

Antes de realizar consultas, é necessário:

1. Obter uma chave de API (API Key) no provedor da API.

2. Configurar os headers corretamente.

3. Montar a requisição no formato JSON.

3. Como consultar um CPF via API no Postman

Passo 1: Criar uma nova requisição

1. Abra o Postman.

2. Clique em New Request.

3. Selecione o método POST.

4. No campo URL, insira:
   

   https://api.cpfhub.io/api/cpf

Passo 2: Adicionar os headers

Vá até a aba Headers e adicione:

Content-Type

application/json

x-api-key

SUA_CHAVE_DE_API

Passo 3: Enviar os dados no corpo da requisição

Vá até a aba Body, selecione raw e insira:

{
  "cpf": "123.456.789-00",
  "birthDate": "15/06/1990"
}

Passo 4: Enviar a requisição

Clique em Send e verifique a resposta retornada pela API.

4. Como consultar um CPF via API usando cURL

Se preferir usar a linha de comando, execute o seguinte comando cURL:

curl -X POST "https://api.cpfhub.io/api/cpf" \
     -H "Content-Type: application/json" \
     -H "x-api-key: SUA_CHAVE_DE_API" \
     -d '{
           "cpf": "123.456.789-00",
           "birthDate": "15/06/1990"
         }'

Se a API estiver configurada corretamente, você receberá uma resposta como esta:

{
  "success": true,
  "data": {
    "name": "João da Silva",
    "status": "Regular",
    "situation": "Ativo",
    "birthDate": "15/06/1990",
    "cpfNumber": "12345678900",
    "registrationDate": "anterior a 10/11/1990",
    "verificationDigit": "03",
    "receipt": {
      "emissionTime": "22:08:26",
      "emissionDate": "13/01/2025",
      "controlCode": "XXXX.XXXX.XXXX.XXXX"
    },
    "validationUrl": "https://servicos.receita.fazenda.gov.br/Servicos/CPF/ca/ResultadoAut.asp?cp=12345678900&cc=XXXXXX&de=13012025&he=220826&dv=03&em=01",
    "validationHtmlUrl": "https://api.cpfhub.io/api/view-proof/12345678900/XXXXXXXXXXXXX"
  }
}

✅ Se a resposta indicar sucesso, significa que a API está funcionando corretamente!

5. Dicas para resolver erros comuns

Erro 401 – Unauthorized

🔍 Causa: Chave de API inválida ou ausente.

x-api-key

Erro 400 – Bad Request

🔍 Causa: Formato do JSON incorreto.

cpf

birthDate

Erro 500 – Internal Server Error

🔍 Causa: Problema no servidor da API.

✅ Solução: Aguarde e tente novamente ou entre em contato com o suporte da API.

Conclusão

Usar Postman e cURL para consultar um CPF via API é uma maneira rápida e prática de testar e integrar essa funcionalidade ao seu sistema.

🚀 Teste agora mesmo e implemente a consulta de CPF de forma automatizada!