Documentação da API

Introdução

A API de Consulta CPF permite que você verifique informações associadas a um CPF de forma rápida e segura. Esta documentação fornece todas as informações necessárias para integrar nossa API ao seu sistema.

Autenticação

Todas as requisições à API devem incluir o token de API válida.

Nunca compartilhe seu token de API. Mantenha-a segura e não a inclua em código-fonte público.

Endpoints

Consultar CPF

URL: https://api.consultacpf.com.br/v1/cpf?cpf={cpf}&date_birth={date_birth}&token={token}

Método: GET

Parâmetros:

  • cpf (obrigatório) - CPF a ser consultado (apenas números)
  • date_birth (obrigatório) - Data de nascimento (formato: YYYYMMDD)
  • token (obrigatório) - Token de API válido

Exemplo de Requisição:

                    curl -X GET "https://api.consultacpf.com.br/v1/cpf?cpf=12345678909&date_birth=19800101&token=SUA_CHAVE_API"

Exemplo de Resposta:

{
  "status": "success",
  "data": {
    "cpf": "123.456.789-09",
    "nome": "João da Silva",
    "data_nascimento": "1980-01-01",
    "situacao_cadastral": "Regular",
    "data_inscricao": "1995-05-10",
    "digito_verificador": "09"
  }
}

Verificar Status da API

URL: https://api.consultacpf.com.br/v1/status

Método: GET

Exemplo de Requisição:

curl -X GET "https://api.consultacpf.com.br/v1/status" \
-H "Authorization: Bearer SUA_CHAVE_API"

Exemplo de Resposta:

{
  "status": "online",
  "version": "1.0.0",
  "message": "API funcionando normalmente"
}

Códigos de Status

Nossa API retorna os seguintes códigos de status HTTP:

  • 200 OK - Requisição bem-sucedida
  • 400 Bad Request - Parâmetros inválidos
  • 401 Unauthorized - Chave de API inválida ou ausente
  • 404 Not Found - CPF não encontrado
  • 429 Too Many Requests - Limite de requisições excedido
  • 500 Internal Server Error - Erro interno do servidor

Limites de Uso

Os limites de uso dependem do seu plano. Consulte a página de preços para mais informações.

Suporte

Se você tiver dúvidas ou precisar de ajuda, entre em contato com nossa equipe de suporte.