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



Often, users have addresses as a single line of data, which may or may not be separated by commas, slashes, spaces, etc.  For this reason, ValidateAddressSingleLine behaves almost exactly like ValidateAddressWithFragments, but takes all of its input as a single field. 


URL Endpoints


XML

https://trial.serviceobjects.com/av3/api.svc/GetPossibleMatchesSingleLine?Address={ADDRESS}&LicenseKey={LICENSEKEY}


GetPossibleMatchesSingleLine Inputs


Name

Type

Description

Address

String

Entire address to validate. 
For example, "123 Main Street Anytown CA 99999".

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

GetPossibleMatchesSingleLine Outputs


PossibleMatchesResponse 

Name

Type

Values

Description

PossibleMatches

AddressCandidate[]

Varies

The corrected addresses.

Error

Error

Varies

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


AddressCandidate

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

String

Varies

The post office delivery barcode digits.

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

The parsed house number of the given address.

FragmentPreDir

String

Varies

The parsed pre-directional of the address's street.  "North" in "North Main St West".

FragmentStreet

String

Varies

The parsed name of the street in the given address.  "Main" in "North Main St West".

FragmentSuffix

String

Varies

The parsed suffix of the street in the given address.  "St" in "North Main St West".

FragmentPostDir

String

Varies

The parsed post-directional of the address's street.  "West" in "North Main St West".

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

The parsed type of the apartment, box, unit, etc.  For example, "APT" or "BOX".

FragmentPMBNumber

String

Varies

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

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.


References

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


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


  • No labels