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/ValidateAddressSingleLine?Address={ADDRESS}&LicenseKey={LICENSEKEY}

ValidateAddressSingleLine 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

ValidateAddressSingleLine Outputs


DPVAddressResponse 

Name

Type

Values

Description

DPVAddress

DPVAddress

Varies

The corrected address.

Error

Error

Varies

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


DPVAddress

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(Delivery Point Validation) result. An indicator displaying whether or not the address is recognized as deliverable by the USPS.

DPVDesc

String

Varies

Explains DPV result.

DPVNotes

String

Varies

Number that correlates to DPV notes description. Service Objects may add or change Note descriptions, but will never modify existing codes.

DPVNotesDesc

String

Varies

Details about the DPV result. Service Objects may add or change Note descriptions, but will never modify existing codes.

Corrections

String

Varies

Number that correlates to a Corrections Description. Service Objects may add or change Correction descriptions, but will never modify existing codes.

CorrectionsDesc

String

Varies

Description of what was corrected in an address. Service Objects may add or change Correction descriptions, but will never modify existing codes.


References

  1. ^ Address Deduplication Using USPS Barcodes

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




  • No labels