Parameters for Input Data

The following table lists the input for GetCandidateAddressesLoqate.

Table 1. Input Format

Parameter

Description

Data.AddressLine1

The first address line.

Data.AddressLine2

The second address line.

Data.AddressLine3

The third address line.

Data.AddressLine4

The fourth address line.

Data.City

The city name.

Data.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

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

Note: This field is required. If this field is blank, no output will be returned.

Data.FirmName

The company or firm name.

Data.PostalCode

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

Data.StateProvince

The state or province.

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