Welcome
Learn how to use a supported compiler and runtime to connect applications to Spectrum Technology Platform 2022.1.0.
Getting Started
Useful information about using the Spectrum API.
The C API
The C API is a set of functions that allow C code to interact with Spectrum Technology Platform 2022.1.0.
The C++ API
The C++ API is a set of functions that allow C++ code to interact with Spectrum Technology Platform 2022.1.0.
The Java API
The Java API is a set of functions that allow Java code to interact with Spectrum Technology Platform 2022.1.0.
ManagementAPI Methods (Deprecated)
The deprecated ManagementAPI supports two methods used by existing legacy applications.
Module Services
Describes module services addressible by Spectrum APIs.
- Enterprise Geocoding
- Enterprise Tax Module
- GeoConfidence Module
- Global Addressing Module
- Universal Addressing Module
  - Spectrum Universal Address
  - AutoCompleteLoqate
  - GetCandidateAddresses
  - GetCandidateAddressesLoqate
  - GetCityStateProvince
  - GetCityStateProvinceLoqate
  - GetPostalCodes
  - GetPostalCodes Loqate
  - ValidateAddress
  - ValidateAddressGlobal
  - ValidateAddressLoqate
  - Encountering False Positives
    Information on what is false positives, how to report DPV, LACS/Link False-Positives Violations.
  - ValidateAddress Confidence Algorithm
- Spectrum Universal Name
About Spectrum Technology Platform
An overview of Spectrum, its data management architecture, its platform architecture, and its modules and components.
Appendix
Look up ISO codes for countries and Spectrum modules that support addressing, geocoding, and routing for each country.

Output

GetCandidateAddressesLoqate returns the following output.

Table 1. GetCandidateAddressesLoqate Output
columnName	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.