Will leverage USPS data and additional data sources
URL Endpoints
- JSON:
- XML:
FindOutlyingAddress Inputs
Name | Type | Description |
---|---|---|
Address | String | Address line of the address to validate. For example, “123 Main Street”. |
Address2 | String | This line is for address information that does not contribute to DPV coding an address. For example “C/O John Smith” does not help validate the address, but is still useful in delivery. |
City | String | The city of the address to validate. For example, “New York”. The city isn’t required, but if one is not provided, the Zip code is required. |
State | String | 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. |
PostalCode | String | 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. |
LicenseKey* | String | Your license key to use the service. Sign up for a free trial key at https://www.serviceobjects.com/address-detective/ |
FindOutlyingAddress Outputs
Output Parameter | Type | Values | Description |
---|---|---|---|
Addresses | OutlyingAddress[] | Varies | |
InformationComponents | InformationComponent[] | Varies | |
Level | String | Varies | The level to which the input address could be verified. |
Notes | String | Varies | Notes that can give information about the validity or existence of an address |
NotesDesc | String | Varies | Descriptions of the Notes given in the notes field. |
Error | Error | Varies | Error object indicating why the service could not return a result. See “Errors” page for more information. |
- OutlyingAddress
Name | Type | Values | Description |
---|---|---|---|
Address1 | String | Varies | The corrected Address line 1. |
Address2 | String | Varies | The corrected Address line 2. |
City | String | Varies | The corrected city name. |
State | String | Varies | The corrected state name. |
Postal Code | String | Varies | The corrected zip code + 4. |
DPV [1] | String | Varies | Number that correlates to a DPV(Delivery Point Validation) result. An indicator displaying whether or not the address is recognized as deliverable by the USPS. |
- InformationComponent
Name | Type | Values | Description |
---|---|---|---|
Name | String | Varies | The variable name of the Name-Value pair that is to be returned. Usually contains extraneous information like parsed address fields |
Value | String | Varies | The resulting value of the of the variable returned in the “Name” field. |
References
- ^ CASS and DPV: A Higher Standard for Address Accuracy