Skip to content
/Address Autocompletion

Global Express Entry

Overview

Global Express Entry is an auto-complete address verification service that will complete your query with a verified address, including city, state, and postal code with 50% fewer keystrokes.

Global Express Entry can:

  • Complete free form partial address input with standardized and verified addresses.
  • Return geocoding coordinates along with address (in supported countries).
  • Filter output by state, distance from a lat/long point, Residence or Business, or ZIP Code (U.S. only).

Express Entry supports filtering of results in the U.S. by using an endpoint with specific criteria. Visit Melissa Docs for more information on Filtering.

Documentation

Useful Resources

Product Page

https://www.melissa.com/address-autocomplete

Support Center

https://www.melissa.com/company/product-support

Download OpenAPI description
global-express-entry.json
global-express-entry.yaml
Languages
Servers
Global Express Entry Server
https://expressentry.melissadata.net/web/
Global Express Entry Server for Javascript response
https://expressentry.melissadata.net/jsonp/

Address Autocompletion

Use these endpoints to complete partial inputs with a verified address.

Operations

Global Express Address

Request

The GlobalExpressAddress service is consumed to retrieve results containing all of the available address elements of an address record.

A typical use of the GlobalExpressAddress method is preceded by a call to the GlobalExpressPostalCode service. The GlobalExpressPostalCode service is provided as a means of retrieving postal code, locality, and administrative area combinations using the postal code as the search input.

Query
colsstring

Columns - Entering the column name will return the column. Specifying a group name will return all columns in the group. Delimit multiple columns with a ,.

  • gbextras - GB Only. Return UPRN (SourceID) and UDPRN (SupplierID) values for each address. These will be in the Extras element.
  • results - US Only. Return Address Object result codes for each address in the Extras field. For example, a USPS only address will return "AddrObjectResultCode": "AS01".
Enum"gbextras""results"
Example: cols=gbextras
diacriticreplaceboolean

True replaces diacritics in the address. False will keep current diacritics in the address results. If left blank, this defaults to False.

Enumtruefalse
Example: diacriticreplace=true
formatstring

Desired format of the response. Possible values are json, jsonp, or xml, depending on the endpoint.

Note: the base URL for JavaScript format request is https://expressentry.melissadata.net/jsonp/.

Enum"xml""json""jsonp"
Example: format=json
idstring(password)required

The License Key issued by Melissa.

Example: id={REPLACE-WITH-YOUR-LICENSE-KEY}
maxrecordsnumber<= 100

Maximum number of records to return.

Default 10
Example: maxrecords=20
nativecharsetboolean

True, False, or blank. When set to True, return results in the native character set for the country. When set to False, return transliterated results in the Latin character set. When set to blank &nativecharset=, return results in the input character set.

Enumtruefalse
Example: nativecharset=true
optstring

Options to modify the output.

  • poboxes:< true | false > - true will allow P.O. Boxes and military addresses to be returned with U.S. Addresses.
Example: opt=poboxes:true
address1string

The input field for the address, delimited by %20 or a space. This should contain the street address information (house number, thoroughfare, building, suite, etc.)

address2string

An additional field for extra address lines.

administrativeareastring

Administrative Area, Province, State. The most common geographic data element.

Example: administrativearea=CA
countrystring

ISO-2 Code or full country name.

Default "US"
Example: country=US
localitystring

City, Locality, Municipality - The most common population center data element.

Example: locality=Rancho Santa Margarita
postalcodestringrequired

Postal Code, ZIP. The complete postal code.

Example: postalcode=92688
curl -i -X GET \
  'https://expressentry.melissadata.net/web/GlobalExpressAddress?id={REPLACE-WITH-YOUR-LICENSE-KEY}&postalcode=92688'

Responses

Global Express Address response

Body
Versionstring

The current service version number.

ResultCodestring

Lists result codes for the most recent request. For more information, see Global Express Entry Result Codes.

ErrorStringstring

Lists error codes from any errors caused by the most recent request. For more information, see Global Express Entry Result Codes.

ResultsArray of objects

Array with Address array(s) containing the record level fields.

Response
{
  "Version": "8.0.0.1249",
  "ResultCode": "XS02",
  "ErrorString": "",
  "Results": [
    { … },
    { … }
  ]
}

Global Express Country

Request

The GlobalExpressCountry endpoint returns the country names containing the search term in the Country= parameter. Country names in five languages are returned:

  • English
  • Spanish
  • French
  • German
  • Simplified Chinese.
Query
idstring(password)required

The License Key issued by Melissa.

Example: id={REPLACE-WITH-YOUR-LICENSE-KEY}
countrystring

ISO-2 Code or full country name.

Default "US"
Example: country=US
formatstring

Desired format of the response. Possible values are json, jsonp, or xml, depending on the endpoint.

