Documentação da API

Guia completo para integrar e usar todas as funcionalidades da API Detetive.pro

Início Rápido

Comece a usar nossa API em menos de 5 minutos

1. Obtenha sua API Key

Crie sua conta e gere sua chave

2. Faça sua primeira consulta

Use nossos exemplos de código

3. Integre ao seu sistema

Implemente em produção

Autenticação

Todas as requisições devem incluir sua chave de API no header Authorization

Header de Autenticação

Authorization: Bearer SEU_TOKEN_AQUI

Endpoints Disponíveis

Consulta CPF Simples

Retorna dados básicos de uma pessoa através do CPF

2 créditos

Endpoint:

POST /api/consultas/cpf-simples

Exemplo de Requisição:

cURL

curl -X POST "https://www.detetive.pro/api/consultas/cpf-simples" \
  -H "Authorization: Bearer SEU_TOKEN_AQUI" \
  -H "Content-Type: application/json" \
  -d '{"cpf": "12345678901"}'

Resposta de Sucesso:

{
  "success": true,
  "data": {
    "cpf": "12345678901",
    "nome": "João da Silva",
    "situacao": "Regular",
    "data_nascimento": "1985-07-15",
    "nome_mae": "Maria da Silva"
  },
  "credits_used": 2,
  "remaining_credits": 98
}

Consulta CNPJ Completo

Retorna dados completos de uma empresa através do CNPJ

1 crédito

Endpoint:

POST /api/consultas/cnpj

Exemplo de Requisição:

cURL

curl -X POST "https://www.detetive.pro/api/consultas/cnpj" \
  -H "Authorization: Bearer SEU_TOKEN_AQUI" \
  -H "Content-Type: application/json" \
  -d '{"cnpj": "12345678000195"}'

Busca por Placa

Retorna dados do veículo através da placa

716 créditos

Endpoint:

POST /api/consultas/busca-placa

Exemplo de Requisição:

cURL

curl -X POST "https://www.detetive.pro/api/consultas/busca-placa" \
  -H "Authorization: Bearer SEU_TOKEN_AQUI" \
  -H "Content-Type: application/json" \
  -d '{"placa": "ABC1234"}'

Tratamento de Erros

Códigos de status HTTP e mensagens de erro comuns

401 - Não Autorizado

Token inválido ou expirado

{"error": "Token inválido"}

400 - Dados Inválidos

CPF/CNPJ com formato incorreto

{"error": "CPF inválido"}

402 - Créditos Insuficientes

Saldo insuficiente para a consulta

{"error": "Créditos insuficientes"}

404 - Não Encontrado

CPF/CNPJ não encontrado na base

{"error": "Dados não encontrados"}

SDKs e Bibliotecas

Bibliotecas oficiais para facilitar a integração

JavaScript/Node.js

SDK oficial para aplicações web e backend

Python

Biblioteca para aplicações Python

PHP

Pacote Composer para PHP

Suporte e Comunidade

Precisa de ajuda? Nossa equipe está aqui para você

Canais de Suporte

suporte@detetive.pro

Chat ao vivo (24/7)

Base de conhecimento

Recursos Úteis

Pronto para começar?

Crie sua conta gratuita e comece a usar nossa API hoje mesmo