Address Analyzer

Estrutura da resposta

Na resposta, teremos os seguintes campos:

  • label – Texto com o endereço completo no formato road, number, district, zipcode, city, state, com a sugestão de correção aplicada aos campos;
  • road – Texto com o logradouro. Quando o status for CORRECTED, será o nome oficial sugerido para o logradouro; caso contrário, o logradouro enviado já padronizado;
  • number – Texto com o número do imóvel;
  • complement – Texto com o complemento identificado no endereço enviado;
  • district – Texto com o bairro. Quando o status for CORRECTED, será o nome oficial sugerido para o bairro; caso contrário, o valor enviado;
  • zipcode – Texto com o CEP, com 8 dígitos e somente números;
  • city – Texto com o município. Quando o status for CORRECTED, será o nome oficial sugerido para o município; caso contrário, o valor enviado;
  • state – Texto com a sigla do estado (UF), com 2 letras;
  • matchScore – Número (double) de 0 a 100 que indica o grau de correspondência entre o logradouro enviado e o logradouro oficial do CEP informado. Retornado em todos os status;
  • status – Texto que indica o resultado da análise. Os valores possíveis são:
    • CORRECTED – Foi encontrada uma sugestão de correção. Os campos road, district, city e state trazem os nomes oficiais sugeridos;
    • NORMALIZED – O endereço foi apenas padronizado, sem sugestão de correção, pois não foi possível confirmar a correspondência com o endereço oficial do CEP informado.

Nota: quando o status for CORRECTED, os campos district e state serão preenchidos mesmo que não tenham sido enviados. Quando o status for NORMALIZED, os campos serão retornados com os valores enviados na requisição.

Exemplos completos de requisição e resposta podem ser conferidos no link a seguir: Exemplos.