Documentacao · v1

API Descobria
Consulta CPF, CNPJ, Placa, Telefone e Dividas via REST

Integre dados de CPF, CNPJ, Placa, Telefone e Dividas em segundos. REST + JSON, sem mensalidade. Voce compra creditos, gera sua API Key e cobra do seu cliente o que quiser. 16 datasets agrupados em 5 endpoints. Pagamento por uso, integracao em 2 minutos.

Criar conta gratuita Ver endpoints

Por que a API Descobria

A API REST do Descobria expoe os mesmos 16 datasets disponiveis na plataforma web — incluindo dados cadastrais de pessoa fisica e juridica, telefones, enderecos, e-mails, vinculos societarios, processos judiciais, FIPE, BIN estadual/nacional, CRLV, CNDT, dossie juridico, Serasa Premium, QUOD, CENPROT e score de credito. Tudo em formato REST + JSON, com autenticacao por API Key.

Integracao rapida

Sua API Key em 1 minuto. Sem onboarding, sem reuniao de venda.

Pague por uso

So desconta credito quando a consulta retorna dado util. Sem mensalidade.

REST + JSON

Qualquer linguagem que faz HTTP funciona. Documentacao inclusa.

Seguro por padrao

TLS, rate limiting por key, audit log e rotacao de keys.

Casos de uso

Despachantes e cobranca

Localize devedores por CPF/CNPJ, telefone ou endereco. Cruze com Serasa, QUOD e CENPROT para priorizar carteira. Audit log completo para compliance.

Credito e cobranca

Score consolidado, restricoes financeiras, dividas ativas e CNDT em uma unica chamada. Decisao de credito em segundos, com dados de multiplos bureaus.

B2B SaaS e fintechs

Enriquecimento de cadastros (KYC, onboarding), validacao de CPF/CNPJ, prevencao a fraude e antichargeback. API Key separada por ambiente (test/live).

Quick Start — comece em 3 passos

Da criacao da conta a primeira chamada em menos de 2 minutos.

1. Tenha uma conta Descobria

Voce usa o mesmo saldo de creditos do site. Cadastro gratis, sem cartao. Criar conta gratuita. Em seguida, compre o pacote de creditos que faca sentido pro seu volume estimado em /pacotes.

2. Gere sua API Key

Acesse /minha-api > Nova API Key. Guarde o valor — ele so aparece uma vez. Use prefixo descob_test_ para desenvolvimento (nao consome creditos reais) e descob_live_ para producao.

3. Faca sua primeira chamada

curl https://descobria.com.br/api/v1/pessoa/cpf/12345678900?datasets=basic \
  -H "Authorization: ApiKey descob_live_xxxxxxxxxxxxxxxx"

Autenticacao

Toda chamada exige o header Authorization. Aceita os dois esquemas abaixo:

Authorization: ApiKey descob_live_xxxxxxxxxxxxxxxx
Authorization: Bearer descob_live_xxxxxxxxxxxxxxxx

Boas praticas: nunca exponha keys em frontend ou commits Git. Use variaveis de ambiente, rotacione a cada 90 dias e revogue keys comprometidas em /minha-api. Keys com prefixo descob_test_ sao para desenvolvimento e nao consomem creditos reais.

Endpoints disponiveis

16 datasets agrupados em 5 endpoints REST. Cobranca em creditos por chamada, passando os datasets desejados via query string ?datasets=a,b,c. Cada dataset solicitado consome o numero de creditos indicado nas tabelas abaixo.

GET/v1/pessoa/cpf/{cpf}

Consulta dados de uma pessoa fisica a partir do CPF. Retorna nome, idade, telefones, enderecos, e-mails, vinculos e processos conforme datasets escolhidos.

Path params

NomeTipoDescricao
cpfstringCPF com 11 digitos (com ou sem mascara).

Query params

NomeTipoObrigatorioDescricao
datasetsstring (csv)SimDatasets separados por virgula. Ex: basic,phones,addresses.

Datasets disponiveis — cobranca por chamada

DatasetCreditosO que retorna
basic1Nome completo, data de nascimento, nome da mae, situacao cadastral.
cpf_ultra3Dados cadastrais ampliados, RG, ocupacao, escolaridade.
phones2Telefones associados ao CPF (fixos e celulares).
addresses2Enderecos conhecidos (residenciais e comerciais).
emails2E-mails associados ao CPF.
relationships3Vinculos: parentes, conjuge, socios.
lawsuits5Processos judiciais ativos e arquivados.

Exemplo curl

