Global Address Object:Output Parameters

← Global Address Object Reference

Though they are listed in mixed case, the parameters are not case sensitive.

Output Detail Parameters

buildNumber

Build number of the Global Address Object API.

databaseDate

Release date of the database.

databaseExpirationDate

Expiration date of the database.

dst

A true/false value delineating if the given address is in a time zone that supports Daylight Savings Time (DST).

initializeErrorString

An error string detailing any failure or error in initializing the reference data file(s) and/or Global Address Object.

licenseStringExpirationDate

Expiration date for the License Key set with SetLicenseString.

remnants

Any elements parsed from the input address data which could not be processed or were not relevant to the address processing are returned in the remnant parameter.

resultCodes

Result code(s) generated for the address.

Reference Global Address Object Result Codes for more information.

timezone

Name of the timezone of the address.

utc

Coordinated Universal Time (Universal Time Coordinated). Code that designates the UTC offset for the given time zone of the address. This does not indicate differences due to daylight savings time.

Output Address Parameters

organization

This is a string value that matches the Organization request element. It is not modified or populated by the service.

US Term: Business or Company

addressLine1

These are the string values that will return the standardized or corrected contents of the input address. These lines will include the entire address including the locality, administrative area, and postal code.

addressLine2

These are the string values that will return the standardized or corrected contents of the input address. These lines will include the entire address including the locality, administrative area, and postal code.

addressLine3

These are the string values that will return the standardized or corrected contents of the input address. These lines will include the entire address including the locality, administrative area, and postal code.

addressLine4

These are the string values that will return the standardized or corrected contents of the input address. These lines will include the entire address including the locality, administrative area, and postal code.

addressLine5

These are the string values that will return the standardized or corrected contents of the input address. These lines will include the entire address including the locality, administrative area, and postal code.

addressLine6

These are the string values that will return the standardized or corrected contents of the input address. These lines will include the entire address including the locality, administrative area, and postal code.

addressLine7

These are the string values that will return the standardized or corrected contents of the input address. These lines will include the entire address including the locality, administrative area, and postal code.

addressLine8

These are the string values that will return the standardized or corrected contents of the input address. These lines will include the entire address including the locality, administrative area, and postal code.

deliveryLine

The delivery portion of the full address, from the sub-premise and house number to the dependent locality. Does not include area information like locality, administrative area, and postal code.

localityLine

The locality information of the full address. This includes information such as locality, administrative area, and postal code. Does not include sub-premise and house number to the dependent locality.

formattedAddress

Mailing address. The full mailing address in the preferred format for the country of the address. This includes the Organization as the first line, one or more lines in the origin country’s format, and the destination country (if required). Separate lines will be delimited by what is specified in the option.

Parsed Sub-Premises Parameters

building

Descriptive name identifying an individual location. This is a string value that is the parsed Building element from the output.

subBuilding

Descriptive name identifying an individual location. More specific than building. This is a string value that is the parsed premisesType parameter from the output.

subBuildingNumber

Sub building number indicator within building field. Parsed from the subBuilding parameter.

subBuildingType

Sub building type indicator within building field. Parsed from the subBuilding parameter.

subPremises

Alphanumeric code identifying an individual location. More specific than premises.

US Term: Suite

subPremisesNumber

Sub premises number indicator within premises field. Parsed from the subPremises parameter.

US Term: Suite Number

subPremisesType

Sub premises type indicator within premises field. Parsed from the subPremises parameter.

US Term: Suite Name

subPremisesLevel

Alphanumeric code identifying an individual location. More specific than sub premises.

subPremisesLevelNumber

Sub premises level number indicator within premises field. Parsed from the subPremisesLevel parameter.

subPremisesLevelType

Sub premises level type indicator within premises field. Parsed from the subPremisesLevel parameter.

Parsed Thoroughfare Parameters

premises

US Term: Street Number

premisesNumber

Alphanumeric indicator within premises field. Parsed from the premises parameter.

US Term: House Number

premisesType

Leading premise type indicator within premises field. Parsed from the premises parameter.

thoroughfare

This value is a part of the address lines and contains all the sub-elements of the thoroughfare like trailing type, thoroughfare name, pre direction, post direction, etc.

US Term: Street

thoroughfareLeadingType

Leading thoroughfare type indicator parsed from the thoroughfare parameter. A leading type is a thoroughfare type that is placed before the thoroughfare. This value is a part of the Thoroughfare field. For example, the thoroughfare type of "Rue" in Canada and France is placed before the thoroughfare, making it a leading type.

US Term: Not used in the US

thoroughfareName

Name indicator parsed from the thoroughfare parameter.

US Term: Street Name

thoroughfarePostDirection

Postfix directional parsed from the thoroughfare parameter.

US Term: Post Direction

thoroughfarePreDirection

Prefix directional parsed from the thoroughfare parameter.

