Corrigir endereço: exemplos

Neste documento, descrevemos vários cenários reais em que a API Address Validation fornece indicadores de resposta que podem justificar um comportamento de correção do seu sistema. Consulte Exemplos de fluxos de trabalho em Criar sua lógica de validação para mais contexto.

Exemplos comuns: correção

Nesta seção, descrevemos exemplos comuns em que a API Address Validation fornece indicadores de resposta que mostram 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

Veredito para cidade e código postal ausentes

O exemplo abaixo enfatiza os indicadores importantes da resposta.

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

O possibleNextAction fornece uma indicação inicial de que o endereço pode não ser entregue. Os outros componentes destacados também oferecem essa possibilidade. Consulte o 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. Ele retorna todos os outros componentes de endereço como UNCONFIRMED_BUT_PLAUSIBLE, com algumas omissões importantes nos dados, como localidade e código postal.

Número do endereço ausente

Este exemplo mostra um número de rua ausente.

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

Veredito para número do endereço ausente

{
    "inputGranularity": "PREMISE_PROXIMITY",
    "validationGranularity": "ROUTE",
    "geocodeGranularity": "ROUTE",
    "possibleNextAction": "FIX"
}

Mais uma vez, o possibleNextAction fornece uma indicação inicial de que o endereço pode não ser entregue. Além disso, o validationGranularity é ROUTE, o que indica uma correspondência com a rua, mas não há informações suficientes para chegar ao local. Além disso, a propriedade addressComplete está ausente do veredito 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 cenário específico da sua empresa. Os exemplos abaixo ilustram cenários que podem não se enquadrar estritamente em uma categoria de correção.

Número da rua não confirmado

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

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

Veredito para número de rua não confirmado

O exemplo abaixo enfatiza os indicadores importantes.

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

Vale a pena investigar a combinação de uma granularidade de validação apenas para aproximação no nível da premissa 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 consegue encontrar o número 84 no conjunto de dados, e plausível significa que os dados do componente ainda podem ser válidos.

Subpremissa ausente

Esse cenário descreve um endereço que não tem apenas um sublocal, como um número de apartamento ou departamento. Caso contrário, a API Address Validation poderá 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 veredito.

Por exemplo, imagine que um cliente insira um endereço válido para o escritório do assessor da cidade de São Francisco, mas não inclua o número da sala.

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

Veredito para subpremissa ausente

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

{
  "inputGranularity": "PREMISE",
  "validationGranularity": "PREMISE",
  "geocodeGranularity": "PREMISE",
  "hasInferredComponents": true,
  "possibleNextAction": "CONFIRM_ADD_SUBPREMISES"
}

Uma consulta address revela o seguinte:

"missingComponentTypes": [
        "subpremise"
      ]

Após uma consulta mais detalhada, os dados do USPS fornecem um código dpvConfirmation de D, que também indica uma subinstalação ausente.