Note: the base URL for JavaScript format request is https://expressentry.melissadata.net/jsonp/.

Enum"xml""json""jsonp"
Example: format=json
curl -i -X GET \
  'https://expressentry.melissadata.net/web/GlobalExpressCountry?id={REPLACE-WITH-YOUR-LICENSE-KEY}'

Responses

Global Express Country response

Body
Versionstring

The current service version number.

ResultCodestring

Lists result codes for the most recent request. For more information, see Global Express Entry Result Codes.

ErrorStringstring

Lists error codes from any errors caused by the most recent request. For more information, see Global Express Entry Result Codes.

ResultsArray of objects(GlobalExpressCountry_Result)

Array containing the record level fields.

Response
{
  "Version": "8.0.0.1249",
  "ResultCode": "XS01",
  "ErrorString": "",
  "Results": [
    { … },
    { … }
  ]
}

Global Express Free Form

Request

The GlobalExpressFreeForm service is provided as a means of retrieving all available address elements using a free form search.

Query
colsstring

Columns - Entering the column name will return the column. Specifying a group name will return all columns in the group. Delimit multiple columns with a ,.

  • gbextras - GB Only. Return UPRN (SourceID) and UDPRN (SupplierID) values for each address. These will be in the Extras element.
  • results - US Only. Return Address Object result codes for each address in the Extras field. For example, a USPS only address will return "AddrObjectResultCode": "AS01".
Enum"gbextras""results"
Example: cols=gbextras
diacriticreplaceboolean

True replaces diacritics in the address. False will keep current diacritics in the address results. If left blank, this defaults to False.

Enumtruefalse
Example: diacriticreplace=true
formatstring

Desired format of the response. Possible values are json, jsonp, or xml, depending on the endpoint.

Note: the base URL for JavaScript format request is https://expressentry.melissadata.net/jsonp/.

Enum"xml""json""jsonp"
Example: format=json
idstring(password)required

The License Key issued by Melissa.

Example: id={REPLACE-WITH-YOUR-LICENSE-KEY}
maxrecordsnumber<= 100

Maximum number of records to return.

Default 10
Example: maxrecords=20
nativecharsetboolean

True, False, or blank. When set to True, return results in the native character set for the country. When set to False, return transliterated results in the Latin character set. When set to blank &nativecharset=, return results in the input character set.

Enumtruefalse
Example: nativecharset=true
optstring

Options to modify the output.

  • poboxes:< true | false > - true will allow P.O. Boxes and military addresses to be returned with U.S. Addresses.
Example: opt=poboxes:true
countrystring

ISO-2 Code or full country name.

Default "US"
Example: country=US
ffstring

Free Form input.

Example: ff=22382+Avenida+Empresa,+Rancho+Santa+Margarita,+CA+92688
curl -i -X GET \
  'https://expressentry.melissadata.net/web/GlobalExpressFreeForm?id={REPLACE-WITH-YOUR-LICENSE-KEY}'

Responses

Global Express Free Form response

Body
Versionstring

The current service version number.

ResultCodestring

Lists result codes for the most recent request. For more information, see Global Express Entry Result Codes.

ErrorStringstring

Lists error codes from any errors caused by the most recent request. For more information, see Global Express Entry Result Codes.

ResultsArray of objects

Array with Address array(s) containing the record level fields.

Response
{
  "Version": "8.0.0.1249",
  "ResultCode": "XS02",
  "ErrorString": "",
  "Results": [
    { … },
    { … }
  ]
}

Global Express Locality & Administrative Area

Request

GlobalExpressLocalityAdministrativeArea is provided as a means of retrieving locality and administrative area combinations using the locality name.

Query
diacriticreplaceboolean

True replaces diacritics in the address. False will keep current diacritics in the address results. If left blank, this defaults to False.

Enumtruefalse
Example: diacriticreplace=true
formatstring

Desired format of the response. Possible values are json, jsonp, or xml, depending on the endpoint.

Note: the base URL for JavaScript format request is https://expressentry.melissadata.net/jsonp/.

Enum"xml""json""jsonp"
Example: format=json
idstring(password)required

The License Key issued by Melissa.

Example: id={REPLACE-WITH-YOUR-LICENSE-KEY}
maxrecordsnumber<= 100

Maximum number of records to return.

Default 10
Example: maxrecords=20
nativecharsetboolean

True, False, or blank. When set to True, return results in the native character set for the country. When set to False, return transliterated results in the Latin character set. When set to blank &nativecharset=, return results in the input character set.

Enumtruefalse
Example: nativecharset=true
administrativeareastring

Administrative Area, Province, State. The most common geographic data element.

Example: administrativearea=CA
countrystring

ISO-2 Code or full country name.

Default "US"
Example: country=US
localitystring

City, Locality, Municipality - The most common population center data element.