US Term: Pre Direction

thoroughfareTrailingType

Trailing thoroughfare type indicator parsed from the thoroughfare parameter. A trailing type is a thoroughfare type that is placed after the thoroughfare. This value is a part of the Thoroughfare field. For example, the thoroughfare type of "Avenue" in the US is placed after the thoroughfare, making it a trailing type.

US Term: Street Suffix

thoroughfareTypeAttached

Thoroughfare type connected to the thoroughfare name without a space. This is common in Germany. For example, "Berlinerstr." "str." stands for strasse and is the thoroughfare type attached, while "Berliner" is the thoroughfare name.

Parsed Dependent Thoroughfare Columns

dependentThoroughfare

Block data element or dependent street. This is used when there are more than one thoroughfares with the same name in one locality. An adjoining thoroughfare is used to uniquely identify the target thoroughfare. This is rarely used.

US Term: Dependent Street

dependentThoroughfareLeadingType

Thoroughfare type at the beginning of the dependent thoroughfare. The leading type is parsed from the dependentThoroughfare parameter. For example, if the dependent thoroughfare is "St. Hickory E," the dependent thoroughfare leading type would be "St."

dependentThoroughfareName

Dependent thoroughfare name parsed from the dependentThoroughfare parameter. For example, if the dependent thoroughfare is "E Hickory Ln," the dependent thoroughfare name would be "Hickory."

dependentThoroughfarePostDirection

Cardinal directional at the end of the dependent thoroughfare. The postfix directional is parsed from the dependentThoroughfare parameter. For example, if the dependent thoroughfare is "Hickory Ln N," the dependent thoroughfare post direction would be "N."

dependentThoroughfarePreDirection

Cardinal directional at the beginning of the dependent thoroughfare. The prefix directional is parsed from the dependentThoroughfare parameter. For example, if the dependent thoroughfare is "W Hickory Ln," the dependent thoroughfare pre direction would be "W."

dependentThoroughfareTrailingType

Thoroughfare type at the end of the dependent thoroughfare. The trailing type is parsed from the dependentThoroughfare parameter. For example, if the dependent thoroughfare is "W Hickory Ln," the dependent thoroughfare trailing type would be "Ln."

dependentThoroughfareTypeAttached

Dependent thoroughfare type connected to the dependent thoroughfare name without a space. This is common in Germany. For example, "Berlinerstr." "str." stands for strasse and is the dependent thoroughfare type attached, while "Berliner" is the dependent thoroughfare name.

Parsed Postal Facility Columns

postBox

Post box information for a particular delivery point.

postalCode

Complete postal code for a particular delivery point. In U.S. plus 4 is not required but will be appended if address is verified. Most countries have some form of a postal code system.

US Term: Zip Code

personalID

Used by certain Post Offices to identify a recipient for a package.

Parsed Regional Columns

administrativeArea

This is a common geographic area unit for larger countries. Often referred to as State or Province.

US Term: State

countyName

US Only. Sub Administrative Area. Smallest geographic data element.

dependentLocality

A dependent locality is a logical area unit that is smaller than a locality but larger than a double dependent locality or thoroughfare. It can often be associated with a neighborhood or sector. Great Britain is an example of a country that uses double dependent locality. In the United States, this would correspond to Urbanization, which is used only in Puerto Rico.

US Term: Urbanization

doubleDependentLocality

A double dependent locality is a logical area unit that is smaller than a dependent locality but bigger than a thoroughfare. This field is very rarely used. Great Britain is an example of a country that uses double dependent locality.

locality

This is the most common geographic area and used by virtually all countries. This is usually the value that is written on a mailing label and referred to by terms like City, Town, Postal Town, etc.

US Term: City

subAdministrativeArea

This is a logical area that that is smaller than the administrative area but larger than a locality. While many countries can have a sub-administrative area value, it is very rarely used as part of an official address.

US Term: County

subNationalArea

A sub-national area is a logical area unit that is larger than an administrative area but smaller than the country itself. It is extremely rarely used.

Extra Output Address Parameters

US Address Type Codes

Please see the Global Address Object Result Codes for a list of these codes.

Canadian Address Type Codes

Please see the Global Address Object Result Codes for a list of these codes.

latitude

North-south geographic coordinate for a particular delivery point.

longitude

East-west geographic coordinate for a particular delivery point.

Extra Output Country Parameters

countryName

Full country name. Can be a nickname.

iso2Code

ISO 3166 2-character country code.

For example:

Country	Code
United States	US
Canada	CA
Philippines	PH

iso3Code

ISO 3166 3-character country code.

For example:

Country	Code
United States	USA
Canada	CAN
Philippines	PHL

isoCountryNumber

ISO 3166 3-digit numeric country code.

For example:

Country	Code
United States	840
Canada	124
Philippines	608

formalCountryName

Official Name for the country.