api.v1 · referência

Documentação

Todos os endpoints aceitam JSON e retornam JSON. Autentique-se enviando sua API Key no header Authorization: Bearer <sua_chave>.

Consulta CPF

R$ 1,50 / consulta

GET https://api.consultapanel.com.br/v1/consulta/cpf

Request (cURL)

curl -X GET 'https://api.consultapanel.com.br/v1/consulta/cpf?input=123.***.***-**' \
  -H 'Authorization: Bearer SUA_API_KEY'

Response 200

{
  "cpf": "123.***.***-**",
  "nome": "M***** S***** DA S****",
  "situacao": "regular",
  "data_nascimento": "19**-**-**",
  "fonte": "receita_federal"
}

Consulta CNPJ

R$ 2,50 / consulta

GET https://api.consultapanel.com.br/v1/consulta/cnpj

Request (cURL)

curl -X GET 'https://api.consultapanel.com.br/v1/consulta/cnpj?input=12.345.678%2F0001-90' \
  -H 'Authorization: Bearer SUA_API_KEY'

Response 200

{
  "cnpj": "12.345.678/0001-90",
  "razao_social": "EMPRESA EXEMPLO LTDA",
  "cnae_principal": "6201-5/01",
  "socios": [
    {
      "nome": "J*** DA S****",
      "qualificacao": "administrador"
    }
  ],
  "situacao": "ativa"
}

Consulta Telefone

R$ 0,90 / consulta

GET https://api.consultapanel.com.br/v1/consulta/telefone

Request (cURL)

curl -X GET 'https://api.consultapanel.com.br/v1/consulta/telefone?input=%2B55%2011%209****-****' \
  -H 'Authorization: Bearer SUA_API_KEY'

Response 200

{
  "numero": "+55 11 9****-****",
  "operadora": "Vivo",
  "tipo": "movel",
  "portado": true,
  "ddd_uf": "SP"
}

Consulta Placa/Veicular

R$ 1,90 / consulta

GET https://api.consultapanel.com.br/v1/consulta/placa

Request (cURL)

curl -X GET 'https://api.consultapanel.com.br/v1/consulta/placa?input=ABC-1234' \
  -H 'Authorization: Bearer SUA_API_KEY'

Response 200

{
  "placa": "ABC-1234",
  "marca": "Volkswagen",
  "modelo": "Gol 1.0",
  "ano": 2018,
  "cor": "prata",
  "situacao": "regular"
}

Consulta Endereço/CEP

R$ 0,50 / consulta

GET https://api.consultapanel.com.br/v1/consulta/endereco

Request (cURL)

curl -X GET 'https://api.consultapanel.com.br/v1/consulta/endereco?input=01310-100' \
  -H 'Authorization: Bearer SUA_API_KEY'

Response 200

{
  "cep": "01310-100",
  "logradouro": "Av. Paulista",
  "bairro": "Bela Vista",
  "cidade": "São Paulo",
  "uf": "SP"
}

Consulta Dossiê Completo

R$ 3,90 / consulta

GET https://api.consultapanel.com.br/v1/consulta/dossie

Request (cURL)

curl -X GET 'https://api.consultapanel.com.br/v1/consulta/dossie?input=123.***.***-**' \
  -H 'Authorization: Bearer SUA_API_KEY'

Response 200

{
  "cpf": "123.***.***-**",
  "pessoa": {
    "nome": "M***** S*****",
    "genero": "F"
  },
  "telefones": 3,
  "enderecos": 2,
  "veiculos": 1,
  "empresas": 0
}

Códigos de erro

401	unauthorized	API Key ausente ou inválida.
402	saldo_insuficiente	Sem saldo para cobrir o valor da consulta.
404	nao_encontrado	Registro não localizado nas bases.
422	input_invalido	Formato do input inválido para a categoria.
429	rate_limit	Limite de requisições excedido.
500	erro_provedor	Falha no provedor externo. Saldo estornado.

Rate limits

Padrão: 60 req/min por API Key. Precisa de mais? Fale com o suporte.