{"openapi":"3.0.4","info":{"title":"Next API","description":"API para consulta de dados cadastrais da Receita Federal","contact":{"name":"Next API","email":"contato@nextapi.com.br"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"1"},"paths":{"/v1/ceps/{cep}":{"get":{"tags":["CEPs"],"summary":"Consulta CEP por número","description":"Retorna as informações do CEP informado.\n\n- Cada consulta no plano gratuito consome 1 crédito, nos planos pagos a consulta é isenta de custos.","parameters":[{"name":"cep","in":"path","description":"Número do CEP (somente dígitos, ex: 01310100)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operação realizada com sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CepItemResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/CepItemResponse"}}}},"400":{"description":"Erro nos parametros informados na requisição","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}}}},"404":{"description":"Registro não localizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}}}},"405":{"description":"Falta de créditos para realizar a consulta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}}}},"500":{"description":"Erro ao processar a requisição","content":{"application/json":{"schema":{}},"text/xml":{"schema":{}}}}}}},"/v1/ceps":{"get":{"tags":["CEPs"],"summary":"Pesquisa avançada de CEPs","description":"Retorna uma lista paginada de CEPs com base nos filtros fornecidos.\n\n- O resultado da consulta é paginado com limite de 200 itens por pagina.\n- Limite global de 2.000 itens.\n- Cada consulta consome 2 créditos.\n- Disponível somente nos planos pagos.","parameters":[{"name":"uf","in":"query","description":"Sigla do estado (ex: SP, RJ)","schema":{"type":"string"}},{"name":"idMunicipio","in":"query","description":"Código do município","schema":{"type":"integer","format":"int32"}},{"name":"nomeMunicipio","in":"query","description":"Nome do município para filtro (busca parcial)","schema":{"type":"string"}},{"name":"logradouro","in":"query","description":"Nome do logradouro para filtro (busca parcial)","schema":{"type":"string"}},{"name":"q","in":"query","description":"Busca global, realiza busca por palavra/texto nos campos cep, logradouro, localidade, nomeMunicipio e uf","schema":{"type":"string"}},{"name":"page","in":"query","description":"Número da página (padrão: 1)","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Quantidade de itens por página (máx: 200)","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Operação realizada com sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CepItemResponsePagedResult"}},"text/xml":{"schema":{"$ref":"#/components/schemas/CepItemResponsePagedResult"}}}},"400":{"description":"Erro nos parametros informados na requisição","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}}}},"405":{"description":"Falta de créditos para realizar a consulta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}}}},"500":{"description":"Erro ao processar a requisição","content":{"application/json":{"schema":{}},"text/xml":{"schema":{}}}}}}},"/v1/ceps/geo":{"get":{"tags":["CEPs"],"summary":"Pesquisa geoespacial de CEPs por Latitude/Longitude","description":"Retorna uma lista paginada de CEPs próximos a uma coordenada informada (latitude/longitude) dentro de um raio em metros.\n\n- O resultado da consulta é paginado com limite de 200 itens por pagina.\n- Limite global de 2.000 itens.\n- Cada consulta consome 2 créditos.\n- Disponível somente nos planos pagos.","parameters":[{"name":"latitude","in":"query","description":"Latitude do ponto de referência (ex: -23.5489)","required":true,"schema":{"type":"number","format":"double"}},{"name":"longitude","in":"query","description":"Longitude do ponto de referência (ex: -46.6388)","required":true,"schema":{"type":"number","format":"double"}},{"name":"raioMetro","in":"query","description":"Raio em metros ao redor do ponto de referência","required":true,"schema":{"type":"number","format":"double"}},{"name":"page","in":"query","description":"Número da página (padrão: 1)","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Quantidade de itens por página (máx: 200)","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Operação realizada com sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CepItemResponsePagedResult"}},"text/xml":{"schema":{"$ref":"#/components/schemas/CepItemResponsePagedResult"}}}},"400":{"description":"Erro nos parametros informados na requisição","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}}}},"405":{"description":"Falta de créditos para realizar a consulta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}}}},"500":{"description":"Erro ao processar a requisição","content":{"application/json":{"schema":{}},"text/xml":{"schema":{}}}}}}},"/v1/ceps/geo/{cep}":{"get":{"tags":["CEPs"],"summary":"Pesquisa geoespacial de CEPs","description":"Retorna uma lista paginada de CEPs próximos a um CEP informado, dentro de um raio em metros.\n\n- O resultado da consulta é paginado com limite de 200 itens por pagina.\n- Limite global de 2.000 itens.\n- Cada consulta consome 2 créditos.\n- Disponível somente nos planos pagos.","parameters":[{"name":"cep","in":"path","description":"Número do CEP (somente dígitos, ex: 01310100)","required":true,"schema":{"type":"string"}},{"name":"raioMetro","in":"query","description":"Raio em metros ao redor do ponto de referência","required":true,"schema":{"type":"number","format":"double"}},{"name":"page","in":"query","description":"Número da página (padrão: 1)","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Quantidade de itens por página (máx: 200)","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Operação realizada com sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CepItemResponsePagedResult"}},"text/xml":{"schema":{"$ref":"#/components/schemas/CepItemResponsePagedResult"}}}},"400":{"description":"Erro nos parametros informados na requisição","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}}}},"405":{"description":"Falta de créditos para realizar a consulta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}}}},"500":{"description":"Erro ao processar a requisição","content":{"application/json":{"schema":{}},"text/xml":{"schema":{}}}}}}},"/v1/cnaes":{"get":{"tags":["CNAEs"],"summary":"Lista CNAEs","description":"Retorna uma lista paginada com os CNAEs cadastrados na base\n\n- O resultado da consulta é paginado com limite de 200 itens por pagina.\n- Cada consulta consome 1 crédito.\n- Disponível somente nos planos pagos.","parameters":[{"name":"page","in":"query","description":"Número da página (padrão: 1)","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Quantidade de itens por página (máx: 200)","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Operação realizada com sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CnaeItemResponsePagedResult"}},"text/xml":{"schema":{"$ref":"#/components/schemas/CnaeItemResponsePagedResult"}}}},"400":{"description":"Erro nos parametros informados na requisição","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}}}},"405":{"description":"Falta de créditos para realizar a consulta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}}}},"500":{"description":"Erro ao processar a requisição","content":{"application/json":{"schema":{}},"text/xml":{"schema":{}}}}}}},"/v1/cnpj/{cnpj}":{"get":{"tags":["CNPJ"],"summary":"Busca CNPJ","description":"Pesquisa pelo CNPJ informado na base da Receita Federal e retorna os dados do estabelecimento comercial\n\nCada consulta consome 1 crédito.","parameters":[{"name":"cnpj","in":"path","description":"Número do CNPJ (somente dígitos, ex: 00000000000191)","required":true,"schema":{"type":"string"}},{"name":"toleranceDays","in":"query","description":"Quantidade máxima de dias de tolerância do cache (0 a 45)","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Operação realizada com sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CnpjItemResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/CnpjItemResponse"}}}},"400":{"description":"Erro nos parametros informados na requisição","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}}}},"404":{"description":"Registro não localizado","content":{"application/json":{"schema":{}},"text/xml":{"schema":{}}}},"405":{"description":"Falta de créditos para realizar a consulta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}}}},"500":{"description":"Erro ao processar a requisição","content":{"application/json":{"schema":{}},"text/xml":{"schema":{}}}}}}},"/v1/cnpj/{cnpj}/simples":{"get":{"tags":["CNPJ"],"summary":"Busca dados do Simples Nacional do CNPJ","description":"Retorna os dados do Simples Nacional para o CNPJ informado.\n\n- Cada consulta consome 1 crédito.\n- Disponível em todos os planos (no plano gratuito, restrito à base local/cache).","parameters":[{"name":"cnpj","in":"path","description":"Número do CNPJ (somente dígitos, ex: 00000000000191)","required":true,"schema":{"type":"string"}},{"name":"toleranceDays","in":"query","description":"Quantidade máxima de dias de tolerância do cache (0 a 45)","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Operação realizada com sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CnpjSimplesResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/CnpjSimplesResponse"}}}},"400":{"description":"Erro nos parametros informados na requisição","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}}}},"404":{"description":"Registro não localizado","content":{"application/json":{"schema":{}},"text/xml":{"schema":{}}}},"405":{"description":"Falta de créditos para realizar a consulta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}}}},"500":{"description":"Erro ao processar a requisição","content":{"application/json":{"schema":{}},"text/xml":{"schema":{}}}}}}},"/v1/cnpj/{cnpj}/ie":{"get":{"tags":["CNPJ"],"summary":"Busca Inscrições Estaduais do CNPJ","description":"Retorna as Inscrições Estaduais (IE) disponíveis para o CNPJ informado.\n\n- Um CNPJ pode possuir mais de uma IE (uma por UF), por isso a resposta é uma lista.\n- Dado essencial para emissão de Nota Fiscal.\n- A cobertura é limitada aos estados que publicam a base pública de Inscrições Estaduais: atualmente **SP, PR e MG**. CNPJs de outras UFs, ou sem IE registrada, retornam lista vazia.\n- Cada consulta consome 1 crédito. Disponível em todos os planos.","parameters":[{"name":"cnpj","in":"path","description":"Número do CNPJ (somente dígitos, ex: 00000000000191)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operação realizada com sucesso","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CnpjInscricaoEstadualResponse"}}},"text/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CnpjInscricaoEstadualResponse"}}}}},"400":{"description":"Erro nos parametros informados na requisição","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}}}},"405":{"description":"Falta de créditos para realizar a consulta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}}}},"500":{"description":"Erro ao processar a requisição","content":{"application/json":{"schema":{}},"text/xml":{"schema":{}}}}}}},"/v1/cnpj/batch":{"post":{"tags":["CNPJ"],"summary":"Busca CNPJs em lote","description":"Pesquisa por uma lista de CNPJs informada no corpo da requisição e retorna os dados dos estabelecimentos localizados.\n\n- Limite de 100 CNPJs por requisição.\n- Cada registro localizado consome 1 crédito.\n- Disponível somente nos planos pagos.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchCnpjRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/BatchCnpjRequest"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/BatchCnpjRequest"}}}},"responses":{"200":{"description":"Operação realizada com sucesso","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CnpjItemResponse"}}},"text/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CnpjItemResponse"}}}}},"400":{"description":"Erro nos parametros informados na requisição","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}}}},"500":{"description":"Erro ao processar a requisição","content":{"application/json":{"schema":{}},"text/xml":{"schema":{}}}}}}},"/v1/cnpj/batch/simples":{"post":{"tags":["CNPJ"],"summary":"Busca dados do Simples Nacional em lote","description":"Pesquisa por uma lista de CNPJs informada no corpo da requisição e retorna os dados do Simples Nacional dos estabelecimentos localizados.\n\n- Limite de 100 CNPJs por requisição.\n- Cada registro localizado consome 1 crédito.\n- Disponível somente nos planos pagos.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchCnpjRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/BatchCnpjRequest"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/BatchCnpjRequest"}}}},"responses":{"200":{"description":"Operação realizada com sucesso","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CnpjSimplesResponse"}}},"text/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CnpjSimplesResponse"}}}}},"400":{"description":"Erro nos parametros informados na requisição","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}}}},"500":{"description":"Erro ao processar a requisição","content":{"application/json":{"schema":{}},"text/xml":{"schema":{}}}}}}},"/v1/credits":{"get":{"tags":["Créditos"],"summary":"Consulta Saldo de Créditos","description":"Retorna o saldo detalhado de créditos da assinatura e créditos extras, além dos limites associados ao workspace atual.\n\n- Esta operação é isenta (consome 0 créditos).\n- A consulta pode ser executada mesmo se o saldo estiver zerado.","responses":{"200":{"description":"Operação realizada com sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceCreditsResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/WorkspaceCreditsResponse"}}}},"400":{"description":"Erro nos parametros informados na requisição","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}}}},"401":{"description":"Token de autenticação inválido ou ausente","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}}}},"500":{"description":"Erro ao processar a requisição","content":{"application/json":{"schema":{}},"text/xml":{"schema":{}}}}}}},"/v1/empresas":{"get":{"tags":["Empresas"],"summary":"Busca Empresas","description":"Busca Empresas e Estabelecimentos cadastrados na Receita Federal com filtros avançados.\n\n- O resultado da consulta é paginado com limite de até 100 itens por página (padrão 20) e 5.000 itens totais.\n- Cada consulta consome **1 crédito**.\n- Disponível somente nos planos pagos.","parameters":[{"name":"uf","in":"query","description":"Sigla do estado para filtro (ex: SP, RJ)","schema":{"type":"string"}},{"name":"codigoMunicipio","in":"query","description":"Código(s) do município, separados por vírgula (ex: 3550308,3304557)","schema":{"type":"string"}},{"name":"cnpjRaiz","in":"query","description":"CNPJ raiz (8 primeiros dígitos) para filtro","schema":{"type":"string"}},{"name":"cnpj","in":"query","description":"Número completo do CNPJ para filtro (somente dígitos)","schema":{"type":"string"}},{"name":"q","in":"query","description":"Busca pelo início da Razão Social ou Nome Fantasia (mínimo 3 caracteres)","schema":{"type":"string"}},{"name":"dataAberturaInicio","in":"query","description":"Data de abertura inicial do intervalo de filtro (formato: yyyy-MM-dd)","schema":{"type":"string","format":"date-time"}},{"name":"dataAberturaFim","in":"query","description":"Data de abertura final do intervalo de filtro (formato: yyyy-MM-dd)","schema":{"type":"string","format":"date-time"}},{"name":"codigoSituacaoCadastral","in":"query","description":"Código(s) de situação cadastral separados por vírgula (01=Nula, 02=Ativa, 03=Suspensa, 04=Inapta, 08=Baixada)","schema":{"type":"string"}},{"name":"ceps","in":"query","description":"CEP(s) para filtro, separados por vírgula","schema":{"type":"string"}},{"name":"cnaes","in":"query","description":"Código(s) CNAE (somente números) para filtro, separados por vírgula","schema":{"type":"string"}},{"name":"page","in":"query","description":"Número da página (padrão: 1)","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Quantidade de itens por página (máx: 200)","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Operação realizada com sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CnpjSimplifiedResponsePagedResult"}},"text/xml":{"schema":{"$ref":"#/components/schemas/CnpjSimplifiedResponsePagedResult"}}}},"400":{"description":"Erro nos parametros informados na requisição","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}}}},"405":{"description":"Falta de créditos para realizar a consulta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}}}},"500":{"description":"Erro ao processar a requisição","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}}}}}}},"/v1/estados":{"get":{"tags":["Estados"],"summary":"Lista Estados","description":"Retorna uma lista paginada com os Estados da união.\n\n- O resultado da consulta é paginado com limite de 200 itens por pagina.\n- Cada consulta consome 1 crédito.\n- Disponível somente nos planos pagos.","parameters":[{"name":"page","in":"query","description":"Número da página (padrão: 1)","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Quantidade de itens por página (máx: 200)","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Operação realizada com sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EstadoItemResponsePagedResult"}},"text/xml":{"schema":{"$ref":"#/components/schemas/EstadoItemResponsePagedResult"}}}},"400":{"description":"Erro nos parametros informados na requisição","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}}}},"405":{"description":"Falta de créditos para realizar a consulta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}}}},"500":{"description":"Erro ao processar a requisição","content":{"application/json":{"schema":{}},"text/xml":{"schema":{}}}}}}},"/v1/municipios":{"get":{"tags":["Municípios"],"summary":"Lista Municípios","description":"Lista todos os municípios de forma paginada, com filtro opcional por UF.\n\n- O resultado da consulta é paginado com limite de 200 itens por pagina.\n- Cada consulta consome 1 crédito.\n- Disponível somente nos planos pagos.","parameters":[{"name":"uf","in":"query","description":"Sigla do estado para filtro (ex: SP, RJ)","schema":{"type":"string"}},{"name":"page","in":"query","description":"Número da página (padrão: 1)","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Quantidade de itens por página (máx: 200)","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Operação realizada com sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MunicipioItemResponsePagedResult"}},"text/xml":{"schema":{"$ref":"#/components/schemas/MunicipioItemResponsePagedResult"}}}},"400":{"description":"Erro nos parametros informados na requisição","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}}}},"405":{"description":"Falta de créditos para realizar a consulta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}}}},"500":{"description":"Erro ao processar a requisição","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}}}}}}},"/v1/municipios/{id}":{"get":{"tags":["Municípios"],"summary":"Obtém Município por ID","description":"Obtém os dados completos de um município específico pelo seu ID.\n\n- Retorna todos os dados do município incluindo população, empresas e divisões territoriais.\n- Cada consulta consome 1 crédito.\n- Disponível somente nos planos pagos.","parameters":[{"name":"id","in":"path","description":"ID do município","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Operação realizada com sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MunicipioDetalhadoResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/MunicipioDetalhadoResponse"}}}},"400":{"description":"Erro nos parametros informados na requisição","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}}}},"404":{"description":"Registro não localizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}}}},"405":{"description":"Falta de créditos para realizar a consulta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}}}},"500":{"description":"Erro ao processar a requisição","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}},"text/xml":{"schema":{"$ref":"#/components/schemas/IErrorCodeModel"}}}}}}}},"components":{"schemas":{"BatchCnpjRequest":{"type":"object","properties":{"cnpjs":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false},"CepCodigoIbgeResponse":{"type":"object","properties":{"municipio":{"type":"integer","format":"int32","nullable":true},"estado":{"type":"integer","format":"int32","nullable":true},"pais":{"type":"integer","format":"int32","nullable":true}},"additionalProperties":false},"CepItemResponse":{"required":["cep"],"type":"object","properties":{"cep":{"type":"string","nullable":true},"logradouro":{"type":"string","nullable":true},"localidade":{"type":"string","nullable":true},"idMunicipio":{"type":"integer","format":"int32","nullable":true},"nomeMunicipio":{"type":"string","nullable":true},"uf":{"type":"string","nullable":true},"latitude":{"type":"number","format":"double","nullable":true},"longitude":{"type":"number","format":"double","nullable":true},"dataAtualizacao":{"type":"string","format":"date-time","nullable":true},"codigoIbge":{"$ref":"#/components/schemas/CepCodigoIbgeResponse"}},"additionalProperties":false},"CepItemResponsePagedResult":{"type":"object","properties":{"page":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"items":{"type":"array","items":{"$ref":"#/components/schemas/CepItemResponse"},"nullable":true}},"additionalProperties":false},"CnaeItemResponse":{"required":["codigo"],"type":"object","properties":{"codigo":{"type":"string","nullable":true},"descricao":{"type":"string","nullable":true}},"additionalProperties":false},"CnaeItemResponsePagedResult":{"type":"object","properties":{"page":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"items":{"type":"array","items":{"$ref":"#/components/schemas/CnaeItemResponse"},"nullable":true}},"additionalProperties":false},"CnpjInscricaoEstadualResponse":{"type":"object","properties":{"cnpj":{"type":"string","nullable":true},"inscricaoEstadual":{"type":"string","nullable":true},"uf":{"type":"string","nullable":true},"situacao":{"type":"string","nullable":true},"cnae":{"type":"string","nullable":true},"municipio":{"type":"string","nullable":true},"dataAtualizacao":{"type":"string","nullable":true}},"additionalProperties":false},"CnpjItemResponse":{"type":"object","properties":{"cnpj":{"type":"string","nullable":true},"razaoSocial":{"type":"string","nullable":true},"nomeFantasia":{"type":"string","nullable":true},"tipo":{"type":"string","nullable":true},"dataAbertura":{"type":"string","nullable":true},"situacaoCadastral":{"type":"string","nullable":true},"dataSituacaoCadastral":{"type":"string","nullable":true},"motivoSituacaoCadastral":{"type":"string","nullable":true},"porte":{"type":"string","nullable":true},"capitalSocial":{"type":"number","format":"double","nullable":true},"naturezaJuridica":{"type":"string","nullable":true},"logradouro":{"type":"string","nullable":true},"numero":{"type":"string","nullable":true},"complemento":{"type":"string","nullable":true},"cep":{"type":"string","nullable":true},"bairro":{"type":"string","nullable":true},"municipio":{"type":"string","nullable":true},"uf":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"telefone":{"type":"string","nullable":true},"situacaoEspecial":{"type":"string","nullable":true},"dataSituacaoEspecial":{"type":"string","nullable":true},"atividadePrincipal":{"$ref":"#/components/schemas/CnpjItemResponseCode"},"atividadeSecundaria":{"type":"array","items":{"$ref":"#/components/schemas/CnpjItemResponseCode"},"nullable":true},"quadroDeSocios":{"type":"array","items":{"$ref":"#/components/schemas/CnpjItemResponsePartner"},"nullable":true},"dataAtualizacao":{"type":"string","nullable":true}},"additionalProperties":false},"CnpjItemResponseCode":{"type":"object","properties":{"codigo":{"type":"string","nullable":true},"descricao":{"type":"string","nullable":true}},"additionalProperties":false},"CnpjItemResponsePartner":{"type":"object","properties":{"nome":{"type":"string","nullable":true},"qualificacao":{"type":"string","nullable":true},"representanteLegal":{"type":"string","nullable":true},"qualificacaoRepresentanteLegal":{"type":"string","nullable":true},"paisOrigem":{"type":"string","nullable":true}},"additionalProperties":false},"CnpjSimplesResponse":{"type":"object","properties":{"cnpj":{"type":"string","nullable":true},"opcaoPeloSimples":{"type":"boolean","nullable":true},"dataOpcaoPeloSimples":{"type":"string","format":"date-time","nullable":true},"dataExclusaoDoSimples":{"type":"string","format":"date-time","nullable":true},"opcaoPeloMEI":{"type":"boolean","nullable":true},"dataOpcaoPeloMEI":{"type":"string","format":"date-time","nullable":true},"dataExclusaoDoMEI":{"type":"string","format":"date-time","nullable":true},"dataAtualizacao":{"type":"string","nullable":true}},"additionalProperties":false},"CnpjSimplifiedResponse":{"type":"object","properties":{"cnpj":{"type":"string","nullable":true},"razaoSocial":{"type":"string","nullable":true},"situacaoCadastral":{"type":"string","nullable":true},"uf":{"type":"string","nullable":true}},"additionalProperties":false},"CnpjSimplifiedResponsePagedResult":{"type":"object","properties":{"page":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"items":{"type":"array","items":{"$ref":"#/components/schemas/CnpjSimplifiedResponse"},"nullable":true}},"additionalProperties":false},"EstadoItemResponse":{"required":["uf"],"type":"object","properties":{"uf":{"type":"string","nullable":true},"nome":{"type":"string","nullable":true},"totalEstabelecimentos":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"EstadoItemResponsePagedResult":{"type":"object","properties":{"page":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"items":{"type":"array","items":{"$ref":"#/components/schemas/EstadoItemResponse"},"nullable":true}},"additionalProperties":false},"ExtraCreditsInfo":{"type":"object","properties":{"remaining":{"type":"integer","format":"int32"}},"additionalProperties":false},"IErrorCodeModel":{"type":"object","properties":{"status":{"type":"string","nullable":true},"code":{"type":"integer","format":"int32"},"message":{"type":"string","nullable":true}},"additionalProperties":false},"LimitsInfo":{"type":"object","properties":{"requestsPerMinute":{"type":"integer","format":"int32"},"allowExternalSearch":{"type":"boolean"},"canLiveSearch":{"type":"boolean"}},"additionalProperties":false},"MunicipioDetalhadoResponse":{"required":["descricao","id","uf"],"type":"object","properties":{"id":{"type":"integer","format":"int32"},"descricao":{"type":"string","nullable":true},"uf":{"type":"string","nullable":true},"codigoIbge":{"type":"string","nullable":true},"populacaoEstimada":{"type":"integer","format":"int64","nullable":true},"regiao":{"type":"string","nullable":true},"mesorregiao":{"$ref":"#/components/schemas/MunicipioHierarquiaResponse"},"microrregiao":{"$ref":"#/components/schemas/MunicipioHierarquiaResponse"},"regiaoImediata":{"$ref":"#/components/schemas/MunicipioHierarquiaResponse"},"regiaoIntermediaria":{"$ref":"#/components/schemas/MunicipioHierarquiaResponse"},"ibgeAtualizadoEm":{"type":"string","format":"date-time","nullable":true},"totalEmpresas":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"MunicipioHierarquiaResponse":{"required":["codigo","nome"],"type":"object","properties":{"codigo":{"type":"string","nullable":true},"nome":{"type":"string","nullable":true}},"additionalProperties":false},"MunicipioItemResponse":{"required":["descricao","id","uf"],"type":"object","properties":{"id":{"type":"integer","format":"int32"},"descricao":{"type":"string","nullable":true},"uf":{"type":"string","nullable":true}},"additionalProperties":false},"MunicipioItemResponsePagedResult":{"type":"object","properties":{"page":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"items":{"type":"array","items":{"$ref":"#/components/schemas/MunicipioItemResponse"},"nullable":true}},"additionalProperties":false},"PlanCreditsInfo":{"type":"object","properties":{"allocated":{"type":"integer","format":"int32"},"remaining":{"type":"integer","format":"int32"}},"additionalProperties":false},"WorkspaceCreditsResponse":{"type":"object","properties":{"workspaceId":{"type":"integer","format":"int64"},"monthReference":{"type":"string","nullable":true},"planCredits":{"$ref":"#/components/schemas/PlanCreditsInfo"},"extraCredits":{"$ref":"#/components/schemas/ExtraCreditsInfo"},"totalRemainingCredits":{"type":"integer","format":"int32"},"limits":{"$ref":"#/components/schemas/LimitsInfo"}},"additionalProperties":false}},"securitySchemes":{"Bearer":{"type":"apiKey","description":"Authorization header using the Bearer scheme. <br /> Enter 'Bearer' [space] and then your token in the text input below. <br /> Example: 'Bearer 12345abcdef'","name":"Authorization","in":"header"}}},"security":[{"Bearer":[]}],"tags":[{"name":"Municípios","description":"Endpoints para listar municípios brasileiros com paginação e filtro opcional por UF."},{"name":"Estados","description":"Endpoints para listar os estados (UF) brasileiros com paginação."},{"name":"CNAEs","description":"Endpoints para consulta de Classificação Nacional de Atividades Econômicas (CNAEs). Permite listar CNAEs com paginação."},{"name":"Créditos"},{"name":"CEPs","description":"Endpoints para consulta de CEPs. Permite busca por CEP, Busca Avançada e Busca por Geo-localização."},{"name":"Empresas","description":"Endpoints relacionados à consulta de empresas e estabelecimentos. Permite buscas com filtros avançados na base da Receita Federal."},{"name":"CNPJ","description":"Endpoints relacionados à consulta de CNPJs na base da Receita Federal. Permite buscar informações cadastrais e detalhes do estabelecimento."}],"servers":[{"url":"https://api.nextapi.com.br"}]}