What is Key Lookup?
Key Lookup allows you to find an address using a PreciselyID unique identifier as input and return all standard returns that are provided as part of address matching. For information about the use cases for Key Lookup, see Use Cases.
Licensing
Key Lookup requires a special license; there are two levels:
- Standard - allows Key Lookup of all of the standard MLD addresses.
- Enhanced - allows Key Lookup of a portion of MLD addresses that require an additional royalty due to address-sourcing constraints.
Requirements
Key Lookup includes these requirements:
- You have licensed, installed and added as a database resource the Master Location Dataset (MLD).
- You have licensed, installed and added as a database resource the Master Location Dataset for Key Lookup (MLDR) dataset.
- The MLD and MLDR datasets must be the same vintage.
Key Lookup Search Results
When using Key Lookup, the search results can return zero to many
MLD point address variations that match the input PreciselyID. There will be no
matches returned if the given Precisely is not found. While many IDs map to a single
point-level address, some PreciselyIDs map to multiple point address variations.
Getting multiple point address variations from one PreciselyID can occur in two
circumstances:
- Alias matches. Some streets are known by their common name and
one-to-many aliases. In this case, MLD may contain all variations of street
names. An example of multiple alias match returns for an input PreciselyID
(P00008BCG8WM) is shown below:
AP02. Normal match (non-alias). 1206 W 600 S, FOUNTAINTOWN, IN 46130-9409
Note: For the alias match results below, the alias addresses are represented; however, the address returned is the normal match address: 1206 W 600 S. The value returned in theisAlias
field will indicate an alias match result.AP02. Alias match. 1206 W 1200 N, FOUNTAINTOWN, IN 46130-9409
AP02. Alias match. 1206 W COUNTY ROAD 1200 N, FOUNTAINTOWN, IN 46130-9409
AP02. Alias match. 1206 W COUNTY ROAD 600 S, FOUNTAINTOWN, IN 46130-9409
- Multi-unit buildings with or without units. In some cases, there are
multi-unit addresses without individual unit address records. In this case,
you may see multiple address records returned for the same input
PreciselyID, some without unit designations and others with ranged unit
designations. In the case of multi-unit addresses that have individual
suite/unit number address designations, each will have their own
distinct PreciselyID. The following example shows address results for a
PreciselyID that maps to a building with and without units, which share the
same PreciselyID / location (P00003PZZOIE):
AP02. Normal match (non-alias). 4750 WALNUT ST, BOULDER, CO 80301-2532
AP02. Normal match (non-alias). 4750 WALNUT ST STE 100-103, BOULDER, CO 80301-2532
AP02. Normal match (non-alias). 4750 WALNUT ST STE 205-205, BOULDER, CO 80301-2532
AP02. Normal match (non-alias). 4750 WALNUT ST, BOULDER, CO 80301-2538
Key Lookup Return Codes and Match Codes
The table below lists the Return Codes and Match Codes returned when using Key Lookup.
License | Input PreciselyID | Point Results | Match Code |
---|---|---|---|
Enhanced | Found | One Enhanced | V000 |
Enhanced | Found | Multiple Standard and/or Enhanced | V001 |
Enhanced | Not Found | None | E040 |
Standard | Found | One Standard | V000 |
Standard | Found | Multiple Standard | V001 |
Standard | Found | One Standard, some Enhanced | V002 |
Standard | Found | Multiple Standard, some Enhanced | V003 |
Standard | Found | All Enhanced | E041 |
Standard | Not Found | None | E040 |
No license | Not applicable | Not applicable | E000 |