Returns parsed and validated address elements including Delivery Point Validation (DPV), Residential Delivery Indicator (RDI), and Suite data. ValidateAddress will attempt to validate the input address against a CASS approved engine and make corrections where possible. Depending on the mode being used, in addition to the USPS data source, supplemental data sources are employed to help validate addresses. Mode 3 also incorporates person name and phone number to assist with validation. The service easily integrated using our OpenAPI specification or simply by making REST calls to the operation. The response structure in the REST calls is of JSON format.

 

URL Endpoints

ValidateAddress Inputs

Name Type Required Description
Mode String Yes Mode 1 – is for doing the standard validation as it always has with USPS datasets and expert address validation techniques.
Mode 2 – uses standard rules plus aggregated non-USPS datasets.
Mode 3 – enhanced rules plus name and phone assisted address nudging, using proprietary data.
Address1 String Yes The address line 1 of the contact or business address.
Address2 String No The address line 2 of the contact or business address.
City String No The city of the address to validate.
For example, “Austin”. The city isn’t required, but if one is not provided, the ZIP code is required.
State String No The state of the address to validate. For example, “TX”. 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.
ZIP String No 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.
BusinessName String No A company name for a business, can provide additional insight to the location or append a SuiteLink value.
FullName String No (Not currently applicable) FUTURE FEATURE.
FirstName String No Contact’s first name. (Only applicable in mode 3)
MiddleName String No Contact’s middle name. (Only applicable in mode 3)
LastName String No Contact’s last name. (Only applicable in mode 3)
PhoneNumber String No The phone number for the contact associated with the address. (Only applicable in mode 3)
Options String No (Not currently applicable) FUTURE FEATURE.
AuthID String No License key to use the service.

ValidateAddress Outputs

ValidateAddressResponse
Name Type Values Description
status string OK
NotFound
Ambiguous		 The status is the overall level of what were able to determine during the validation process. See Status.
addresses AddressInfo[] Array of AddressInfo objects Returns an array of AddressInfo, which contains the details for the validated address. In most cases only one address should be returned, but in cases of ambiguity multiple AddressInfo objects will be returned. Even though this is a verification service first and foremost, it is considered a value add to return the list of ambiguous addresses to the end user for them to decide on how they would like to proceed.
parsedInput ParsedInputInfo A single object type This is the parsing of the inputs sent to the operation for validation.
AddressInfo
Name Type Values Description
rating String 0-100 The A 0-100 confidence score representing the percent likelihood that the address is a good one for the validationType that it was matched on.
validationType String AddressGood
PrimaryGood
BlockGood
StreetGood
AreaGood		 Indicates the level at which the address was validated. See Validation Types.
address String Varies The corrected and standardized first line of the given address.
addressExtra String Varies Extraneous input address information that is NOT part of the standardized address but may provide extra insight.
city String Varies The corrected and standardized city of the given address.
state String 2 character code (XX) The corrected and standardized state of the given address.
zip String 9 digit number(XXXXX-XXXX) The corrected and standardized nine digit ZIP code of the given address.
countyName String Varies The county name of the given address.
primaryNumber String Varies The parsed house number of the given address.
preDirectional String Varies The parsed pre-directional of the address’s street. “North” in “North Main St West”.
postDirectional String N,S,E,W, NW,NE,SW,SE The parsed post-directional of the address’s street. “West” in “North Main St West”.
streetName String Varies The parsed name of the street in the given address. “Main” in “North Main St West”.
streetSuffix String Varies The parsed suffix of the street in the given address. “St” in “North Main St West”.
secondaryType String Varies The parsed type of the apartment, box, unit, etc. “Apt” in “Main St, Apt B”.
secondaryNumber String Varies TThe parsed apartment, box, unit, etc. number of the given address. “B” in “Main St, Apt B”.
pmbType String Varies The parsed type of personal mail box. “PMB” in “Main St, Apt B PMB 150”.
pmbNumber String Varies The parsed number of the personal mailbox. “150” in “Main St, Apt B PMB 150”.
barcodeDigits String 12 digit number The twelve digit post office delivery barcode digits.
carrierRoute String 4 character code (XXXX) 4 chars: 1 for the route type, 3 for the route code. Identifies a group of addresses when prepended by 5-digit ZIP.
congressCode String 2 character code (XX) The congress code of the given address.
addressNotes List of mixed types Varies This is a list of notes about the address and attributes associated to it as well as indicators that show what was corrected or removed during validation. See Address Notes table below for more detailed description. Address notes can have potential of additions in the future.
ParsedInputInfo
Name Type Values Description
address String Varies The first line of the input address.
addressExtra String Varies Extraneous input address information.
city String Varies The city of the input address.
state String Varies The state of the input address.
zip String Varies The ZIP code of the input address.
primaryNumber String Varies The parsed house number of the input address.
preDirectional String Varies The parsed pre-directional of the input address’s street. “North” in “North Main St West”.
postDirectional String N,S,E,W, NW,NE,SW,SE The parsed post-directional of the input address’s street. “West” in “North Main St West”.
streetName String Varies The parsed name of the street in the input address. “Main” in “North Main St West”.
streetSuffix String Varies The parsed suffix of the street in the input address. “St” in “North Main St West”.
secondaryType String Varies The parsed type of the input apartment, box, unit, etc. “Apt” in “Main St, Apt B”.
secondaryNumber String Varies The parsed apartment, box, unit, etc. number of the input address. “B” in “Main St, Apt B”.
phoneNumber String Varies The input phone number.
firstName String Varies The parsed input first name.
middleName String Varies The parsed input middle name.
lastName String Varies The parsed input last name.