Output Related to Quality of Address - Spectrum_OnDemand - Latest

Spectrum OnDemand Web Services (REST)

Product type
Software
Portfolio
Verify
Product family
Spectrum
Product
Spectrum > Quality > Context Graph
Spectrum > Spatial > Spectrum Spatial Analyst
Spectrum > Spectrum Platform
Spectrum > Quality > Addressing
Spectrum > Quality > Spectrum Quality
Spectrum > Web Services
Spectrum > Dataflow Designer
Spectrum > Discovery
Spectrum OnDemand
Spectrum > Spatial > Spectrum Spatial Insights
Spectrum > Spatial > Spectrum Spatial
Spectrum > Geocoding > Enterprise Tax
Version
Latest
Language
English
Product name
Spectrum OnDemand
Title
Spectrum OnDemand Web Services (REST)
Copyright
2024
First publish date
2006
ft:lastEdition
2024-07-17
ft:lastPublication
2024-07-17T23:23:16.481321

Output related to quality of address consists of two-character code that indicates the overall quality of the resulting address. Status, Status.Code, ChangeScore, and other data is also included in Output related to quality of address.

Table 1. Output Related to Quality of Address

Parameter

Description

Type

AddressQuality

A two-character code indicating the overall quality of the resulting address (for example, "V5", "C3", and more). This indicator does not consider how much the address had to changed.

The first character generally indicates how the address was processed:

V
Verified without change
C
Verified with correction
U
Unmatched with reference data

The second character indicates the precision of the address:

5
Delivery point confirmed to be a deliverable address
4
House number/Building Name is within valid range or known name but cannot confirm 100% that premise is deliverable
3
Street name is valid, but the house number may not be
2
City exists but cannot confirm the street does
1
State exists but cannot confirm City does
0
Cannot confirm any part of the address exists

String

ChangeScore

This score reflects how much validated address matches input address.

A value between 0 and 100. 100 indicates no changes. 0 indicates completely different.

String

Message

Derived from USPS return codes (US) and Status.Description (non-US). One of these:
  • Deliverable Address
  • Deliverable but Not Receiving Mail
  • Deliverable but Vacant
  • Ste/Apt Appended, Deliverable Address
  • LACSLink Conversion, Deliverable Address
  • SuiteLink Conversion, Deliverable Address
  • Not Deliverable, Primary Number Invalid
  • Not Deliverable, No Match
  • Address Corrected, Deliverable Address
  • Deliverable Location
  • Address Not Found

For more information, see AddressQuality code.

String

Recommended

One of these:

Y
Verified deliverable address alternative
Blank
Input address not recommended for postal delivery. For more information, see AddressQuality code.

String

ProcessedBy

Reserved. Used for internal tracking purposes.

String

Status

F if failure occurred. Otherwise blank.

String

Status.Code

Reason for failure:
  • InsufficientInputData
  • UnableToValidate

String

Status.Description

Description of the problem, if there is one.

String