Address Analyzer

Estructura de la respuesta

En la respuesta, tendremos los siguientes campos:

  • label – Texto con la dirección completa en el formato road, number, district, zipcode, city, state, con la sugerencia de corrección aplicada a los campos;
  • road – Texto con la calle. Cuando el status sea CORRECTED, será el nombre oficial sugerido para la calle; en caso contrario, la calle enviada ya estandarizada;
  • number – Texto con el número del inmueble;
  • complement – Texto con el complemento identificado en la dirección enviada;
  • district – Texto con el barrio. Cuando el status sea CORRECTED, será el nombre oficial sugerido para el barrio; en caso contrario, el valor enviado;
  • zipcode – Texto con el CEP, con 8 dígitos y solo números;
  • city – Texto con el municipio. Cuando el status sea CORRECTED, será el nombre oficial sugerido para el municipio; en caso contrario, el valor enviado;
  • state – Texto con la sigla del estado (UF), con 2 letras;
  • matchScore – Número (double) de 0 a 100 que indica el grado de correspondencia entre la calle enviada y la calle oficial del CEP informado. Se devuelve en todos los status;
  • status – Texto que indica el resultado del análisis. Los valores posibles son:
    • CORRECTED – Se encontró una sugerencia de corrección. Los campos road, district, city y state traen los nombres oficiales sugeridos;
    • NORMALIZED – La dirección solo fue estandarizada, sin sugerencia de corrección, porque no fue posible confirmar la correspondencia con la dirección oficial del CEP informado.

Nota: cuando el status sea CORRECTED, los campos district y state se completarán aunque no se hayan enviado. Cuando el status sea NORMALIZED, los campos se devolverán con los valores enviados en la solicitud.

Los ejemplos completos de solicitud y respuesta pueden consultarse en el siguiente enlace: Ejemplos.