This document describes a number of real-world scenarios where the Address Validation API provides response signals that warrant an accept behavior from your system. See Workflow overview in Use the validation response for context.
Common example: accept
This scenario illustrates an address in which your system would accept an address entered by a customer.
Address entered | Region |
---|---|
76 Buckingham Palace Road, London SW1W 9TQ | UK |
Verdict for an acceptable address
The example below highlights the important signals.
{
"inputGranularity": "PREMISE",
"validationGranularity": "PREMISE",
"geocodeGranularity": "PREMISE",
"addressComplete": true
}
In addition to this, the response indicates the following:
hasUnconfirmedComponents
remainsfalse
hasInferredComponents
remainsfalse
hasReplacedComponents
remainsfalse
When combined together, these signals indicate a high-quality address.
Edge case examples: accept
The following examples cover situations in which the verdict
indicates address
quality issues that warrant further investigation. These examples also
illustrate how your logic can travel from the verdict to the address components
to obtain a more complete picture in order to enhance your system logic.
Non-US unconfirmed street number
This example illustrates entry of an Italian address with all address components
present, along with no inferred or replaced components. However, the
validationGranularity
is ROUTE
.
Address entered | Region |
---|---|
Via Fonte Grugnale, 14 unit 2, 66054 Vasto CH, Italia | IT |
Verdict for an unconfirmed street number
{
"inputGranularity": "SUB_PREMISE",
"validationGranularity": "ROUTE",
"geocodeGranularity": "ROUTE",
"addressComplete": true,
"hasUnconfirmedComponents": true
}
Further investigation of the address components reveals that the street
number is UNCONFIRMED_BUT_PLAUSIBLE
.
{
"text": "14",
"componentType": "street_number",
"confirmationLevel": "UNCONFIRMED_BUT_PLAUSIBLE"
}
US unconfirmed street number
This example illustrates entry of a US address with all address components
present, with no inferred or replaced components. However, the
validationGranularity
is PREMISE_PROXIMITY
.
Address entered | Region |
---|---|
975 Carson Dr, Sunnyvale, CA 94086 | US |
USPS data for an unconfirmed street number
{
"firstAddressLine": "975 CARSON DR",
"cityStateZipAddressLine": "SUNNYVALE CA 94086",
"city": "SUNNYVALE",
"state": "CA",
"zipCode": "94086"
"dpvConfirmation": "N",
"dpvFootnote": "AAM3",
"carrierRoute": "C031",
"carrierRouteIndicator": "D",
"postOfficeCity": "SUNNYVALE",
"postOfficeState": "CA",
"fipsCountyCode": "085",
"county": "SANTA CLARA",
}
Incomplete USPS data for a confirmed address
This example illustrates entry of a US address with all address components
confirmed, with no inferred or replaced components, and a
validationGranularity
of PREMISE
. However, the uspsData
is not fully
populated, and does not contain a dpvConfirmation
value.
Address entered | Region |
---|---|
155 Via Condado Way, Palm Beach Gardens, FL 33418-1703 | US |
Verdict for a confirmed address with incomplete USPS data
{
"inputGranularity": "PREMISE",
"validationGranularity": "PREMISE",
"geocodeGranularity": "PREMISE",
"addressComplete": true,
}
USPS data for a confirmed address with incomplete USPS data
{
"standardizedAddress": {
"firstAddressLine": "155 VIA CONDADO WAY",
"cityStateZipAddressLine": "PALM BEACH GARDENS",
"city": "PALM BEACH GARDENS",
"state": "FL",
"zipCode": "33418"
},
"carrierRoute": "H018",
"postOfficeCity": "PALM BEACH GARDENS",
"postOfficeState": "FL"
}