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



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. Since we can't be 100% certain that what we get from name or phone data will be the address you're looking for, a confidence score (matchrate) from 1-100 will be provided. This score goes up when, say, we see the same address turn up several times with your input clues. Or if an address we found is in the same general city/state or zip area as the one provided in the bad input address.  As well, the matchrate gives some indication of risk for addresses that need to be drastically changed so it is based on both of these factors.


URL Endpoints


JSON: 

https://trial.serviceobjects.com/AD/api.svc/FindAddressJson?Address1={ADDRESS1}&Address2={ADDRESS2}&City={CITY}&State={STATE}&PostalCode={POSTALCODE}&BusinessName={BUSINESSNAME}&PhoneNumber={PHONENUMBER}&FullName={FULLNAME}&Firstname={FIRSTNAME}&LastName={LASTNAME}&LicenseKey={LICENSEKEY}

XML: 

https://trial.serviceobjects.com/AD/api.svc/FindAddress?Address1={ADDRESS1}&Address2={ADDRESS2}&City={CITY}&State={STATE}&PostalCode={POSTALCODE}&BusinessName={BUSINESSNAME}&PhoneNumber={PHONENUMBER}&FullName={FULLNAME}&Firstname={FIRSTNAME}&LastName={LASTNAME}&LicenseKey={LICENSEKEY}


FindAddress Inputs


Name

Type

Description

Address1

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.

BusinessNameStringIf this is a business address, add the business name here. It can help with the identification of a proper address.
PhoneNumberString

The 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*

String

Your license key to use the service.  
Sign up for a free trial key at 
https://www.serviceobjects.com/products/address/address-detective



FindAddress Outputs 


Name

Type

Values

Description

Addresses

FixedAddress[]

Varies

The corrected address candidates.

Errors

String

Varies

Error object indicating why the service could not return a result. See “Errors” page for more information.


FixedAddress

Name

Type

Values

Description

Address

String

Varies

The corrected Address line 1.

City

String

Varies

The corrected city name.

State

String

Varies

The corrected state name.

Zip

String

Varies

The 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

Barcode Example: 931011445011

931011445011
Zip+4Deliver Point Code Checksum Digit
   

CarrierRoute

String

Varies

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

Varies

The congress code of the given address.

CountyCode

String

Varies

The county code of the given address.

CountyName

String

Varies

The name of the county in which the given address lies.

FragmentHouse

String

Varies

123 in 123 North Main St West Apt A


FragmentPreDir

String

Varies

North in 123 North Main St West Apt A


FragmentStreet

String

Varies

Main in 123 North Main St West Apt A


FragmentSuffix

String

Varies

St in 123 North Main St West Apt A


FragmentPostDir

String

Varies

West in 123 North Main St West Apt A


FragmentUnit

String

Varies

The parsed unit type (e.g. "Apt" or "Ste")

FragmentStringVariesThe parsed "Fragment" box, apartment or unit number. Same as FragmentPMBNumber.

FragmentPMBPrefix

String

Varies

Apt in 123 North Main St West Apt A


FragmentPMBNumber

String

Varies

A in 123 North Main St West Apt A


MatchRate

String

Varies

A confidence score from 1-100 will be provided. This score goes up when, say, we see the same address turn up several times with your input clues. Or if an address we found is in the same general city/state or zip area as the one provided in the bad input address.  As well, the matchrate gives some indication of risk for addresses that need to be drastically changed so it is based on both of these factors.



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

References

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

  2. ^ Delivery Point Validation Explained

  3. ^ Address Deduplication Using USPS Barcodes



  • No labels