Page tree
Skip to end of metadata
Go to start of metadata



Will leverage USPS data and additional data sources

URL Endpoints


JSON: 

https://trial.serviceobjects.com/ad/api.svc/FindOutlyingAddressJson?Address1={ADDRESS1}&Address2={ADDRESS2}&City={CITY}&State={STATE}&PostalCode={POSTALCODE}&LicenseKey={LICENSEKEY}

XML: 

https://trial.serviceobjects.com/ad/api.svc/FindOutlyingAddress?Address1={ADDRESS1}&Address2={ADDRESS2}&City={CITY}&State={STATE}&PostalCode={POSTALCODE}&LicenseKey={LICENSEKEY}


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/products/address/address-detective.


 

FindOutlyingAddress Outputs 


Output Parameter

Type

Values

Description

Addresses

OutlyingAddress[]

Varies
InformationComponentsInformationComponent[]Varies 
Level

String

Varies

The level to which the input address could be verified.

NotesStringVariesNotes that can give information about the validity or existence of an address
NotesDescStringVariesDescriptions 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

NameTypeValuesDescription

Address1

String

Varies

The corrected Address line 1.

Address2StringVariesThe 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]

StringVariesNumber 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

NameTypeValuesDescription
NameStringVariesThe variable name of the Name-Value pair that is to be returned. Usually contains extraneous information like parsed address fields
ValueStringVariesThe resulting value of the of the variable returned in the "Name" field.

*See section on DPV Notes and Corrections for possible values/descriptions

References

  1. ^ CASS and DPV: A Higher Standard for Address Accuracy



  • No labels