Documentação da API

Consultas em fontes oficiais por integração. Cada fonte tem dois endpoints: um que diz o preço do alvo real sem executar e sem cobrar, e outro que executa e debita. O resultado sai por protocolo, não pela conexão aberta.

Base: https://api.oficialdata.com.br

1. Autenticação

Authorization: Bearer <token>, e só. Token na query string é recusado — a URL vive em log de proxy e no Referer.

Cada token carrega os escopos das fontes que pode chamar (consultas:{fonte}). Emita em Minha conta › APIs › Tokens.

Confira o token com GET /v1/token antes de gastar: ele diz quem você é, o que pode e até quando — sem cobrar.

2. Ciclo de uma consulta

  1. POST /v1/orcamento/{fonte} — preço e disponibilidade do alvo. Não cobra.
  2. POST /v1/consultas/{fonte} — executa e debita. Responde 202 com protocolo.
  3. GET /v1/consultas/{protocolo} — o resultado. Não cobra e não chama a origem de novo.
  4. GET /v1/consultas/{protocolo}/documento — o arquivo, quando a fonte emite um.

Idempotency-Key é obrigatória no passo 2: ali o seu retry vale dinheiro.

3. O envelope

Toda resposta usa o mesmo envelope, inclusive as de erro. header.billable diz se aquela chamada foi faturada e header.price o que foi debitado — não o de tabela.

data é sempre lista, mesmo com um item só. header.request_id é o número a citar no chamado.

Máquina: openapi.json (OpenAPI 3.1, gerado do mesmo catálogo que gera esta página).

Endpoints disponíveis

3 de 16 fontes com porta aberta

Preço de tabela, sem assinatura. Planos reduzem o valor por consulta, e fonte de repasse (cartório) cobra o emolumento da UF do alvo — que varia. O número que vale é sempre o do POST /v1/orcamento/{fonte}, calculado sobre o alvo real.

Integrações previstas

Contrato publicado, porta ainda fechada: chamar estes caminhos hoje responde 404. A doc existe antes do endpoint de propósito — é a especificação contra a qual ele é construído. A ordem de liberação segue a demanda real.

Certidão Cível — TJMG

Certidão de feitos cíveis em andamento na 1ª instância do TJMG, por comarca, com PDF oficial.

POST /v1/consultas/certidao-tjmg-civel

Certidão Criminal — TJMG

Certidão de feitos criminais em andamento na 1ª instância do TJMG, por comarca, com PDF oficial.

POST /v1/consultas/certidao-tjmg-criminal

CND Estadual — Minas Gerais

Certidão de Débitos Tributários da SEFAZ-MG para CPF ou CNPJ, com o PDF oficial do estado.

POST /v1/consultas/cnd-estadual-mg

CND Municipal — direto na prefeitura

Certidão de débitos municipais emitida no sistema da própria prefeitura, com PDF e chave de autenticidade.

POST /v1/consultas/cnd-municipal-direta

Licenciamento ambiental — CETESB

Solicitações e licenças ambientais de um CNPJ na CETESB, com as unidades e o andamento de cada processo.

POST /v1/consultas/cetesb-licenciamento

Áreas contaminadas — São Paulo

Procura o consultado no cadastro estadual de áreas contaminadas e reabilitadas de São Paulo, por nome.

POST /v1/consultas/areas-contaminadas-sp

Processos ambientais — SIAM/MG

Processos ambientais de um CPF/CNPJ no SIAM de Minas Gerais, agrupados pelos cadastros de empreendedor.

POST /v1/consultas/siam-processos-mg

Participação societária (RFB)

Em que empresas um CPF ou CNPJ consta como sócio, pelo quadro societário publicado pela Receita Federal.

POST /v1/consultas/participacao-societaria

Ficha investigativa por CPF

Endereços, telefones, e-mails, filiação e parentes de uma pessoa física a partir do CPF.

POST /v1/consultas/ficha-investigativa-cpf

CPF por nome

Candidatos a CPF a partir de um nome completo, com nascimento e sexo para desempatar.

POST /v1/consultas/busca-cpf-por-nome

Titular de telefone

Quem consta como titular de um número de telefone, com o endereço residencial cadastrado.

POST /v1/consultas/titular-telefone

Titular de e-mail

Pessoas que a base liga a um endereço de e-mail, como candidatos a conferir.

POST /v1/consultas/titular-email

Confirmação veicular por placa

Proprietário atual, dados e restrições de um veículo a partir da placa.

POST /v1/consultas/confirmacao-veicular