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 from Options

ValidateAddress returns additional data depending on the options you select. For information on the output generated by each option, see the options listed in the following sections:

Enhanced Line of Travel Output

Enhanced Line of Travel processing produces the following output.


columnName	Description
USLOTCode	Line of Travel sequence code and an indicator denoting USPS® LOT sequence. This field is in the format nnnnY where: nnnn The four-digit LOT code. Y One of the following: A—Ascending LOT sequence D—Descending LOT sequence
USLOTHex	A hexadecimal value that allows you to sort your file in ascending order only. The hexadecimal values range from 0 to FF ascending, then FF through 0 descending.
USLOTSequence	A two-byte value used for final sortation in place of the DPC add-on. It consists of an uppercase letter followed by a digit 0 through 9. Values range from A0 (99 descending) through J9 (00 descending), and K0 (00 ascending) through T9 (99 ascending).

LACS^Link Output


columnName	Description
USLACS	Indicates whether or not the address is a candidate for LACS^Link conversion (U.S. addresses only). One of the following: Y Yes, the address is a candidate for LACS^Link processing. If LACS^Link is enabled, ValidateAddress will attempt to convert the address using the LACS^Link database. If the conversion attempt is successful, the output address is the new address obtained from the LACS^Link database. If the attempt is not successful, the address will not be converted. N No, the address is not a candidate for LACS^Link processing. LACS^Link processing may still be attempted if LACS^Link processing is requested, the LACS^Link database is installed, and one of the following is true: The address matches to a Rural Route address and the RecordType.Default field returns a Y. The input address could not be matched to any address in the U.S. Postal Database (Failures due to multiple matches are not LACS^Link candidates.)
USLACS.ReturnCode	Indicates the success or failure of LACS^Link processing. (U.S. addresses only.) A LACS^Link processing successful. Record matched through LACS^Link processing. 00 LACS^Link processing failed. No matching record found during LACS^Link processing. 09 LACS^Link processing matched the input address to an older highrise default address. The address has been converted. Rather than provide an imprecise address, LACS^Link processing does not provide a new address. 14 LACS^Link processing failed. Match found during LACS^Link processing but conversion did not occur due to other USPS® regulations. 92 LACS^Link processing successful. Record matched through LACS^Link processing. Unit number dropped on input. null LACS^Link did not process the record, or LACS^Link processing was not attempted.

RDI Output


columnName	Description
RDI	Return values indicating address type. B The address is a business address. R The address is a residential address. M The address is both a residential and a business address. null Not checked because the address did not code at a ZIP + 4® level, or RDI™ was not performed.

DPV and CMRA Output


columnName	Description
DPV	Indicates the results of Delivery Point Validation (DPV) processing. Y DPV confirmed. Mail can be delivered to the address. N Mail cannot be delivered to the address. S The building number was validated but the unit number could not be confirmed. A building number is the primary address number for a building. A unit number is a number of a distinct mailing address within a building such as an apartment, suite, floor, and so on. For example, in this address 424 is the building number and 12 is the unit number: 424 Washington Blvd. Apt. 12 Oak Park IL 60302 USA D The building number was validated but the unit number was missing from input. A building number is the primary address number for a building. A unit number is a number of a distinct mailing address within a building such as an apartment, suite, floor, and so on. For example, in this address 424 is the building number and 12 is the unit number: 424 Washington Blvd. Apt. 12 Oak Park IL 60302 USA M The address matches multiple valid delivery points. U The address could not be confirmed because the address did not code at the ZIP + 4® level. V The address caused a false-positive violation.
CMRA	Indicates if the address is a Commercial Mail Receiving Agency (CMRA) Y Yes, the address is a CMRA. N No, the address is not a CMRA. U Unconfirmed.
DPVFootnote	DPV footnote codes. AA Input address matched to the ZIP + 4® file. A1 Input address not matched to the ZIP + 4® file. BB Input address matched to DPV (all components). CC Input address primary number matched to DPV but secondary number not match (present but not valid). F1 Input address is military; DPV bypassed. G1 Input address is general delivery; DPV bypassed. M1 Input address primary number missing. M3 Input address primary number invalid. N1 Input address primary number matched to DPV but high rise address missing secondary number. P1 Input address missing RR or HC Box number. P3 Input address missing PO, RR, or HC Box number RR Input address matched to CMRA. R1 Input address matched to CMRA but secondary number not present. R7 Input address matched to phantom carrier route R777 (not eligible for street delivery). U1 Input address is unique ZIP; DPV bypassed.
DPVVacant	Indicates whether the building is vacant (unoccupied for 90 days). One of the following: Y Yes, the building is vacant. N No, the building is not vacant. null The DPVDetermineVacancy option was not turned on.
DPVNoStat	Indicates whether the building is a "no stat" building and therefore unable to receive mail. One of the following: Y Yes, the building is a "no stat" building, which means the building is not receiving mail. N No, the building is not a "no stat" building, which means the building does receive mail. null The DPVDetermineNoStat option was not turned on.

Suite^Link Output


columnName	Description
SuiteLinkReturnCode	Indicates whether or not ValidateAddress corrected the secondary address information (U.S. addresses only). One of the following: A ValidateAddress corrected the secondary address information. 00 ValidateAddress did not correct the secondary address information. null Suite^Link was not performed. XX Suite^Link processing encountered an error. For example, an error would occur if the Suite^Link database is expired.
SuiteLinkMatchCode	Provides additional information on the Suite^Link match attempt. (U.S. addresses only) A ValidateAddress corrected the secondary address information. B ValidateAddress did not correct the secondary address information. No additional detail about the match attempt is available. C The words in the FirmName field are all "noise" words. Noise words are defined by the USPS® and are ignored when attempting to mach the firm name. Examples of noise words are "company" and "corporation". ValidateAddress is not able to correct secondary address information for firm names that consist entirely of noise words. For example "Company and Corporation" is all noise words. D The address is not a high-rise default address. Suite^Link matching is only done for high-rise default addresses. A high-rise default is a default to use when the address does not contain valid secondary information (the apartment number or apartment type is missing). E Suite^Link processing failed because the Suite^Link database is expired. null Suite^Link was not performed or there was an error.
SuiteLinkFidelity	Indicates how well ValidateAddress matched the firm name to the firm names in the Suite^Link database. 1 The firm name matches the Suite^Link database exactly. 2 Good match. All words in the firm name except one matched the firm name in the Suite^Link database. 3 Poor match. More than one word in the firm name did not match the firm name in the Suite^Link database. null Suite^Link could not match the firm name, or was not performed, or there was an error.

VeriMove Output


columnName	Description
VeriMoveDataBlock	Indicates whether or not ValidateAddress should return a 250-byte field containing input data to pass to VeriMove Express. This field contains the Detail Results Indicator data required by VeriMove. For more information about the contents of this field, see the VeriMove User’s Guide. One of the following: Y Yes, return the field VeriMoveDataBlock. N No, do not return the field VeriMoveDataBlock.