These docs are for v2.1. Click to read the latest docs for v4.1.

address

O objeto address é responsável por representar os dados e informações de endereço. E esse objeto normalmente é utilizado em conjunto de outros objetos.

Descrição

CampoTipoDescrição
streetString (1-160 caracteres)Rua do endereço
numberString (1-20 caracteres)Número do endereço
complementString (1-40 caracteres)Complemento do endereço
localityString (1-60 caracteres)Bairro do endereço
cityString (1-90 caracteres)Cidade do endereço
regionString (1-50 caracteres)Nome do Estado.
region_codeString (2 caracteres)Código do Estado. Padrão ISO 3166-2
countryString (1-50 caracteres)País do endereço. Padrão [ISO 3166-1 alpha-3] (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)
postal_codeString (8 caracteres)CEP do endereço

Exemplo

{
  ...
    "address": {
      "street": "Avenida Brigadeiro Faria Lima",
      "number": "1384",
      "locality": "Pinheiros",
      "city": "São Paulo",
      "region": "São Paulo",
      "region_code": "SP",
      "country": "BRA",
      "postal_code": "01452002"
    }
  ...
}