Corrigir endereço: exemplos

Este documento descreve vários cenários reais em que a API Address Validation fornece sinais de resposta que garantem um comportamento de correção do sistema. Consulte a Visão geral do fluxo de trabalho em Criar sua lógica de validação para entender o contexto.

Exemplos comuns: fix

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

Cidade e CEP 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 CEP 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. Para saber mais, consulte o addressComponents:

{
  "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 do endereço como UNCONFIRMED_BUT_PLAUSIBLE, com algumas omissões importantes nos dados, como localidade e código postal.

Número da rua ausente

Este exemplo mostra um número de rua ausente.

Endereço inserido Região
Buckingham Palace Road, SW1W 9TQ Londres Reino Unido
Veredito sobre a falta do número da rua
{
    "inputGranularity": "PREMISE_PROXIMITY",
    "validationGranularity": "ROUTE",
    "geocodeGranularity": "ROUTE"
}

O validationGranularity é ROUTE, o que indica uma correspondência com a rua, mas não há informações suficientes para chegar à premissa. 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 seu cenário de negócios. Os exemplos abaixo ilustram cenários que podem não se enquadrar em uma categoria fixa.

Número da rua não confirmado

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

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

Veredito para o 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
}

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 é definido como UNCONFIRMED_BUT_PLAUSIBLE. Não confirmada significa que o serviço não pode 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.

Subpremissa ausente

Este cenário descreve um endereço que só está faltando uma subpredial, como um apartamento ou número de 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.

Para ilustrar, suponha que um cliente insira um endereço válido para o escritório do assessor da cidade de São Paulo, mas esqueça o número do apartamento.

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

Veredicto para subpremise ausente

Neste exemplo, o veredito não mostra a propriedade addressComplete, portanto, ele é 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 uma consulta mais detalhada, os dados dos Correios fornecem um código dpvConfirmation de D, que também indica uma subpremissor ausente.