curl "https://descobria.com.br/api/v1/pessoa/cpf/12345678900?datasets=basic,phones" \
  -H "Authorization: ApiKey descob_live_xxxxxxxxxxxxxxxx" \
  -H "Accept: application/json"

Exemplo Python (requests)

import requests
API_KEY = "descob_live_xxxxxxxxxxxxxxxx"
resp = requests.get(
    "https://descobria.com.br/api/v1/pessoa/cpf/12345678900?datasets=basic,phones",
    headers={"Authorization": f"ApiKey {API_KEY}"},
    timeout=30,
)
resp.raise_for_status()
data = resp.json()
print(data["credits_remaining"], data["data"])

GET/v1/empresa/cnpj/{cnpj}

Consulta dados cadastrais e de contato de uma pessoa juridica a partir do CNPJ.

Path params

NomeTipoDescricao
cnpjstringCNPJ com 14 digitos (com ou sem mascara).

Query params

NomeTipoObrigatorioDescricao
datasetsstring (csv)SimDatasets separados por virgula. Ex: basic,emails.

Datasets disponiveis — cobranca por chamada

DatasetCreditosO que retorna
basic1Razao social, CNAE, situacao cadastral, capital social, QSA.
emails2E-mails de contato da empresa e dos socios.
phones2Telefones da empresa e dos socios.
addresses2Enderecos da empresa e enderecos dos socios.

Exemplo curl

curl "https://descobria.com.br/api/v1/empresa/cnpj/12345678000199?datasets=basic,emails" \
  -H "Authorization: ApiKey descob_live_xxxxxxxxxxxxxxxx"

GET/v1/veiculo/placa/{placa}

Consulta dados de veiculo a partir da placa. Inclui dados agregados, FIPE, BIN estadual/nacional, recall e CRLV. Aceita formato antigo (AAA-1234) e Mercosul (AAA1A23).

Path params

NomeTipoDescricao
placastringPlaca do veiculo (formato Mercosul ou antigo).

Datasets disponiveis — cobranca por chamada

DatasetCreditosO que retorna
agregados_propria1Marca, modelo, ano, cor, combustivel, municipio de emplacamento.
fipe1Valor de mercado FIPE atualizado.
proprietario_placa5Dados do proprietario atual (nome, CPF/CNPJ mascarado).
bin_estadual6BIN estadual (DETRAN do estado de emplacamento).
bin_nacional8BIN nacional (base nacional consolidada).
certificado_seguranca10Certificado de seguranca veicular.
recall8Recalls ativos do fabricante.
crlv40CRLV digital (situacao do licenciamento).

Exemplo curl

curl "https://descobria.com.br/api/v1/veiculo/placa/ABC1D23?datasets=agregados_propria,fipe" \
  -H "Authorization: ApiKey descob_live_xxxxxxxxxxxxxxxx"

GET/v1/juridico/{cpf|cnpj}/{doc}

Consulta certidoes e dossies juridicos. CNDT (Certidao Nacional de Debitos Trabalhistas) disponivel para CPF e CNPJ; dossie juridico apenas para CPF.

Path params

NomeTipoDescricao
{cpf|cnpj}stringTipo do documento: literal "cpf" ou "cnpj".
docstringCPF (11 digitos) ou CNPJ (14 digitos).

Datasets disponiveis — cobranca por chamada

DatasetCreditosO que retorna
cndt15Certidao Nacional de Debitos Trabalhistas (CPF ou CNPJ).
dossie_juridico24Dossie juridico completo (so CPF). Processos ativos e arquivados.

Exemplo curl

curl "https://descobria.com.br/api/v1/juridico/cpf/12345678900?datasets=cndt" \
  -H "Authorization: ApiKey descob_live_xxxxxxxxxxxxxxxx"

GET/v1/dividas/{cpf|cnpj}/{doc}

Consulta dividas e bureaus de credito (Serasa Premium, QUOD, CENPROT, score consolidado).

Path params

NomeTipoDescricao
{cpf|cnpj}stringTipo do documento: literal "cpf" ou "cnpj".
docstringCPF (11 digitos) ou CNPJ (14 digitos).

Datasets disponiveis — cobranca por chamada

DatasetCreditosO que retorna
cadastrais_score_dividas6Cadastrais + score + dividas (CPF).
cadastrais_score_dividas_cp6Cadastrais + score + dividas (CNPJ).
serasa_premium14Serasa Premium completo com restricoes.
cenprot1CENPROT V2 (protestos em cartorio).
quod5QUOD (bureau alternativo).

Exemplo curl

