GET/nfse/cidades/{codigoIbge}

Check municipality availability and metadata

Looks up issuance availability and particularities by IBGE code. Typical uses: - Confirm which municipalities are already supported before talking to sales or a customer. - Collect extra information about the municipality you will use. Notes: - This route is updated continuously with more municipal metadata. - Each municipality belongs to one provider standard.

Production: https://api.otentecnologia.com.brSandbox: https://api.sandbox.otentecnologia.com.br

Parameters

codigoIbge

path · required

IBGE code of the city to query.

Request

cURL

curl -X GET 'https://api.otentecnologia.com.br/nfse/cidades/{codigoIbge}' \
  -H 'x-api-key: $OTEN_API_KEY' \
  -H 'Content-Type: application/json'

Responses

200OK

JSON

{
  "id": 4115200,
  "nome": "Maringá",
  "uf": "PR",
  "padrao": "MARINGA",
  "certificado": true,
  "multiservicos": false,
  "login": false,
  "senha": false,
  "upload": false,
  "sequencial": true,
  "substituicao": true,
  "informacoesComplementares": 0,
  "descricao": 0,
  "padraoNacional": {
    "producao": true,
    "homologacao": true
  }
}

400Bad Request

JSON

{
  "error": {
    "message": "A cidade vinculada ao código IBGE utilizado ainda não foi homologada",
    "data": {
      "id": 4116208,
      "nome": "Morretes",
      "uf": "PR"
    }
  }
}

404Not Found

JSON

{
  "error": {
    "message": "Não localizamos qualquer Cidade com os parâmetros informados",
    "data": {
      "id": "411520"
    }
  }
}