Returns parsed and validated address elements along with a list of potential secondary numbers for a given input address. The operation can be leveraged in conjunction with the GetBestMatches operation to find secondary numbers for input data that has either missing or incorrect unit information. For an example workflow please see the Workflow section below.
Address line of the address to validate.
The city of the address to validate.
The state of the address to validate. For example, "NY". This does not need to be contracted, full state names will work as well. The state isn't required, but if one is not provided, the Zip code is required.
The zip code of the address to validate. A zip code isn't required, but if one is not provided, the City and State are required.
Your license key to use the service.
The corrected address line 1.
The corrected city name.
|State||String||Varies||The corrected state name.|
|Zip||String||Varies||The corrected zip code + 4.|
|TotalCount||String||Varies||The total number of secondary numbers found for the input address.|
|SecondaryNumbers||String||Varies||A list of possible secondary numbers for the input address.|
Error object indicating why the service could not return a result. See “Errors” below for more information.
Typical Example Workflow
1) Validate an address using the recommended GetBestMatches operation.
2) If GetBestMatches returns a DPV 3 or 4:
The apartment or rural route box number is not valid, although the house number or rural route is valid
The input record is a valid mailing address, but is missing the apartment or rural route box number
3) Get a list of potential secondary numbers using the GetSecondaryNumbers operation.
The example below helps to illustrate how GetBestMatches and GetSecondaryNumbers tie together. The input "Address" field is missing the unit information for the office building.
|Address||27 E Cota St|
GetBestMatches XML Response - DPV 4 - The input record is a valid mailing address, but missing the apartment or rural route box number
GetSecondaryNumbers - 9 different suite options found