Returns parsed and validated address elements. This operation’s primary concern is to return an address to you if your input address fails. If your input address is valid, then the service is done and the validated and standardized address is returned. Additional data source results will not override the address found from your inputs.  Any found addresses should match in some way to the input address.

If your address could not be found by USPS, we will use the additional clues like Phone and Name to try to return the “correct” address to you. 

URL Endpoints

FindAddress Inputs

NameTypeDescription
Address1StringAddress line of the address to validate.  
For example, “123 Main Street”.
Address2StringThis 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.
CityStringThe 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.
StateStringThe 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.
PostalCodeStringThe 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.
BusinessNameStringIf this is a business address, add the business name here. It can help with the identification of a proper address.
PhoneNumberStringThe phone number for the contact.
FullNameStringIf you don’t have first and last names parsed separately, you can instead place the full name into this field for parsing.
FirstNameStringIf you have first and last names separated, place the first name here.
LastNameStringIf you have first and last names separated, place the last name here.
LicenseKey*StringYour license key to use the service.  
Sign up for a free trial key at 
https://www.serviceobjects.com/address-detective/

FindAddress Outputs 

NameTypeValuesDescription
AddressesFixedAddress[]VariesThe corrected address candidates.
ErrorsStringVariesError object indicating why the service could not return a result. See “Errors” page for more information.
NameTypeValuesDescription
AddressStringVariesThe corrected Address line 1.
CityStringVariesThe corrected city name.
StateStringVariesThe corrected state name.
ZipStringVariesThe corrected zip code + 4.
DPV* [1] [2]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.
DPVDesc*StringVariesA description of the DPV number.
DPVNotes*StringVariesNumber that correlates to DPV notes description. Service Objects may add or change Note
descriptions, but will never modify existing codes.
DPVNotesDesc*StringVariesDetails about the DPV result. Service Objects may add or change Note descriptions, but will never
modify existing codes.
Corrections*StringVariesNumber that correlates to a Corrections Description. Service Objects may add or change Correction
descriptions, but will never modify existing codes.
CorrectionsDesc*StringVariesDescription of what was corrected in an address. Linked to the Corrections number. Service Objects
may add or change Correction descriptions, but will never modify existing codes.
NotesStringVariesNot currently used.
NotesDescStringVariesNot currently used.
BarcodeDigits [3]StringVaries

The post office delivery barcode digits.

Barcode Example: 931011445011

931011445011
Zip+4Deliver Point CodeChecksum Digit
CarrierRouteStringVaries4 chars: 1 for the route type, 3 for the route code. Identifies a group of addresses when prepended
by 5-digit Zip.
CongressCodeStringVariesThe congress code of the given address.
CountyCodeStringVariesThe county code of the given address.
CountyNameStringVariesThe name of the county in which the given address lies.
FragmentHouseStringVaries

The parsed house number of the given address.

123 in 123 North Main St West Apt A

FragmentPreDirStringVaries

The parsed pre-directional of the address's street.

North in 123 North Main St West Apt A

FragmentStreetStringVaries

The parsed name of the street in the given address.

Main in 123 North Main St West Apt A

FragmentSuffixStringVaries

The parsed suffix of the street in the given address.

St in 123 North Main St West Apt A

FragmentPostDirStringVaries

The parsed post-directional of the address's street.

West in 123 North Main St West Apt A

FragmentUnitStringVariesThe parsed unit type (e.g. “Apt” or “Ste”)
FragmentStringVariesThe parsed “Fragment” box, apartment or unit number. Same as FragmentPMBNumber.
FragmentPMBPrefixStringVaries

The parsed type of the apartment, box, unit, etc.

Apt in 123 North Main St West Apt A

FragmentPMBNumberStringVaries

The parsed apartment, box, unit, etc. number of the given address.

A in 123 North Main St West Apt A

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

References