Localização e Logradouro - Consultar por CEP.
Realiza a busca detalhada de informações do logradouro com base no Código de Endereçamento Postal (CEP).
Este recurso é essencial para a padronização de cadastros de clientes, fornecedores e emissores, garantindo a integridade dos dados de localização.
⚠️ ATENÇÃO: O CEP informado deve conter apenas números (8 dígitos).
🔍 DICA DE INTEGRAÇÃO: Utilize este endpoint para o preenchimento automático de campos de endereço em interfaces de usuário, minimizando erros de digitação e facilitando o cálculo de alíquotas baseadas na localidade (ISS/ICMS).
get
Path Parameters
cepstringrequired
CEP - Código de Endereçamento Postal.
Headers
DocumentoEmissorstring
Documento do emissor.
Response
Response
OK
ConsultaCepViewModel
Dados detalhados da consulta de endereço via CEP.
* Additional properties are NOT allowed.
cepstring | null
Código de Endereçamento Postal.
logradourostring | null
Nome da rua, avenida ou logradouro.
complementostring | null
Informações adicionais do endereço.
bairrostring | null
Bairro onde se localiza o logradouro.
localidadestring | null
Nome da cidade ou localidade.
ufstring | null
Unidade Federativa (Estado).
ibgestring | null
Código do município no IBGE.
get/api/v1/RecursosAdicionais/Cep/{cep}/Consultar
Authentication
Path Parameters
Headers
Consultar dados do CNPJ.
Realiza a busca de informações cadastrais detalhadas de uma pessoa jurídica junto às bases de dados oficiais.
Este recurso é fundamental para a validação de emissores e garantia de que os dados cadastrais
estão atualizados para a correta aplicação das regras fiscais.
⚠️ ATENÇÃO: A consulta retorna dados públicos do registro da empresa. Certifique-se de que o CNPJ informado
esteje em formato válido para evitar erros de validação de máscara.
🧪 TESTE: Em ambiente de sandbox, a consulta pode retornar dados simplificados ou simulados para garantir
a agilidade do desenvolvimento sem onerar bureaus de crédito ou bases governamentais reais.
get
Path Parameters
cnpjstringrequired
CNPJ a ser consultado.
Headers
DocumentoEmissorstring
Documento do emissor.
Response
Response
OK
ConsultaCnpjViewModel
Representa os dados detalhados resultantes de uma consulta de CNPJ.
* Additional properties are NOT allowed.
cnpjstring | null
Número de inscrição no Cadastro Nacional da Pessoa Jurídica.
razaoSocialstring | null
Nome empresarial ou razão social completa da entidade.
nomeFantasiastring | null
Nome fantasia ou título do estabelecimento, se houver.
naturezaJuridicastring | null
Descrição da natureza jurídica da organização.
regimestring
Regime do CNPJ na consulta.
Allowed values:MeiSimplesNacionalNormal
dataAberturastring(date)
Data oficial de abertura da empresa.
Example:2025-03-31
statusstring | null
Situação cadastral atual (Ex: Ativa, Baixada, Suspensa).
ultimaAlteracaoStatusstring | null(date)
Data da última atualização da situação cadastral.
telefonesarray | null[string]
Lista de números de telefone para contato.
emailsarray | null[string]
Lista de endereços de e-mail para contato.
atividadePrincipalobject
Representa uma Classificação Nacional de Atividade Econômica (CNAE).
* Additional properties are NOT allowed.
Show Child Parameters
atividadesSecundariasarray | null[object]
Representa uma Classificação Nacional de Atividade Econômica (CNAE).
* Additional properties are NOT allowed.
Show Child Parameters
enderecoobject
Representa o endereço completo de uma entidade.
* Additional properties are NOT allowed.
Show Child Parameters
sociosarray | null[object]
Representa um membro do quadro societário ou administrativo.
* Additional properties are NOT allowed.
Show Child Parameters
inscricoesEstaduaisarray | null[object]
Representa os detalhes de uma inscrição estadual.
* Additional properties are NOT allowed.
Show Child Parameters
get/api/v1/RecursosAdicionais/Cnpj/{cnpj}/Consultar
Authentication
Path Parameters
Headers
Histórico de consultas CNPJ - Resumo.
Fornece uma visão consolidada e totalizada do histórico de consultas de CNPJ realizadas pela aplicação.
Este recurso é estratégico para a gestão e bilhetagem do consumo, permitindo auditar o volume de requisições
processadas dentro de um período específico ou através de termos de busca.
📊 INDICADORES: O retorno contempla somatórios que auxiliam no controle operacional e financeiro do uso da API de consulta cadastral.
get
Query Parameters
filtrostring
Filtrar pelo filtro utilizado na consulta.
dataConsultaInicialstring(date-time)
Filtrar pela data de consulta “a partir de”.
dataConsultaFinalstring(date-time)
Filtrar pela data de consulta “até”.
Headers
DocumentoEmissorstring
Documento do emissor.
Response
Response
OK
ObterResumoConsultaCnpjAplicacaoViewModel
Dados do resumo do histórico de consultas de CNPJ.
* Additional properties are NOT allowed.
totalConsultasinteger(int32)
Total de consultas realizadas pelo emissor.
totalSucessointeger(int32)
Total de consultas concluídas com sucesso.
totalNaoEncontradointeger(int32)
Total de consultas cujo CNPJ não foi encontrado.
totalFalhainteger(int32)
Total de consultas que apresentaram falhas no processo.
get/api/v1/RecursosAdicionais/Cnpj/HistoricoConsulta/Resumo
Authentication
Query Parameters
Headers
Histórico de consultas CNPJ - Listar.
Permite listar consultas de CNPJ realizadas. O recurso retorna uma relação resumida das consultas, possibilitando a identificação de quais CNPJs foram consultados em um determinado período.
📋 PAGINAÇÃO: A listagem utiliza o padrão de offset e limit. É recomendável parametrizar o tamanho da página para otimizar o tempo de resposta e o tráfego de dados.
🔍 FILTROS: É possível refinar os resultados utilizando intervalos de datas ou filtro para localizar registros específicos no histórico.
get
Query Parameters
filtrostring
Filtrar pelo filtro utilizado na consulta.
dataConsultaInicialstring(date-time)
Filtrar pela data de consulta “a partir de”.
dataConsultaFinalstring(date-time)
Filtrar pela data de consulta “até”.
offsetinteger(int32)
Quantidade de registros a serem pulados.
Default:1
limitinteger(int32)
Limite máximo de registros por página.
Default:10
Headers
DocumentoEmissorstring
Documento do emissor.
Response
Response
OK
ListarConsultasCnpjAplicacaoViewModelListPaginationResponse
* Additional properties are NOT allowed.
offsetinteger(int32)
limitinteger(int32)
totalinteger(int32)
dataarray | null[object]
Dados para listagem do histórico de consultas do CNPJ.
* Additional properties are NOT allowed.
Show Child Parameters
get/api/v1/RecursosAdicionais/Cnpj/HistoricoConsulta/Listar
Authentication
Query Parameters
Headers
Histórico de consultas CNPJ - Detalhe.
Permite obter o detalhamento completo de uma consulta de CNPJ realizada anteriormente.
O recurso recupera os dados cadastrais e fiscais da entidade consultada conforme registrado no momento da transação original,
utilizando o identificador único gerado pelo histórico.
🔍 RASTRO: Este endpoint é essencial para auditoria e recuperação de dados de consultas anteriores sem a necessidade de realizar um novo consumo tarifado, desde que o ID do histórico esteja disponível.
get
Path Parameters
historicoConsultaCnpjIdstring(uuid)required
Identificador do histórico de consulta do cnpj.
Headers
DocumentoEmissorstring
Documento do emissor.
Response
Response
OK
ObterDetalheConsultaCnpjAplicacaoViewModel
Dados detalhados do histórico de consulta de CNPJ.
* Additional properties are NOT allowed.
idstring(uuid)
Identificador único da consulta.
filtrostring | null
Filtro utilizado na consulta (CNPJ).
statusConsultastring
Status da consulta de CNPJ.
Allowed values:SucessoNaoEncontradoFalha
dataConsultastring(date-time)
Data e hora em que a consulta foi registrada.
mensagemFalhastring | null
Mensagem detalhando o motivo de uma eventual falha.
jsonResultadoInformadostring | null
JSON com o resultado final processado ou informado.
get/api/v1/RecursosAdicionais/Cnpj/HistoricoConsulta/{historicoConsultaCnpjId}/ObterDetalhe