Neste documento, descrevemos vários cenários reais em que a API Address Validation fornece sinais de resposta que garantem uma fix do comportamento do seu sistema. Consulte Visão geral do fluxo de trabalho em Criar sua lógica de validação para ter mais contexto.
Exemplos comuns: correção
Nesta seção, descrevemos exemplos comuns de onde a API Address Validation fornece sinais de resposta indicando informações de endereço de qualidade inferior.
Cidade e código postal ausentes
Este exemplo ilustra uma entrada com apenas o endereço, sem cidade ou CEP.
Endereço inserido | Região |
---|---|
Avenida Brasil, 123 | EUA |
Veredito da cidade e código postal ausentes
O exemplo abaixo enfatiza os sinais importantes da resposta.
{
"inputGranularity": "PREMISE",
"validationGranularity": "OTHER",
"geocodeGranularity": "OTHER",
"hasUnconfirmedComponents": true
}
Esses indicadores indicam um endereço que não pode ser entregue. Assim, você pode consultar 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 região administrativa 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 do 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 há informações suficientes para chegar à premissa. Além disso, a
propriedade addressComplete
está ausente no veredito e, portanto, é
false
. Uma 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 correção, confirmação ou aceitação de um endereço depende do cenário 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 não confirmado da rua
O exemplo abaixo enfatiza os sinais 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 à 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 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á sem um sublocal, como um número de apartamento ou departamento. Caso contrário, a API Address Validation pode validar
totalmente o endereço. Como acontece quando algum 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 avaliador da cidade de São Francisco, mas perca o número da sala na entrada.
Endereço inserido | Região |
---|---|
1 Doctor Carlton B Goodlett Place, São Francisco, CA 94102 | EUA |
Veredito da 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 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 do USPS fornecem um código dpvConfirmation
de
D
, que também indica um sublocal ausente.