Documentação / Referência

Referência da API

Consulte parâmetros, modelos, respostas e exemplos de todos os endpoints.

Explore as 15 operações documentadas. Cada página apresenta parâmetros, corpo da requisição, respostas e modelos do contrato OpenAPI v1.

Baixar o contrato OpenAPI para importar no Postman ou em outra ferramenta compatível.

CEPs

GET

CNAEs

GET

Lista CNAEs

/v1/cnaes

CNPJ

GET

Busca CNPJ

/v1/cnpj/{cnpj}GET

Busca dados do Simples Nacional do CNPJ

/v1/cnpj/{cnpj}/simplesGET

Busca Inscrições Estaduais do CNPJ

/v1/cnpj/{cnpj}/iePOST

Busca CNPJs em lote

/v1/cnpj/batchPOST

Busca dados do Simples Nacional em lote

/v1/cnpj/batch/simples

Créditos

GET

Consulta Saldo de Créditos

/v1/credits

Empresas

GET

Busca Empresas

/v1/empresas

Estados

GET

Lista Estados

/v1/estados

Municípios

GET

Lista Municípios

/v1/municipiosGET

Obtém Município por ID

/v1/municipios/{id}