Extended Match Codes - geo_addressing_sdk - 5.0

Geo Addressing SDK Developer Guide

Product type
Software
Portfolio
Locate
Product family
Geo Addressing
Product
Geo Addressing SDK
Version
5.0
Language
English
Product name
Geo Addressing SDK
Title
Geo Addressing SDK Developer Guide
Copyright
2023
First publish date
2007
ft:lastEdition
2024-07-12
ft:lastPublication
2024-07-12T13:44:57.839102

Extended Match Codes return additional information about any changes in the house number, unit number and unit type fields. In addition, it can indicate whether there was address information that was ignored. The Extended Match Code is only returned for address-level matches (match codes that begin with A, G, H, J, Q, R, S, T or U), in which case a 3rd hex digit is appended to the match code (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:

The return of the Extended Match Code is enabled by default and cannot be modified.

Implementation

The Extended Match Code is enabled by default. To disable, use the appropriate CLI command. For more information, see setting Command.

Extended Match Code return values

"Address information ignored" is specified when any of these conditions apply:
  • 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 is not returned.
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 is not returned.
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 is not returned.
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 is not returned.
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 is not returned.
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 is not returned.
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 is not returned.
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 is not returned.