Exemplos

• Exemplo 1 – Endereço com sugestão de correção
• Exemplo 2 – Endereço sem sugestão de correção

Exemplo 1 – Endereço com sugestão de correção

Nesse exemplo, temos um endereço enviado no formato label, com o tipo de logradouro abreviado, o CEP com hífen e a cidade sem acento.

Requisição

{
  "label": "av paulista 1578 museu,,bela vista,01310-200,sao paulo,SP"
}

Resposta

A resposta traz a grafia oficial sugerida para o logradouro, o bairro e a cidade, com o número e o complemento separados. O status retornado será CORRECTED.

{
  "road": "Avenida Paulista",
  "number": "1578",
  "complement": "museu",
  "district": "Bela Vista",
  "zipcode": "01310200",
  "city": "São Paulo",
  "state": "SP",
  "status": "CORRECTED",
  "matchScore": 100.0,
  "label": "Avenida Paulista, 1578, Bela Vista, 01310200, São Paulo, SP"
}

Exemplo 2 – Endereço sem sugestão de correção

Nesse exemplo, temos um endereço enviado no formato estruturado em que o logradouro não corresponde ao CEP informado.

Requisição

{
  "road": "rua das acacias 45",
  "number": "",
  "zipcode": "01310200",
  "district": "bela vista",
  "city": "São Paulo",
  "state": "SP"
}

Resposta

O número foi separado do logradouro, mas não há sugestão de correção. O status retornado será NORMALIZED.

{
  "road": "rua das acacias",
  "number": "45",
  "complement": "",
  "district": "bela vista",
  "zipcode": "01310200",
  "city": "São Paulo",
  "state": "SP",
  "status": "NORMALIZED",
  "matchScore": 18.75,
  "label": "rua das acacias, 45, bela vista, 01310200, São Paulo, SP"
}