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



Parses an address into its individual address elements. This is purely a parsing method and it does not validate, correct or verify an address. The operation is useful for parsing street names, suites and other address fragments out of an otherwise undeliverable address. This method can also be used to parse single line addresses.


URL Endpoints

JSON

https://trial.serviceobjects.com/AV3/api.svc/ParseAddress/{ADDRESS}/{ADDRESS2}/{CITY}/{STATE}/{POSTALCODE}/{LICENSEKEY}?format=json

XML

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

 

ParseAddress Inputs


Name

Type

Description

Address

String

Address line of the address to validate or an entire single line address. For example, "123 Main Street" or "123 E Main St Suite 100 Santa Barbara CA 93101"

Address2

String

This line is for address information that does not contribute to the coding of an address. For example "C/O John Smith" does not help validate the address, but is still useful in delivery.

City

String

The city of the address. For example, "New York".

State

String

The state of the address. For example, "NY".  This does not need to be contracted, full state names will work as well.

PostalCode

String

The zip code of the address.

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


ParseAddress Outputs


ParseAddressResponse

Name

Type

Values

Description

AddressFragments

AddressFragments

Varies

The parsed address response.

Error

Error

Varies

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


AddressFragments

Name

Type

Values

Description

Address

String

Varies

The parsed Address line 1.

City

String

Varies

The parsed city name.

State

String

Varies

The parsed state name.

Zip

String

Varies

The parsed zip code.

Address2

String

Varies

The parsed Address line 2.

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




  • No labels