Parameters for Input Data

The following table lists the input for GetCandidateAddresses.

Table 1. Input Format

Parameter

Description

AddressLine1

The first address line.

AddressLine2

The second address line.

AddressLine3

The third address line.

Does not apply to U.S. and Canadian addresses.

AddressLine4

The fourth address line.

Does not apply to U.S. and Canadian addresses.

AddressLine5

The fifth address line.

Applies only to U.K. addresses. May contain street name, unit number, building number, and so on.

City

The city name.

StateProvince

The state or province.

For U.S. addresses only, you may put the state in the City field instead of the StateProvince field.

PostalCode

The postal code for the address. For U.S. addresses this is the ZIP Code™ in one of the following formats:

99999
99999-9999
A9A9A9
A9A 9A9
9999 999

Note: For Canadian addresses you can complete just this field and have candidate address data returned. For other countries, AddressLine1 and AddressLine2 must also be completed.

Country

The country code or name, in any of the following formats:

  • 2-digit ISO country code
  • 3-digit UPU Country code
  • English country name
  • French country name
  • German country name
  • Spanish country name

For a list of ISO codes, see ISO Country Codes and Module Support.

FirmName

The company or firm name.

USUrbanName

U.S. address urbanization name. Used primarily for Puerto Rico addresses.