curl "https://descobria.com.br/api/v1/dividas/cpf/12345678900?datasets=cenprot,quod" \
  -H "Authorization: ApiKey descob_live_xxxxxxxxxxxxxxxx"

Formato de resposta

Toda chamada retorna JSON com o mesmo envelope. credits_remaining ajuda voce a monitorar o saldo em tempo real.

{
  "query_id": "8a3f9c2d-1b4e-4a5f-9c8d-e2f3a4b5c6d7",
  "status": "success",
  "credits_used": 3,
  "credits_remaining": 47,
  "data": {
    "name": "JOAO DA SILVA",
    "cpf": "123.456.789-00",
    "birth_date": "1985-04-12",
    "phones": ["+5511999999999"],
    "addresses": [
      {
        "street": "Rua Exemplo, 123",
        "city": "Sao Paulo",
        "state": "SP",
        "zip": "01000-000"
      }
    ]
  }
}

Codigos de erro

Quando algo da errado, a API devolve o status HTTP apropriado e um JSON com error.code e error.message.

CodigoSignificadoO que fazer
401UnauthorizedAPI Key ausente ou invalida no header Authorization. Gere ou rotacione a key em /minha-api.
402Payment RequiredSaldo de creditos insuficiente. Compre mais em /pacotes.
403ForbiddenAPI Key revogada ou conta bloqueada. Crie nova key em /minha-api.
404Not FoundDados nao encontrados para o documento informado.
422Unprocessable EntityCPF, CNPJ ou placa invalido (falha na validacao de formato).
429Too Many RequestsRate limit excedido (60 req/min default). Reduza a taxa de chamadas e respeite o header Retry-After.
500Internal Server ErrorErro interno. O response inclui request_id para debug. Encaminhe para contato@descobria.com.br se persistir.

Rate limits

Limites padrao por API Key. Headers X-RateLimit-Limit, X-RateLimit-Remaining e X-RateLimit-Reset em todas as respostas.

60 RPM / API Key

Limite padrao de 60 requisicoes por minuto.

5.000 RPD / API Key

Limite diario padrao. Precisa de mais? Escreva para contato@descobria.com.br com seu caso de uso.

Audit log completo

Timestamp, IP, endpoint, latencia e status de toda chamada disponiveis em /minha-api.

Perguntas frequentes

Como funciona a cobranca da API?

Mesmo modelo da plataforma web: voce compra creditos antecipadamente (a partir de R$ 1,00 por credito) e cada endpoint consome 1+ creditos. Sem mensalidade, sem minimo. Creditos validos por 12 meses. Cada dataset solicitado via parametro datasets consome o numero de creditos indicado nas tabelas acima.

Posso testar antes de comprar creditos?

Sim. Crie sua conta gratuitamente e gere uma API Key. Para realizar consultas reais e necessario adquirir um pacote de creditos primeiro. Chaves com prefixo descob_test_ sao para desenvolvimento e nao consomem creditos reais.

Tem SDK em Python, JavaScript ou PHP?

A API e REST + JSON e funciona em qualquer linguagem (veja exemplos curl, Python, JavaScript e PHP nas secoes acima). SDKs oficiais em Python e JavaScript estao no roadmap.

Posso revender pra meus clientes?

Sim. Voce cobra do seu cliente o valor que quiser — o Descobria so cobra de voce o custo em creditos. Cada API Key tem rate limit e audit log proprio.

Como giro / revogo uma key?

Em /minha-api voce pode revogar qualquer key existente (1 clique). Depois e so criar uma nova com nome diferente. Recomendamos rotacao a cada 90 dias.

LGPD e seguranca?

Mesma base de dados de fontes publicas que a plataforma web — em conformidade com LGPD (Lei 13.709/2018). Cada chamada a API gera audit log com timestamp, IP e endpoint. Voce e responsavel pelos seus proprios consentimentos com seu cliente final.

Os creditos da API e do site sao os mesmos?

Sim. O saldo de creditos e unico por conta. Voce pode usar livremente no site (interface visual) e na API (programatica), sem precisar separar saldos.

Qual o uptime da API?

Operamos em infraestrutura redundante com SLA alvo de 99.5% mensal. Status em tempo real e historico de incidentes podem ser acompanhados via contato com suporte. Incidentes sao comunicados via email para clientes ativos.

Pronto para integrar?

Crie sua conta, compre um pacote de creditos e gere sua primeira API Key em menos de 2 minutos.

Criar conta gratuita Acessar Minha API

Duvidas? Escreva para contato@descobria.com.br.