Postal Data - Spectrum_OnDemand - Latest

Spectrum OnDemand Web Services (REST)

Product type
Software
Portfolio
Verify
Product family
Spectrum
Product
Spectrum OnDemand
Version
Latest
Language
English
Product name
Spectrum OnDemand
Title
Spectrum OnDemand Web Services (REST)
Copyright
2024
First publish date
2006
Last updated
2024-11-25
Published on
2024-11-25T19:42:51.884318

Response Element

Description

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.

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.

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.

PostalBarCode

The two-digit delivery point portion of the delivery point barcode (U.S. addresses only). For more information, see Creating Delivery Point Barcodes.

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.

USAltAddr

Indicates whether or not alternate address matching logic was used, and if so which logic was used (U.S. addresses only). One of the following:

null
No alternate address scheme used.
D
Delivery point alternate logic was used.
E
Enhanced highrise alternate match logic was used.
S
Small town default logic was used.
U
Unique ZIP Code logic was used.

USBCCheckDigit

Check-digit portion of the 11-digit delivery point barcode (U.S. addresses only). For more information, see Creating Delivery Point Barcodes.

USCarrierRouteCode

Carrier route code (U.S. addresses only). For more information, see Obtaining Carrier Route Codes.

USCongressionalDistrict

Congressional district (U.S. addresses only). For more information, see Obtaining Congressional Districts.

USCountyName

County name (U.S. addresses only). For more information, see Obtaining County Names.

USFinanceNumber

The finance number in which the address resides (U.S. addresses only). The finance number is a number assigned by the USPS to an area that covers multiple ZIP Codes. An address is validated only if its finance number matches the finance number of the candidate address in the U.S. Database.

USFIPSCountyNumber

FIPS (Federal Information Processing Standards) county number (U.S. addresses only). For more information, see Obtaining FIPS County Numbers.

USLACS

Indicates whether or not the address is a candidate for LACSLink conversion (U.S. addresses only). One of the following:

Y
Yes, the address is a candidate for LACSLink processing. If LACSLink is enabled, an attempt is made to convert the address using the LACSLink database. If the conversion attempt is successful, the output address is the new address obtained from the LACSLink database. If the attempt is not successful, the address will not be converted.
N
No, the address is not a candidate for LACSLink processing. LACSLink processing may still be attempted if LACSLink processing is requested, the LACSLink 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 LACSLink candidates.)

USLACS.ReturnCode

Indicates the success or failure of LACSLink processing. (U.S. addresses only.)

A
LACSLink processing successful. Record matched through LACSLink processing.
00
LACSLink processing failed. No matching record found during LACSLink processing.
09
LACSLink processing matched the input address to an older highrise default address. The address has been converted. Rather than provide an imprecise address, LACSLink processing does not provide a new address.
14
LACSLink processing failed. Match found during LACSLink processing but conversion did not occur due to other USPS® regulations.
92
LACSLink processing successful. Record matched through LACSLink processing. Unit number dropped on input.
null
LACSLink did not process the record, or LACSLink processing was not attempted.

USLastLineNumber

A six-character alphanumeric value that groups together ZIP Codes that share the same primary city. For example, addresses with the following two last lines would have the same last line number:

Chantilly VA 20151

Chantilly VA 20152

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