Match Codes - Spectrum_OnDemand - enterprise_tax - web_services - Latest

Spectrum OnDemand Web Services (REST)

Product type
Software
Portfolio
Verify
Product family
Spectrum
Product
Spectrum > Geocoding > Enterprise Tax
Spectrum > Web Services
Spectrum > Spatial > Spectrum Spatial
Spectrum > Spectrum Platform
Spectrum > Quality > Addressing
Spectrum > Quality > Spectrum Quality
Spectrum > Spatial > Spectrum Spatial Insights
Spectrum > Discovery
Spectrum OnDemand
Spectrum > Dataflow Designer
Spectrum > Spatial > Spectrum Spatial Analyst
Spectrum > Quality > Context Graph
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

Match Codes indicate the portions of the address that matched or did not match to the reference file. If a match could not be made, the Match Code begins with "E" and the remaining digits indicate why the address did not match (see Match Codes for No Match - Definitions for "Ennn" return codes). The digits do not specifically refer to which address elements did not match, but rather why the address did not match. These fields are always included in the output from AssignGeoTAXInfo.

Match Code Definitions

Response Element Description

Ahhh

Same as Shhh, but indicates match to an alias name record or an alternate record.

Chh Street address did not match, but located a street segment based on the input ZIP Code or city.
D00 Matched to a small town with P.O. Box or General Delivery only.
Ghhh Matched to an auxiliary file.
Hhhh House number was changed.
Qhhh Matched to USPS range records with unique ZIP Codes. CASS rules prohibit altering an input ZIP if it matches a unique ZIP Code value.
Rhhh Matched to a ranged address.
Shhh Matched to USPS data. This is considered the best address match, because it matched directly against the USPS list of addresses. S is returned for a small number of addresses when the matched address has a blank ZIP + 4.
Thhh Matched to a street segment record.
Uhhh Matched to USPS data but cannot resolve the ZIP + 4 code without the firm name or other information.
Xhhh Matched to an intersection of two streets, for example, “Clay St & Michigan Ave.” The first hex digit refers to the last line information, the second hex digit refers to the first street in the intersection, and the third hex digit refers to the second street in the intersection.
Note: The USPS does not allow intersections as a valid deliverable address
Yhhh Same as Xhhh, but an alias name record was used for one or both streets.
Z No address given, but verified the provided ZIP Code.

Definitions for 1st-3rd hex digit match code values

The table below contains the description of the hex digits for the match code values.
Note: The third hex digit is only populated for intersection matches or as part of the Extended Match Code.
Code In first hex position means: In second and third hex position means:

0

No change in last line.

No change in address line.

1

ZIP Code changed.

Street type changed.

2

City changed.

Predirectional changed.

3

City and ZIP Code changed.

Street type and predirectional changed.

4

State changed.

Postdirectional changed.

5

State and ZIP Code changed.

Street type and postdirectional changed.

6

State and City changed.

Predirectional and postdirectional changed.

7

State, City, and ZIP Code changed.

Street type, predirectional, and postdirectional changed.

8

ZIP + 4 changed.

Street name changed.

9

ZIP and ZIP + 4 changed.

Street name and street type changed.

A

City and ZIP + 4 changed.

Street name and predirectional changed.

B

City, ZIP, and ZIP + 4 changed.

Street name, street type, and predirectional changed.

C

State and ZIP + 4 changed.

Street name and postdirectional changed.

D

State, ZIP, and ZIP + 4 changed.

Street name, street type, and postdirectional changed.

E

State, City, and ZIP + 4 changed.

Street name, predirectional, and postdirectional changed.

F

State, City, ZIP, and ZIP + 4 changed.

Street name, street type, predirectional, and postdirectional changed.

Definitions for Extended Match Code (3rd hex digit values)

Extended additional information is returned about any changes in the house number, unit number and unit type fields in the matched address, as well as whether there was address information that was ignored. This additional information is provided in a 3rd hex digit that is appended to match codes for address-level matches only - A, G, H, Q, R, S, T or U (see Match Codes).

Note: A typical match code contains up to 4 characters: a beginning alpha character followed by 2 or 3 hex digits. The third hex digit is only populated for intersection matches or as part of the Extended Match Code.
For information about the 3rd hex digit values for:

"Address information ignored" is specified when any of these conditions apply:

  • The output address has extra information (for example, a mailstop) in the address line.
  • The output address has a second address line (AddressLine2).
  • The input address is a dual address (two complete addresses in the input address). For example, "4750 Walnut St. P.O Box 50".
  • The input last line has extra information that is not a city, state or ZIP Code, and is ignored. For example, "Boulder, CO 80301 USA", where "USA" is ignored when matching.
