Global Address Object:Input Parameters

← Global Address Object Reference

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

All of the following inputs can be set using SetInputParamter and can also be output using GetOutputParameter.

Processing Configuration Parameters

countryOfOrigin

The country of origin (the address being validated is the destination). Used to determine whether the destination country should be added to the formatted address.

Option Name	Parameter	Description
countryOfOrigin	(Any valid ISO-3166-1 Alpha-2, ISO-3166-1 Alpha-3, or ISO-3166-1 Numeric code)	If blank, invalid, or the same as the destination country, then the destination country is not appended to the end of the formatted address. If valid and different from the destination country, then the destination country is appended to the formatted address. US or US Territory: If countryOfOrigin and destination country being verified are both US or US Territories then the country will not be appended to formattedAddress. US Territories will have "United States of America" appended if the countryOfOrigin is not a US Territory, but the countryName and ISO codes will be that of the territory. Canada is treated like any other non-US Territory.

outputPreference

This is the script type used for all applicable fields.

Option Name	Parameter	Description
outputPreference	[Blank]	Default. Returns the same script that is sent in.
	LATIN	Returns in the Latin script.
	NATIVE	Returns in the native script for the designated country.

inputFormattedAddressSeparator

This is a string used to delimit line in the formattedAddress output field. This string can be one or multiple characters.

Input Address Parameters

inputOrganization

The organization name associated with the address record.

inputAddressLine1

Required.

The input field for the address. This should contain the delivery address information (house number, thoroughfare, building, suite, etc.) but should not contain locality information (locality, administrative area, postal code, etc.) which have their own inputs.

inputAddressLine2

Optional.

The input field for the address. This should contain the delivery address information (house number, thoroughfare, building, suite, etc.) but should not contain locality information (locality, administrative area, postal code, etc.) which have their own inputs.

inputAddressLine3

Optional.

The input field for the address. This should contain the delivery address information (house number, thoroughfare, building, suite, etc.) but should not contain locality information (locality, administrative area, postal code, etc.) which have their own inputs.

inputAddressLine4

Optional.

The input field for the address. This should contain the delivery address information (house number, thoroughfare, building, suite, etc.) but should not contain locality information (locality, administrative area, postal code, etc.) which have their own inputs.

inputAddressLine5

Optional.

The input field for the address. This should contain the delivery address information (house number, thoroughfare, building, suite, etc.) but should not contain locality information (locality, administrative area, postal code, etc.) which have their own inputs.

inputAddressLine6

Optional.

The input field for the address. This should contain the delivery address information (house number, thoroughfare, building, suite, etc.) but should not contain locality information (locality, administrative area, postal code, etc.) which have their own inputs.

inputAddressLine7

Optional.

The input field for the address. This should contain the delivery address information (house number, thoroughfare, building, suite, etc.) but should not contain locality information (locality, administrative area, postal code, etc.) which have their own inputs.

inputAddressLine8

Optional.

The input field for the address. This should contain the delivery address information (house number, thoroughfare, building, suite, etc.) but should not contain locality information (locality, administrative area, postal code, etc.) which have their own inputs.

inputDoubleDependentLocality

Optional.

The smallest population center data element. This depends on the Locality and DependentLocality elements.

inputDependentLocality

Optional.

The smaller population center data element. This depends on the Locality element.

US Term: Urbanization

In terms of US Addresses, this element applies only to Puerto Rican addresses. It is used to break ties when a ZIP Code™ is linked to multiple instances of the same address.

inputLocality

Required.

The most common population center data element.

US Term: City

Canada Term: Municipality

inputSubAdministrativeArea

Optional.

The smallest geographic data element.

US Term: County

inputAdministrativeArea

Required.

The most common geographic data element.

US Term: State

Canada Term: Province

inputSubNationalArea

Optional.

The administrative region within a country on an arbitrary level below that of the sovereign state.

inputPostalCode

Required.

The complete postal code for a particular delivery point.

US Term: ZIP

Canadian Term: Postcode

If all three elements are provided and the PostalCode is incorrect, it can be corrected from the data on the Locality and AdministrativeArea.

inputCountry

Required.

The country name, abbreviation, or code.