Address Data

Table 1. Get Global Candidate Addresses Address Data Output

Field Name

Format

Description

AddressLine1

String [79]

The formatted first address line.

AddressLine2

String [79]

The formatted second address line.

AddressLine3

String [79]

The formatted third address line.

AddressLine4

String [79]

The formatted fourth address line.

AddressLine5

String [79]

The formatted fifth address line.

AddressLine6

String [79]

The formatted sixth address line.

AddressLine7

String [79]

The formatted seventh address line.

AddressLine8

String [79]

The formatted eighth address line.

ApartmentLabel

String [79]

Apartment designator (such as STE or APT). For example:

123 E Main St. APT 3

ApartmentNumber

String [79]

Apartment number. For example:

123 E Main St. APT 3

Building

String [79]

The name of a building.

City

String [79]

The city name.

Country

String [79]

The ISO code or English name of the country. For a list of ISO codes, see ISO Country Codes and Module Support.

Department

String [79]

The name of a distinct part of anything arranged into divisions. For example, the Finance Department in a corporation.

FirmName

String [79]

The name of a company. For example:

Pitney Bowes
4200 PARLIAMENT PL
STE 600
LANHAM MD 20706-1844
USA

HouseNumber

String [79]

House number. For example:

123 E Main St. Apt 3

POBox

String [79]

Post office box number. If the address is a rural route address, the rural route box number will appear here.

PostalCode

String [79]

The postal code as required by the local postal authority. For example, in the U.S. the postal code is the ZIP Code.

PostalCode.AddOn

String [79]

For U.S. addresses, the last four digits of the ZIP + 4® Code.

PostalCode.Base

String [79]

For U.S. addresses, the five-digit ZIP Code.

Principality

String [79]

An area within a country. For example, England, Scotland, and Wales are principalities. This field will normally be blank.

StateProvince

String [79]

The state or province abbreviation.

StreetName

String [79]

Street name. For example:

123 E Main St. Apt 3

StreetSuffix

String [79]

Street suffix. For example:

123 E Main St. Apt 3

SubCity

String [79]

A district or suburb. The subcity is used in countries where it is common to include the district or suburb within the address. For example,

27 Crystal Way
Bradley Stoke
Bristol BS32 8GA

In this case, "Bradley Stoke" is the subcity.

SubStreet

String [79]

The second street address used to identify an address. Substreets are used in countries where it is common to give two street names in the address. For example,

12 The Mews
High Street

In this example, "High Street" is the substreet. Substreets can be used to precisely identify the delivery location. In the example, "The Mews" may be a small street that needs another street identification to properly locate the address, so "High Street" is included. In this case, "High Street" is the main or known street.

USCountyName

String [79]

For U.S. addresses, the name of the county where the address is located.