Comprende la respuesta básica de validación de la dirección

La API de Address Validation proporciona un cuerpo de respuesta como un objeto JSON que contiene dos propiedades de nivel superior:

• result, un objeto de tipo ValidationResult
• responseID

{
  "result": {
    // Validation verdict.
    "verdict": {},
    // Address details determined by the API.
    "address": {},
    // The geocode generated for the input address.
    "geocode": {},
    // Information indicating if the address is a business, residence, etc.
    "metadata": {},
    // Information about the address from the US Postal Service
    // ("US" and "PR" addresses only).
    "uspsData": {},
  },
  // A unique identifier generated for every request to the API.
  "responseId": "ID"
}

Este documento se enfoca en el objeto result. Para obtener información sobre responseID, consulta Cómo administrar direcciones actualizadas.

La propiedad verdict

La propiedad verdict resume los resultados de la validación de direcciones y debe ser la primera propiedad que se evalúe cuando se compila la lógica de verificación de dirección. La propiedad puede mostrar una variedad de campos, según la calidad de la dirección de salida. Por ejemplo, a continuación, se muestra la propiedad verdict de una dirección de buena calidad, que muestra 4 campos para esta solicitud en particular:

"verdict": {
  "inputGranularity": "PREMISE",
  "validationGranularity": "PREMISE",
  "geocodeGranularity": "PREMISE",
  "addressComplete": true
}

En las siguientes secciones, se resumen todos los campos de la propiedad verdict.

Consulta el Veredicto en la guía de referencia.

Nivel de detalle de la dirección

El nivel de detalle de la dirección hace referencia al nivel de detalle que se usa para determinar la especificidad de una dirección o un geocódigo. La especificidad de la dirección en la respuesta validationGranularity es un indicador clave de si una dirección es o no entregable.

La propiedad verdict muestra estos indicadores de nivel de detalle:

• inputGranularity: Describe el nivel de detalle capturado a partir de la dirección enviada a la API de Address Validation. El nivel de detalle de la dirección en la solicitud influye en el nivel de detalle de la dirección en la respuesta de validación. Por ejemplo, una dirección con un inputGranularity por debajo del nivel PREMISE no suele dar como resultado un validationGranularity a un nivel PREMISE.
• validationGranularity: Es el nivel de detalle en el que la API de Address Validation puede validar por completo la dirección. En la mayoría de los casos, un nivel de detalle de PREMISE o SUB_PREMISE indica una dirección de calidad que probablemente se pueda entregar.
• geocodeGranularity: Describe el nivel de detalle del geocódigo asociado con la dirección. Por ejemplo, los registros de Google pueden indicar la existencia de un número de departamento, pero no una ubicación precisa para ese departamento en particular dentro de un gran complejo de departamentos. En ese caso, validationGranularity es SUB_PREMISE, pero geocodeGranularityisPREMISE`.

Consulta el Nivel de detalle en la guía de referencia.

Integridad de la dirección

El veredicto muestra la propiedad addressComplete como un indicador para una dirección de alta calidad, lo que significa, en particular, que no tiene componentes faltantes, sin resolver o inesperados:

"verdict": {
    "inputGranularity": "PREMISE",
    "validationGranularity": "PREMISE",
    "geocodeGranularity": "PREMISE",
    "addressComplete": true
}

Cuando la dirección tiene componentes faltantes, sin resolver o inesperados, el campo se establece en false.

Consulta addressComplete en Veredicto y Dirección en la guía de referencia.

Calidad de la dirección

Varios campos posibles indican problemas con los componentes de la dirección o ajustes a ellos, como componentes de dirección inferidos o faltantes. Por ejemplo, la siguiente propiedad verdict indica una dirección con componentes sin confirmar y un campo addressComplete faltante:

"verdict": {
    "inputGranularity": "PREMISE",
    "validationGranularity": "OTHER",
    "geocodeGranularity": "OTHER",
    "hasUnconfirmedComponents": true,
    "hasInferredComponents": true
}

Consulta el Veredicto en la guía de referencia.

Las propiedades address y addressComponent

La propiedad address da formato a la dirección procesada que se proporciona en la solicitud, junto con resúmenes a nivel de los componentes de la dirección, como las partes mal escritas de la dirección, el reemplazo de partes incorrectas y las partes faltantes inferidas.

Consulta Address en la guía de referencia.

La propiedad addressComponent es un subcomponente de address que proporciona una lista detallada de los elementos (o componentes) de la dirección que procesó la API de Address Validation. La API identifica cada componente que proporciona el campo por su nombre, tipo y nivel de confirmación.

Consulta addressComponent en la guía de referencia.

La propiedad geocode

La propiedad geocode indica la ubicación geocodificada asociada con la dirección de entrada. Esta propiedad proporciona detalles sobre la ubicación, como el ID de lugar.

Consulta Geocode en la guía de referencia.

La propiedad metadata

Es posible que esta propiedad no se complete para todas las direcciones que procesa la API de Address Validation, pero indica si la dirección es residencial, comercial o un apartado postal.

Consulta Cobertura de la API de Address Validation y la referencia para Address metadata.

La propiedad uspsData

Esta propiedad proporciona información útil sobre las direcciones postales de Estados Unidos. Sin embargo, no se garantiza que se propaguen por completo para cada dirección validada por el servicio. Por ese motivo, no debes confiar en esta propiedad como el único medio para validar direcciones, sino que también debes verificar verdict y address.

Consulta Cómo administrar direcciones de Estados Unidos y la referencia de UspsData.