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



This operation is almost exactly like ValidateAddressWithFragments, but may return multiple address with fragments.


URL Endpoints


XML

https://trial.serviceobjects.com/AV3/api.svc/GetPossibleMatches?Address={ADDRESS}&Address2={ADDRESS2}&City={CITY}&State={STATE}&PostalCode={POSTALCODE}&LicenseKey={LICENSEKEY}


GetPossibleMatches Inputs


Name

Type

Description

Address

String

Address line of the address to validate. 
For example, "123 Main Street".

Address2

String

The Address2 of the address to validate.  This will only be used in particular situations where the Address1 does not help in validating the address.

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-geocoding/usps-address-validation

GetPossibleMatches Outputs


PossibleMatchesResponse

Name

Type

Values

Description

PossibleMatches

PossibleMatches

Varies

The possible matches address candidates.

Error

Error

Varies

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

PossibleMatches

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.

Address2

String

Varies

The corrected Address line 2.

BarcodeDigits [1]

String

Varies

Barcode Example: 931011445011

931011445011
Zip+4Deliver Point Code Checksum Digit
   

CarrierRoute

String

4 chars

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 is the congressional district number.

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


String

1-4

Number that correlates to a DPV result.

DPVDesc

String

Varies

Explains DPV result.

DPVNotes

String

1-14

Number that correlates to DPV notes description.

DPVNotesDesc

String

Varies

Details about the DPV result.

Corrections

String

1-43

Number that correlates to a Corrections Description.

CorrectionsDesc

String

Varies

Description of what was corrected in an address.


Important Note!
Output node PossibleMatches may contain many AddressCandidate nodes which contain the outputs described above.



References

  1. ^ Address Deduplication Using USPS Barcodes

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


  • No labels