Corrigir endereço: exemplos

Este documento descreve 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 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 CEP ausentes

Este exemplo ilustra uma entrada com apenas o endereço da rua, sem cidade ou CEP.

Verificação para cidade e CEP 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 entregável. Os outros componentes destacados também oferecem suporte a essa possibilidade. Consulte a 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 CEP.

Número da rua ausente

Este exemplo mostra um número de rua ausente.

Verificação 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 informações suficientes para chegar ao local. Além disso, a propriedade addressComplete está ausente do veredicto e, portanto, é false. Outra consulta do objeto address revela um tipo de componente ausente:

"missingComponentTypes": [
        "street_number"
      ]

Exemplos de casos extremos: correção

Em algumas situações, a decisão de corrigir, confirmar ou aceitar 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.

Verificação para número da 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 os seguintes componentType não confirmados:

{
  "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 corresponder ao número da rua 84 no conjunto de dados, e plausível significa que os dados do componente ainda podem ser válidos.

Subpremio ausente

Este cenário descreve um endereço que só não tem um sublocal, como um número de apartamento ou departamento. Caso contrário, a API Address Validation poderá validar o endereço por completo. Assim como acontece quando um componente de endereço está faltando, o addressComplete é false e, portanto, não está presente na inspeção manual do veredito.

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

Verificação para subpremissa ausente

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

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

Uma consulta de address revela o seguinte:

"missingComponentTypes": [
        "subpremise"
      ]

Após mais consultas, os dados dos Correios fornecem um código dpvConfirmation de D, que também indica uma subpremissa ausente.