Example: locality=Rancho Santa Margarita
postalcodestringrequired

Postal Code, ZIP. The complete postal code.

Example: postalcode=92688
curl -i -X GET \
  'https://expressentry.melissadata.net/web/GlobalExpressLocalityAdministrativeArea?id={REPLACE-WITH-YOUR-LICENSE-KEY}&postalcode=92688'

Responses

Global Express Locality Administrative Area response

Body
Versionstring

The current service version number.

ResultCodestring

Lists result codes for the most recent request. For more information, see Global Express Entry Result Codes.

ErrorStringstring

Lists error codes from any errors caused by the most recent request. For more information, see Global Express Entry Result Codes.

ResultsArray of objects

Array with Address array(s) containing the record level fields.

Response
{
  "Version": "8.0.0.1249",
  "ResultCode": "XS02",
  "ErrorString": "",
  "Results": [
    { … },
    { … }
  ]
}

Global Express Postal Code

Request

GlobalExpressPostalCode is provided as a convenient method for quickly retrieving locality and administrative area information using the postal code as the input. A subsequent call to GlobalExpressAddress benefits greatly by using the locality and administrative area information from GlobalExpressPostalCode with GlobalExpressLocalityAdministrativeArea.

Query
diacriticreplaceboolean

True replaces diacritics in the address. False will keep current diacritics in the address results. If left blank, this defaults to False.

Enumtruefalse
Example: diacriticreplace=true
formatstring

Desired format of the response. Possible values are json, jsonp, or xml, depending on the endpoint.

Note: the base URL for JavaScript format request is https://expressentry.melissadata.net/jsonp/.

Enum"xml""json""jsonp"
Example: format=json
idstring(password)required

The License Key issued by Melissa.

Example: id={REPLACE-WITH-YOUR-LICENSE-KEY}
maxrecordsnumber<= 100

Maximum number of records to return.

Default 10
Example: maxrecords=20
countrystring

ISO-2 Code or full country name.

Default "US"
Example: country=US
postalcodestringrequired

Postal Code, ZIP. The complete postal code.

Example: postalcode=92688
curl -i -X GET \
  'https://expressentry.melissadata.net/web/GlobalExpressPostalCode?id={REPLACE-WITH-YOUR-LICENSE-KEY}&postalcode=92688'

Responses

Global Express Locality Administrative Area response

Body
Versionstring

The current service version number.

ResultCodestring

Lists result codes for the most recent request. For more information, see Global Express Entry Result Codes.

ErrorStringstring

Lists error codes from any errors caused by the most recent request. For more information, see Global Express Entry Result Codes.

ResultsArray of objects

Array with Address array(s) containing the record level fields.

Response
{
  "Version": "8.0.0.1249",
  "ResultCode": "XS02",
  "ErrorString": "",
  "Results": [
    { … },
    { … }
  ]
}

Global Express Thoroughfare

Request

GlobalExpressThoroughfare is a means for retrieving the thoroughfares within a Postal Code using the Postal Code and beginning of the thoroughfare name as the inputs.

Query
diacriticreplaceboolean

True replaces diacritics in the address. False will keep current diacritics in the address results. If left blank, this defaults to False.

Enumtruefalse
Example: diacriticreplace=true
formatstring

Desired format of the response. Possible values are json, jsonp, or xml, depending on the endpoint.

Note: the base URL for JavaScript format request is https://expressentry.melissadata.net/jsonp/.

Enum"xml""json""jsonp"
Example: format=json
idstring(password)required

The License Key issued by Melissa.

Example: id={REPLACE-WITH-YOUR-LICENSE-KEY}
maxrecordsnumber<= 100

Maximum number of records to return.

Default 10
Example: maxrecords=20
countrystring

ISO-2 Code or full country name.

Default "US"
Example: country=US
postalcodestringrequired

Postal Code, ZIP. The complete postal code.

Example: postalcode=92688
thoroughfarestring

Street, Thoroughfare. This is used to limit the search to thoroughfares beginning with the specified letters. This requires a minimum of three characters. For example, mai will return all thoroughfares beginning with mai in the specified postal code.

curl -i -X GET \
  'https://expressentry.melissadata.net/web/GlobalExpressThoroughfare?id={REPLACE-WITH-YOUR-LICENSE-KEY}&postalcode=92688'

Responses

Global Express Locality Administrative Area response

Body
Versionstring

The current service version number.

ResultCodestring

Lists result codes for the most recent request. For more information, see Global Express Entry Result Codes.

ErrorStringstring

Lists error codes from any errors caused by the most recent request. For more information, see Global Express Entry Result Codes.

ResultsArray of objects

Array with Address array(s) containing the record level fields.

Response
{
  "Version": "8.0.0.1249",
  "ResultCode": "XS02",
  "ErrorString": "",
  "Results": [
    { … },
    { … }
  ]
}