Melissa Keys Lookup Reference Guide

Melissa Keys Lookup Reference Guide#

Introduction #

The Melissa Keys Lookup Cloud API provides a streamlined endpoint for resolving Melissa Address Keys (MAKs) back to their equivalent physical address strings. This API acts as a centralized lookup utility that enables relational data integrity by storing compact, 10-digit MAKs rather than volatile address text. It supports critical data operations including reverse key lookups, global address deduplication, and the resolution of MAK tokens output by Melissa Cloud APIs like Global Address, Personator Consumer, and SmartMover.

Base URL #

https://melissakeys.melissadata.net

New to Melissa Cloud APIs?#

We highly recommend first time users of our Cloud APIs to review our Using Melissa Cloud APIs section. It will cover critical topics like:

Endpoints #

/V4/doMAKLookup #

Try It Now #

GET JSON

curl -X GET "https://melissakeys.melissadata.net/v4/doMAKLookup?\
&id={{customerId}}\
&t=TechWriterTest\
&ctry=US\
&mak=8008006245"

Request Parameters #

GET JSON

Code

Description

Request Level Parameters

id

Required. The License Key issued by Melissa (Encrypted). This only takes a license key, it will not accept the Customer ID.

format

The output format, JSON or XML. Default is JSON.

opt

Set Options
ResponseSchema

Record Level Parameters

ctry

The country where your MAK lookup is for. This helps optimize MAK searches.

mak

Required. The MAK number input (US and Global). MAK Numbers are unique identifiers for all delivery point addresses for all countries when available.

Options #

List options in the following format, with multiple options delimited with a ,.

OptionName:Parameter,OptionName:Parameter

ResponseSchema #

Converts the output fields to use naming conventions for the specified country.

Parameter	Description
`Global`	Use global naming conventions in the output.
`US`	Default. Use US naming conventions in the output.

Headers #

GET JSON

Content-Type: application/json
Accept: application/json

Response #

GET JSON

{
  "Version": "9.4.0.1055",
  "TransmissionReference": "Test",
  "TransmissionResults": "",
  "TotalRecords": "1",
  "Records": [
    {
      "RecordID": "1",
      "Results": "MK01",
      "AddressLine1": "3 Chemin de la Barrière",
      "AddressLine2": "22650 Beaussais-sur-Mer",
      "City": "Beaussais-sur-Mer",
      "State": "Côtes-d'Armor",
      "PostalCode": "22650",
      "CountryName": "France",
      "CountryISO3166_1_Alpha2": "FR",
      "CountryISO3166_1_Alpha3": "FRA",
      "CountryISO3166_1_Numeric": "250"

      "RecordID": "1",
      "Results": "MK01",
      "AddressLine1": "22382 Avenida Empresa",
      "AddressLine2": "","City":"Rancho Santa Margarita",
      "State": "CA",
      "PostalCode": "92688-2112",
      "CountryName": "United States",
      "CountryISO3166_1_Alpha2": "US",
      "CountryISO3166_1_Alpha3": "USA",
      "CountryISO3166_1_Numeric": "840"
    }
  ]
}

Service Level Response Fields #

Output Name	Description
TotalRecords	Total number of records.
TransmissionReference	Optional. Serves as a unique request identifier.
TransmissionResults	Lists error codes from any errors caused by the most recent request as a whole.
Version	The current service version number.

Record Level Response Fields #

Output Name	Description
AddressLine1	These are string values that return the standardized or corrected address for the associated MAK.
AddressLine2	Standardized or corrected contents of the input address line 2.
AddressLine3	Standardized or corrected contents of the input address line 3.
AddressLine4	Standardized or corrected contents of the input address line 4.
AddressLine5	Standardized or corrected contents of the input address line 5.
AddressLine6	Standardized or corrected contents of the input address line 6.
AddressLine7	Standardized or corrected contents of the input address line 7.
AddressLine8	Standardized or corrected contents of the input address line 8.
AdministrativeArea	State, Province. This is a common geographic area unit for larger countries.
City	The city name for the associated MAK.
CountryISO3166_1_Alpha2	The 2 letter ISO 3166 country code value. For example: `US` for United States or `CA` for Canada.
CountryISO3166_1_Alpha3	The 3 letter ISO 3166 country code value. For example: `USA` for United States or `CAN` for Canada.
CountryISO3166_1_Numeric	The ISO 3166 country number value. For example: `840` for United States or `124` for Canada.
CountryName	The full country name for the associated MAK.
CountrySubdivisionCode	The ISO3166-2 code for country subdivisions, usually tied to the administrative area for a country. The format is the 2 letter country code followed by a dash followed by 2 or 3 characters or two numbers. For example: `US-CA`, `CN-16`, or `AU-VIC`. This field is only populated for the following countries: AE, AR, AT, AU, BB, BE, BH, BR,BS, CA, CH, CL, CN, CO, CR, DE, DK, DM, DO, ES, FI, FJ, FR, GB, GH, GT, GY, HN, ID, IE, IL, IN, IS, IT, JP, KR, KW, LT, LU, LV, MX, MY, NC, NG, NI, NL, NO, NZ, PE, PH, PK, PL, PR, PT, RS, SA, SG, SI, SV, TH, TR, UA, US, UY, VN.
DependentLocality	Urbanization. A dependent locality is a logical area unit that is smaller than a locality but larger than a double dependent locality or thoroughfare. It can often be associated with a neighborhood or sector. Great Britain is an example of a country that uses double dependent locality. In the United States, this would correspond to Urbanization, which is used only in Puerto Rico.
DoubleDependentLocality	A double dependent locality is a logical area unit that is smaller than a dependent locality but bigger than a thoroughfare. This field is very rarely used. Great Britain is an example of a country that uses double dependent locality.
Locality	City. This is the most common geographic area and used by virtually all countries. This is usually the value that is written on a mailing label and referred to by terms like City, Town, or Postal Town.
PostalCode	ZIP Code. Most countries have some form of a postal code system.
RecordID	The number of the record. Always 1 for a single request, otherwise it serves as an index of the array of records.
Results	Comma delimited status, error codes, and change codes for the record.
State	The state name.
SubAdministrativeArea	County. This is a logical area that that is smaller than the administrative area but larger than a locality. While many countries can have a sub-administrative area value, it is very rarely used as part of an official address.
SubNationalArea	The standardized arbitrary administrative region below that of the sovereign state. A sub-national area is a logical area unit that is larger than an administrative area but smaller than the country itself. It is extremely rarely used.
SubPremises	Suite, Apartment. A subpremise are individual units with their own addresses inside a building.

Result Codes #

Please visit Result Codes - Melissa Keys Lookup for more information on the result codes returned by Melissa Keys Lookup.

Melissa Keys Lookup Reference Guide

Contents

Melissa Keys Lookup Reference Guide#