Skip to main content
Este produto expõe dados básicos de pessoa jurídica a partir do CNPJ. A plataforma trata autenticação, precificação e chamada à origem; o seu cliente usa o mesmo contrato HTTP que os demais produtos de consulta.

​
O que esperar do produto (escopo em alto nível)

Em termos de negócio, este tipo de consulta costuma devolver informações de cadastro básico da empresa — por exemplo identificação fiscal, denominação, nome fantasia, datas relevantes e situação cadastral, quando existirem na origem e forem retornados naquele contrato. Os campos concretos vêm no objeto data. A forma exata depende da origem e pode evoluir: trate como JSON dinâmico, valide só o que consome e trate a ausência de campos com elegância. Mais detalhes em Resultados.

​
Contrato único da Proteo Data

  • Autenticação: API Key em Authorization: Bearer (sem expor credenciais internas da origem).
  • Corpo mínimo: apenas document com o CNPJ — não há parâmetros opcionais para conferir razão social ou outros dados na mesma requisição; qualquer cruzamento fica do lado do cliente, usando o retorno em data.
  • Uma entidade por chamada: a consulta é para um CNPJ informado; não é busca textual aberta.
O endpoint genérico é POST /v1/query/{slug}; para este produto, slug = cnpj-basic. Veja Produtos e consultas.

​
Endpoint

POST /v1/query/cnpj-basic Mesmo contrato de consultas por produto: mudam o slug e o significado de document.

​
Autenticação

Authorization: Bearer <sua_api_key> Detalhes em Autenticação.

​
Corpo da requisição

{
  "document": "00000000000000"
}
CampoTipoObrigatórioDescrição
documentstringsimPara este produto: CNPJ com 14 dígitos, apenas números (sem máscara). O contrato aceita strings de 1 a 100 caracteres; valores fora do padrão podem falhar na origem. A API não valida dígitos verificadores.

​
Concorrência e desempenho

Mesmo comportamento do produto PF — ver Dados básicos PF (CPF) (secção Concorrência e desempenho).

​
Resposta de sucesso (200)

{
  "data": {
    "MatchKeys": "00000000000000",
    "BasicData": { }
  },
  "meta": {
    "chargedCredits": "0.044800",
    "product": "cnpj-basic",
    "queryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
}
  • data: neste produto, objeto equivalente ao primeiro item de Result na origem, ou envelope mínimo quando Result vier vazio com sucesso — veja Resultados. Caso contrário pode ser null.
  • meta: chargedCredits, product (cnpj-basic) e queryId interno Proteo para suporte (não é identificador da origem).

​
Erros comuns

Conforme Erros e limites:
HTTPSituação
400Corpo inválido (error: VALIDATION_ERROR)
401API Key ausente, inválida ou revogada
402Saldo de créditos insuficiente
404Produto inativo, slug incorreto ou sem preço para o plano
502Falha na origem da consulta

​
Privacidade e tratamento de dados

Dados de pessoas jurídicas e de sócios ou contatos eventualmente presentes no retorno exigem finalidade e base legal adequadas ao seu caso, além de minimização e controles de acesso. A responsabilidade pelo uso do retorno na sua aplicação é sua.

​
Exemplos prontos

Use os exemplos em Primeira consulta com SLUG_DO_PRODUTO = cnpj-basic e VALOR_DOCUMENTO = CNPJ válido (14 dígitos).

​
Referência da API

Na aba Referência da API:
  • POST /v1/query/cnpj-basic — endpoint de consulta de dados básicos PJ, com contrato e exemplos de uso documentados.