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



This operation has the same functionality as FindAddress with the exception that the parameters can be entered on any line, in any order into the input fields and an address will successfully validate. This operation can be used to validate messy or ambiguous address data and will attempt to find the correct address information before validating.

URL Endpoints

JSON: 

https://trial.serviceobjects.com/ad/api.svc/FindAddressLinesJson?Line1={LINE1}&Line2={LINE2}&Line3={LINE3}&Line4={LINE4}&Line5={LINE5}&Line6={LINE6}&Line7={LINE7}&Line8={LINE8}&Line9={LINE9}&Line10={LINE10}&LicenseKey={LICENSEKEY}

XML: 

https://trial.serviceobjects.com/ad/api.svc/FindAddressLines?Line1={LINE1}&Line2={LINE2}&Line3={LINE3}&Line4={LINE4}&Line5={LINE5}&Line6={LINE6}&Line7={LINE7}&Line8={LINE8}&Line9={LINE9}&Line10={LINE10}&LicenseKey={LICENSEKEY}


FindAddressLines Inputs


Name

Type

Description

Line1 to Line10

String

Address input field. This can be any of the inputs in that would be used for FindAddress.

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.


 

FindAddressLines Outputs 


Output Parameter

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]

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 [2]

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 score representing the quality of the returned address information.


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

References

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

  2. ^ Address Deduplication Using USPS Barcodes



  • No labels