Match Codes

This section covers:

Match Code Definitions
Definitions for 1st-3rd hex digit match code values
Definitions for Extended Match Code (3rd hex digit values)
Definitions for the Reverse PBKey Lookup "Vhhh" return codes
Match Codes for No Match - Definitions for "Ennn" return codes

Match Code Definitions

The table below contains the match code values.

For descriptions of the hex digits for the match codes, see Definitions for 1st-3rd hex digit match code values.


Code	Description
`Ahhh`	Same as `Shhh`, but indicates match to an alias name record or an alternate record.
`Chh`	The street address did not match, but the geocoder 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`	The house number was changed.
`Jhhh`	Matched to a user-defined dictionary.
`Nxx`	Matched to the nearest address. Used with reverse geocoding. The following are the only values for `N`: NS0 Nearest street center match (nearest street segment interpolated) NS1 Nearest unranged street segment NP0 Nearest point address NX0 Nearest intersection
`P`	Successful reverse APN lookup.
`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. CASS mode returns an `E023` (multiple match) error code.
`Vhhh`	Matched to MLD and DVDMLDR using Reverse PBKey Lookup. For match code values, see Definitions for the Reverse PBKey Lookup "Vhhh" return codes.
`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.

For intersection matches, use the table below for the 3rd hex digit definitions.
For Extended Match Code, see Definitions for Extended Match Code (3rd hex digit values).


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)

As mentioned in Match Code, when ExtendedMatchCode is set to "Y", 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, J, Q, R, S, T or U (see Match Code Definitions).

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

The output address has content in the AdditionalInputData field.
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 the descriptions for the Extended Match Code 3rd hex digit return values:

Note: For 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` or `AdditionalInputData` field.
`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` or `AdditionalInputData` field.
`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` or `AdditionalInputData` field.
`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` or `AdditionalInputData` field.
`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` or `AdditionalInputData` field.
`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` or `AdditionalInputData` field.
`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` or `AdditionalInputData` field.
`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` or `AdditionalInputData` field.

Definitions for the Reverse PBKey Lookup "Vhhh" return codes

The table below lists the "Vhhh" hex digit values returned with Reverse PBKey Lookup. For more information, see ReversePBKeyLookup.

Note: When there are one or more address variations for a Reverse PBKey Lookup, the match code returned is always "V000".


Match Code	Definition
`V000`	Match made using input pbKey. One Standard or Enhanced point address result returned depending on license.
`V001`	Match made using input pbKey. Multiple Standard and/or Enhanced point address variations results returned depending on license.
`V002`	Match made using input pbKey. One Standard, some Enhanced point address variations results returned depending on license.
`V003`	Match made using input pbKey. Multiple Standard, some Enhanced point address variations results depending on license.

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 = 004`	GSD file out of date. Only occurs in CASS mode.
	`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.
	`nnn = 040`	No match found using input PBKey with ReversePBKeyLookup.
	`nnn = 041`	Not licensed to return Enhanced point address(es) found for input PBKey. Additional ReversePBKeyLookup license option required to return results.