Corrigir endereço: exemplos

Este documento descreve vários cenários reais em que a API Address Validation fornece indicadores de resposta que justificam um comportamento de correção do seu sistema. Os exemplos aqui são ilustrativos, mas não exaustivos. Consulte a Visão geral do fluxo de trabalho em Criar sua lógica de validação para mais contexto.

Exemplos comuns: correção

Esta seção descreve exemplos comuns em que a API Address Validation fornece indicadores de resposta que indicam informações de endereço de qualidade inferior.

Cidade e código postal ausentes

Este exemplo ilustra uma entrada que tem apenas o endereço, sem cidade ou código postal.

Endereço inserido Região
21 45 40th street EUA

Resultado para cidade e código postal ausentes

O exemplo abaixo enfatiza os indicadores importantes da resposta.

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

Esses indicadores indicam um endereço não entregável. Portanto, você pode consultar addressComponents para saber mais:

{
  "componentName": {
    "text": "21",
    "languageCode": "en"
  },
  "componentType": "street_number",
  "confirmationLevel": "UNCONFIRMED_BUT_PLAUSIBLE"
},
{
  "componentName": {
    "text": "45 40th street",
    "languageCode": "en"
  },
  "componentType": "route",
  "confirmationLevel": "UNCONFIRMED_BUT_PLAUSIBLE"
},
{
  "componentName": {
    "text": "United States",
    "languageCode": "en"
  },
  "componentType": "country",
  "confirmationLevel": "CONFIRMED"
}

A API Address Validation retorna apenas o país (Estados Unidos) como CONFIRMED. Ela retorna todos os outros componentes de endereço como UNCONFIRMED_BUT_PLAUSIBLE, com algumas omissões importantes nos dados, como região administrativa e código postal.

Número do endereço ausente

Este exemplo mostra um número de endereço ausente.

Endereço inserido Região
Buckingham Palace Road, SW1W 9TQ London Reino Unido
Resultado para número do endereço ausente
{
    "inputGranularity": "PREMISE_PROXIMITY",
    "validationGranularity": "ROUTE",
    "geocodeGranularity": "ROUTE"
}

O validationGranularity é ROUTE, o que indica uma correspondência com a rua, mas não informações suficientes para chegar ao local. Além disso, a propriedade addressComplete está ausente do resultado e, portanto, é false. Uma consulta adicional do objeto address revela um tipo de componente ausente:

"missingComponentTypes": [
        "street_number"
      ]

Exemplos de casos extremos: correção

Em algumas situações, a correção, confirmação ou aceitação de um endereço depende do seu cenário de negócios específico. Os exemplos abaixo ilustram cenários que podem não se enquadrar estritamente em uma categoria de correção.

Número do endereço não confirmado

Nesse cenário, a API Address Validation não pode confirmar o número do endereço fornecido, mas indica que o endereço está completo.

Endereço inserido Região
84 Buckingham Palace Road, SW1W 9TQ, London Reino Unido

Resultado para número do endereço não confirmado

O exemplo abaixo enfatiza os indicadores importantes.

{
  "inputGranularity": "PREMISE",
  "validationGranularity": "PREMISE_PROXIMITY",
  "geocodeGranularity": "PREMISE_PROXIMITY",
  "addressComplete" : true,
  "hasUnconfirmedComponents": true
}

Vale a pena investigar a combinação de uma granularidade de validação apenas para aproximação no nível do local com componentes não confirmados. Uma consulta da propriedade addressComponents mostra o seguinte componentType não confirmado:

{
  "componentName": {
    "text": "84",
    "languageCode": "en"
  },
  "componentType": "street_number",
  "confirmationLevel": "UNCONFIRMED_BUT_PLAUSIBLE"
}

Aqui, o confirmation_level do street_number está definido como UNCONFIRMED_BUT_PLAUSIBLE. Não confirmado significa que o serviço não pode corresponder ao número do endereço 84 no conjunto de dados, e plausível significa que os dados do componente ainda podem ser válidos.

Sublocal ausente

Esse cenário descreve um endereço que só está faltando um sublocal, como um apartamento ou número de departamento. Caso contrário, a API Address Validation pode validar totalmente o endereço. Como acontece quando qualquer componente de endereço está ausente, o addressComplete é false e, portanto, não está presente na inspeção manual do resultado.

Para ilustrar, suponha que um cliente insira um endereço válido para o escritório do avaliador da cidade de São Francisco, mas perca o número do quarto na entrada.

Endereço inserido Região
1 Doctor Carlton B Goodlett Place, San Francisco, CA 94102 EUA

Resultado para sublocal ausente

Neste exemplo, o resultado não mostra a propriedade addressComplete e, portanto, ela é false. Por isso, você sabe que pelo menos um elemento de endereço é inesperado, não resolvido ou ausente.

{
  "inputGranularity": "PREMISE",
  "validationGranularity": "PREMISE",
  "geocodeGranularity": "PREMISE",
  "hasInferredComponents": true

}

Uma consulta address revela o seguinte:

"missingComponentTypes": [
        "subpremise"
      ]

Após mais consultas, os dados do USPS fornecem um código dpvConfirmation de D, que também indica um sublocal ausente.