Response

GetCityStateProvinceLoqate returns the matching city and state/province for the input postal code as well as a code to indicate the success or failure of the match attempt. If more than one city/state or city/province matches the input postal code, multiple output records are returned.

Table 1. GetCityStateProvinceLoqate Output

Response Element

Description

City

The matched city name.

Country

The country in the format determined by what you selected in:

  • ISO Code
  • UPU Code
  • English

PostalCode

The input postal code.

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. The only valid value is:

  • UnrecognizedPostalCode

Status.Description

The description of the failure. The only valid value is:

Postal code not found
This value will appear if Status.Code=UnrecognizedPostalCode.