Match codes

GeoStan returns match codes that indicate the portions of the address that matched or did not match to the GeoStan Directory file. If GeoStan could not make a match, the match code begins with "E" and the remaining digits indicate why the address did not match. The digits do not specifically refer to which address elements did not match, but rather why the address did not match.

The following table contains the match code values. You can find a description of the hex digits for the different match codes in the table following the match code table.


Code	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.
Jhhh	Matched to a User Dictionary.
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 candidates for a 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.
Za	No address given, but verified the provided ZIP Code.


^aZh may be returned if Correct Last Line is set to True. For more information see Correct lastline match codes and Using correct lastline.

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

The following table 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 definition.

For Extended Match Code, see Definitions for Extended Match Code (3rd hex digit) values in the next section.


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 Understanding Extended Match Codes, when set to True, GS_FIND_MATCH_CODE_EXTENDED returns additional information 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 codes).

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

The output address has a mail stop (GS_MAIL_STOP).
The output address has a second address line (GS_ADDR2).
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 following table contains the description of the Extended Match Code 3rd hex digit return values:


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 not considered for matching moved to GS_ADDR2 or GS_MAIL_STOP 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 not considered for matching moved to GS_ADDR2 or GS_MAIL_STOP field.
4	Unit Number changed or ignored.
5	Unit Number changed or ignored. Extra information on address line ignored. Extra information not considered for matching moved to GS_ADDR2 or GS_MAIL_STOP 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 not considered for matching moved to GS_ADDR2 or GS_MAIL_STOP 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 not considered for matching moved to GS_ADDR2 or GS_MAIL_STOP 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 GS_ADDR2or GS_MAIL_STOP 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 not considered for matching moved to GS_ADDR2 or GS_MAIL_STOP 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 not considered for matching moved to GS_ADDR2 or GS_MAIL_STOP field.

Note: For Auxiliary file matches, the 3rd hex digit is always "0".

Definitions for the Reverse PBKey Lookup "Vhhh" return codes

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

Note: When there are one or more address variations for a Reverse PBKey Lookup, the match code returned by GsMultipleGet 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.

Definitions for "Ennn" return codes

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


Code		Description
Ennna		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 Code 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 Precisely 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 Reverse PBKey Lookup.
	nnn=041	Not licensed to return Enhanced point address(es) found for input pbKey. Additional Reverse PBKey Lookup license option required to return results.


^aEhnn may be returned if Correct Last Line is set to True. For more information, see Correct lastline match codes and Using correct lastline.

Correct lastline match codes

As mentioned in Using correct lastline, when set to True, GS_FIND_CORRECT_LASTLINE corrects elements of the output lastline, providing a good ZIP Code or close match on the soundex even if the address would not match or was non-existent.

The feature works when GS_FIND_ADDRCODE is True and the address does not match a candidate or when GS_FIND_Z_CODE is True and only last line information is input. The match codes returned are similar to Z and Ennn in that the first letter remains the same with the second digit changing.


Code		Description
Zh		No address given, but verified the provided ZIP Code.
	h=0	No change in lastline.
	h=1	ZIP Code changed.
	h=2	City changed.
	h=3	City and ZIP Code changed.
	h=4	State changed.
	h=5	State and ZIP Code changed.
	h=6	State and City changed.
	h=7	State, City, and ZIP Code changed.
	h=8	ZIP + 4 changed.
	h=9	ZIP and ZIP + 4 changed.
	h=A	City and ZIP + 4 changed.
	h=B	City, ZIP, and ZIP + 4 changed.
	h=C	State and ZIP + 4 changed.
	h=D	State, ZIP, and ZIP + 4 changed.
	h=E	State, City, and ZIP + 4 changed.
Ehnn		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 second digit of the error code is a hex digit which details the changes that were made to the last line information to correct the lastline. The last two digits of an error code indicate which parts of an address the application could not match to the database.
	h=0	No change in lastline.
	h=1	ZIP Code changed.
	h=2	City changed.
	h=3	City and ZIP Code changed.
	h=4	State changed.
	h=5	State and ZIP Code changed.
	h=6	State and City changed.
	h=7	State, City, and ZIP Code changed.
	h=8	ZIP + 4 changed.
	h=9	ZIP and ZIP + 4 changed.
	h=A	City and ZIP + 4 changed.
	h=B	City, ZIP, and ZIP + 4 changed.
	h=C	State and ZIP + 4 changed.
	h=D	State, ZIP, and ZIP + 4 changed.
	h=E	State, City, and ZIP + 4 changed.
	nn=00	No match made.
	nn=01	Low level error.
	nn=02	Could not find data file.
	nn=03	Incorrect GSD file signature or version ID.
	nn=04	GSD file out of date. Only occurs in CASS mode.
	nn=10	No city and state or ZIP Code found.
	nn=11	Input ZIP not in the directory.
	nn=12	Input city not in the directory.
	nn=13	Input city not unique in the directory.
	nn=14	Out of licensed area. Only occurs if using Precisely licensing technology.
	nn=15	Record count is depleted and license has expired.
	nn=20	No matching streets found in directory.
	nn=21	No matching cross streets for an intersection match.
	nn=22	No matching segments.
	nn=23	Unresolved match.
	nn=24	No matching segments. (Same as 022.)
	nn=25	Too many possible cross streets for intersection matching.
	nn=26	No address found when attempting a multiline match.
	nn=27	Invalid directional attempted.
	nn=28	Record also matched EWS data, therefore the application denied the match.
	nn=29	No matching range, single street segment found
	nn=30	No matching range, multiple street segments found