← HomeFleetPay / Schema

EnderecoCiot

Structure preserved from the versioned API contract.

Technical descriptions are translated from the versioned contract. Original identifiers and JSON are preserved; data examples are omitted.

logradourostringRequired

maxLength120

numerostringRequired

maxLength10

bairrostringRequired

maxLength60

codigo_municipiostringRequired

Municipality's IBGE code, 7 digits.

pattern"^[0-9]{7}$"

ufstringRequired

minLength2

maxLength2

cepstringRequired

pattern"^[0-9]{8}$"

Original JSON Definition (Portuguese Descriptions)

{
  "type": "object",
  "required": [
    "logradouro",
    "numero",
    "bairro",
    "codigo_municipio",
    "uf",
    "cep"
  ],
  "properties": {
    "logradouro": {
      "type": "string",
      "maxLength": 120
    },
    "numero": {
      "type": "string",
      "maxLength": 10
    },
    "bairro": {
      "type": "string",
      "maxLength": 60
    },
    "codigo_municipio": {
      "type": "string",
      "pattern": "^[0-9]{7}$",
      "description": "Código IBGE do município, 7 dígitos."
    },
    "uf": {
      "type": "string",
      "minLength": 2,
      "maxLength": 2
    },
    "cep": {
      "type": "string",
      "pattern": "^[0-9]{8}$"
    }
  }
}