Information Components
| Name | Values | Description |
|---|---|---|
| StatusNotes | Varies | Returns additional information about the status of the address when applicable. See Status Notes table for a list of notes and descriptions. |
| LocalAddress1 | Varies | Standardized address line 1 displayed in its local text and format. |
| LocalAddress2 | Varies | Standardized address line 2 displayed in its local text and format. |
| LocalAddress3 | Varies | Standardized address line 3 displayed in its local text and format. |
| LocalAddress4 | Varies | Standardized address line 4 displayed in its local text and format. |
| LocalAddress5 | Varies | Standardized address line 5 displayed in its local text and format. |
| LocalAddress6 | Varies | Standardized address line 6 displayed in its local text and format. |
| LocalAddress7 | Varies | Standardized address line 7 displayed in its local text and format. |
| LocalAddress8 | Varies | Standardized address line 8 displayed in its local text and format. |
| AddressField1 | Varies | Unformatted address line 1. For clients who need to map to a system that performs address formatting for them. |
| AddressField2 | Varies | Unformatted address line 2. For clients who need to map to a system that performs address formatting for them. |
| AddressField3 | Varies | Unformatted address line 3. For clients who need to map to a system that performs address formatting for them. |
| AddressField4 | Varies | Unformatted address line 4. For clients who need to map to a system that performs address formatting for them. |
| AddressField5 | Varies | Unformatted address line 5. For clients who need to map to a system that performs address formatting for them. |
| PremiseNumber | Varies | An alphanumeric code, such as a house or building number. Ex: The number ’27’ in the address line of ’27 E Main St.’ |
| StreetPreDirectional | Varies | The prefix directional is a word preceding the street name that indicates the direction or position of the thoroughfare. Ex: The letter ‘E’ in the address line ’27 E Main St.’ |
| StreetPreType | Varies | The prefix type is a word or phrase that precedes the street name and identifies a type of thoroughfare. Ex: The French word for street ‘Rue’ in the address line ‘239 Rue Angleterre’ |
| StreetName | Varies | The name of the street or thoroughfare. |
| StreetPostType | Varies | The suffix type is a word or phrase that follows the street name and identifies a type of thoroughfare. Ex:The abbreviation ‘Rd.’ in the address line ’15 N Thomas Rd.’ |
| StreetPostDirectional | Varies | A word following the street name that indicates the direction or position of the thoroughfare. |
| SubPremise | Varies | The sub-premise will primarily represent a unit type and number.Ex: Suite 5, Flat 16 or Apartment 9 Depending on the level of data available, the sub-premise unit type may be abbreviated or spelled out completely. |
| DependentStreetPreDirectional | Varies | The prefix directional is a word preceding the street name that indicates the direction or position of the dependent thoroughfare. Ex: The letter ‘E’ in the address line ’27 E Main St.’ |
| DependentStreetPreType | Varies | The prefix type is a word or phrase that precedes the street name and identifies a type of dependent thoroughfare. Ex: The French word for street ‘Rue’ in the address line ‘239 Rue Angleterre’ |
| DependentStreetName | Varies | The name of the sub-street or dependent thoroughfare. |
| DependentStreetPostType | Varies | The suffix type is a word or phrase that follows the street name and identifies a type of dependent thoroughfare. Ex:The abbreviation ‘Rd.’ in the address line ’15 N Thomas Rd.’ |
| DependentStreetPostDirectional | Varies | The prefix directional is a word preceding the street name that indicates the direction or position of the dependent thoroughfare. Ex: The letter ‘E’ in the address line ’27 E Main St.’ |
| DependentLocality | Varies | The dependent locality name. |
| Floor | Varies | The alpha-numeric value for the floor.Ex: The number 4 in ‘Floor 5’ or the letter D in ‘Floor D’ |
| IsPOBox | True False |
Indicates if the address is a PO Box. |
| POBox | Varies | The alpha-numeric value for the PO Box. |
Status Notes
| Status Note | Description |
|---|---|
| SubPremise | Indicates that the sub-premise is valid according to postal data. |
| MaxLineLengthExceeded | Indicates that the length of one or more of the address line fields was too long. |
| PostalCodeFormatInvalid | Indicates that no postal code was found in the input address that matched the given country’s known postal code format. |
| PostalCodeNotFound | Indicates that the postal code was not found in our table of records. This could indicate that the postal code is bad, but it is also possible that we simply do not have it. |
| PostalCodeAndAddressDoNotMatch | Indicates that the postal code was found, but a locality and/or admin area match in the address could not be found. |
| PostalCodeAndAddressPartialMatch | Indicates that the postal code matched the locality and or an admin area. |
| Insufficient or nonsensical input data. | Indicates that the data entered in the Address1-5, Locality, AdministrativeArea, PostalCode and Country fields in its entirety is insufficient to continue with the validation process. Commonly occurs when garbage and/or bogus data is passed in.
Example1 Example2 |
| Address not found | Major issue with address that doesn’t fit known USPS special case scenarios. |
| Multiple addresses match | Several address candidates were found that are equally likely given the input. Ex: “1 Main St” matches “1 E Main St” and “1 W Main St”. |
| Please enter a valid address number. | Input address submitted without primary number. Ex: “Main St, Santa Barbara CA 93101”. |
| Street not found | Street name not found for general area (city/state or zip) |
| Street number or box number out of range | Street name found in area, but the given primary number is not valid for that street |
| Internal error. | Returned when an unexpected error occurs while processing address, or for special address cases. |
| City not found | City name not found for given state or postal code |
| State not found | State abbreviation not found |
| DPV Lockout. Contact Service Objects immediately. | Returned for a specific type of address case known as a false positive. |
| Unable to parse address. | Indicates that the input could not be parsed into address fragments. |