Response

GetCandidateAddressesLoqate returns the following output.

Table 1. GetCandidateAddressesLoqate Output

Response Element

Description

AddressLine1

The first address line.

AddressLine2

The second address line.

AddressLine3

The third address line.

AddressLine4

The fourth address line.

City

The city name.

Country

The three-character ISO 3166-1 Alpha 3 code for the country. For a list of ISO codes, see ISO Country Codes and Module Support.

FirmName

The firm name.

PostalCode

The postal code. In the U.S. this is the ZIP Code™.

PostalCode.AddOn

The last four digits of the ZIP + 4® Code. U.S. addresses only.

ProcessedBy

Indicates which address coder processed the address.

LOQATE
The Loqate coder processed the address.

StateProvince

The validated state/province or its abbreviated value.

Status

Reports the success or failure of the match attempt.

null
Success
F
Failure

Status.Code

The reason for failure, if there is one. There is only one possible value:

  • RequestFailed

Status.Description

A description of the problem, if there is one. There is only one possible value:

Did not return multiples
The input address matched only one address in the database. GetCandidateAddressesLoqate only returns data if multiple possible matches were found.