The table below provides descriptions of the Extended Match Code 3rd hex digit return values.
Input Addressline Output Addressline Extended Code Description
4750 WALNUT ST STE 200 4750 WALNUT ST STE 200 0 Matched on all address information on line, including Unit Number and Unit Type if included.
4750 WALNUT ST C/O JOE SMITH 4750 WALNUT ST 1 Matched on Unit Number and Unit Type if included. Extra information on address line ignored. Extra information not considered for matching moved to AddressLine2.
4750 WALNUT ST UNIT 200 4750 WALNUT ST STE 200 2 Matched on Unit Number. Unit Type changed.
4750 WALNUT ST UNIT 200 C/O JOE SMITH 4750 WALNUT ST STE 200 3 Matched on Unit Number. Unit Type changed. Extra information on address line ignored. Extra information not considered for matching moved to AddressLine2.
4750 WALNUT ST STE 2-00 4750 WALNUT ST STE 200 4 Unit Number changed or ignored.
4750 WALNUT ST STE 2-00 C/O JOE SMITH 4750 WALNUT ST STE 200 5 Unit Number changed or ignored. Extra information on address line ignored. Extra information not considered for matching moved to AddressLine2.
4750 WALNUT ST STE 400 4750 WALNUT ST STE 400 6 Unit Number changed or ignored. Unit Type changed or ignored. In this example, Suite 400 is not valid for the input address, but the address match is not prevented because of an invalid unit number.
4750 WALNUT ST UNIT 2-00 C/O JOE SMITH 4750 WALNUT ST STE 200 7 Unit Number changed or ignored. Unit Type changed or ignored. Extra information on address line ignored. Extra information not considered for matching moved to AddressLine2.
47-50 WALNUT ST STE 200 4750 WALNUT ST STE 200 8 Matched on Unit Number and Unit Type if included. House number changed or ignored.
47-50 WALNUT ST STE 200 C/O JOE SMITH 4750 WALNUT ST STE 200 9 Matched on Unit Number and Unit Type if included. House number changed or ignored. Extra information not considered for matching moved to AddressLine2.
47-50 WALNUT ST UNIT 200 4750 WALNUT ST STE 200 A Matched on Unit Number. Unit Type changed. House Number changed or ignored.
47-50 WALNUT ST UNIT 200 C/O JOE SMITH 4750 WALNUT ST STE 200 B Matched on Unit Number. Unit Type changed. House Number changed or ignored. Extra information on address line ignored. Extra information not considered for matching moved to AddressLine2.
47-50 WALNUT ST STE 20-0 4750 WALNUT ST STE 200 C House Number changed or ignored. Unit Number changed or ignored.
47-50 WALNUT ST STE 20-0 C/O JOE SMITH 4750 WALNUT ST STE 200 D House Number changed or ignored. Unit Number changed or ignored. Extra information on address line ignored. Extra information not considered for matching moved to AddressLine2.
47-50 WALNUT ST UNIT 20-0 4750 WALNUT ST STE 200 E House Number changed or ignored. Unit Number changed or ignored. Unit Type changed or ignored.
47-50 WALNUT ST UNIT 2-00 C/O JOE SMITH 4750 WALNUT ST STE 200 F House Number changed or ignored. Unit Number changed or ignored. Unit Type changed or ignored. Extra information on address line ignored. Extra information not considered for matching moved to AddressLine2.
The table below provides the descriptions for the Extended Match Code 3rd hex digit return values:
Note: For Landmark Auxiliary file matches, the 3rd hex digit is always "0".
Code In 3rd hex position means:
0 Matched on all address information on line, including Unit Number and Unit Type if included.
1 Matched on Unit Number and Unit Type if included. Extra information on address line ignored. Extra information on address line ignored. Extra information not considered for matching moved to AddressLine2.
2 Matched on Unit Number. Unit Type changed.
3 Matched on Unit Number. Unit Type changed. Extra information on address line ignored. Extra information on address line ignored. Extra information not considered for matching moved to AddressLine2.
4 Unit Number changed or ignored.
5 Unit Number changed or ignored. Extra information on address line ignored. Extra information on address line ignored. Extra information not considered for matching moved to AddressLine2.
6 Unit Number changed or ignored. Unit Type changed or ignored.
7 Unit Number changed or ignored. Unit Type changed or ignored. Extra information on address line ignored. Extra information on address line ignored. Extra information not considered for matching moved to AddressLine2.
8 Matched on Unit Number and Unit Type if included. House Number changed or ignored.
9 Matched on Unit Number and Unit Type if included. House Number changed or ignored. Extra information on address line ignored. Extra information not considered for matching moved to AddressLine2.
A Matched on Unit Number. Unit Type changed. House Number changed or ignored.
B Matched on Unit Number. Unit Type changed. House Number changed or ignored. Extra information on address line ignored. Extra information not considered for matching moved to AddressLine2.
C House Number changed or ignored. Unit Number changed or ignored.
D House Number changed or ignored. Unit Number changed or ignored. Extra information on address line ignored. Extra information on address line ignored. Extra information not considered for matching moved to AddressLine2.
E House Number changed or ignored. Unit Number changed or ignored. Unit Type changed or ignored.
F House Number changed or ignored. Unit Number changed or ignored. Unit Type changed or ignored. Extra information on address line ignored. Extra information on address line ignored. Extra information not considered for matching moved to AddressLine2.

Match Codes for No Match - Definitions for "Ennn" return codes

The table below describes the values returned when the application cannot find a match or an error occurs.

Code "nnn" values Description

Ennn

 

Indicates an error, or no match. This can occur when the address entered does not exist in the database, or the address is badly formed and cannot be parsed correctly. The last three digits of an error code indicate which parts of an address the application could not match to the database.

 

nnn = 000

No match made.

 

nnn = 001

Low level error.

 

nnn = 002

Could not find data file.

 

nnn = 003

Incorrect GSD file signature or version ID.

 

nnn = 010

No city and state or ZIP Code found.

 

nnn = 011

Input ZIP not in the directory.

 

nnn = 012

Input city not in the directory.

 

nnn = 013

Input city not unique in the directory.

 

nnn = 014

Out of licensed area. Only occurs if using Group 1 licensing technology.

 

nnn = 015

Record count is depleted and license has expired.

 

nnn = 020

No matching streets found in directory.

 

nnn = 021

No matching cross streets for an intersection match.

 

nnn = 022

No matching segments.

 

nnn = 023

Unresolved match.

 

nnn = 024

No matching segments. (Same as 022.)

 

nnn = 025

Too many possible cross streets for intersection matching.

 

nnn = 026

No address found when attempting a multiline match.

 

nnn = 027

Invalid directional attempted.

 

nnn = 028

Record also matched EWS data, therefore the application denied the match.

 

nnn = 029

No matching range, single street segment found.

 

nnn = 030

No matching range, multiple street segments found.