Returns parsed and validated address elements including Delivery Point Validation (DPV), Residential Delivery Indicator (RDI), and Suite data. GetBestMatches will attempt to validate the input address against a CASS approved engine, and make corrections where possible. Multiple address candidates may be returned if a definitive decision cannot be made by the service.

NameTypeDescription
BusinessNameStringName of business associated with this address. Used to append Suite data.
AddressStringAddress 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.
LicenseKey*StringYour license key to use the service.  
Sign up for a free trial key at https://www.serviceobjects.com/address-validation/

BestMatchesResponse

NameTypeValuesDescription
AddressesAddress[]VariesThe corrected address candidates.
IsCASSString“true” or “false”Indicates if the unaltered input address is CASS certified. See “What is CASS?” below for more information.
ErrorErrorVariesError object indicating why the service could not return a result. See “Errors” below for more information.

Address

NameTypeValuesDescription
Address1StringVariesThe corrected address line 1.
Address2StringVariesThe corrected address line 2.
CityStringVariesThe corrected city name.
StateStringVariesThe corrected state name.
ZipStringVariesThe corrected zip code + 4.
IsResidentialString“true” or “false”Indicates if the address is for a residence.
DPV [1]String1-4Number that correlates to a DPV(Delivery Point Validation) result. An indicator displaying whether or not the address is recognized as deliverable by the USPS.
DPVDescStringVariesExplains DPV result.
DPVNotesStringVariesNumber that correlates to DPV notes description. Service Objects may add or change Note descriptions, but will never modify existing codes.
DPVNotesDescStringVariesDetails about the DPV result. Service Objects may add or change Note descriptions, but will never modify existing codes.
CorrectionsStringVariesNumber that correlates to a Corrections Description. Service Objects may add or change Correction descriptions, but will never modify existing codes.
CorrectionsDescStringVariesDescription of what was corrected in an address. Service Objects may add or change Correction descriptions, but will never modify existing codes.
BarcodeDigits [2]StringVaries

The post office delivery barcode digits.

Barcode Example: 931011445011

931011445011
Zip+4Deliver Point CodeChecksum Digit
CarrierRouteString4 chars4 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 is the congressional district number.
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.
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.

123 in 123 North Main St West Apt A