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.

Enum:truefalse

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

Required. The License Key issued by Melissa.

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

maxrecordsnumber, <= 100

The 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.

Enum:truefalse

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

suitecompressionboolean

Default set to True .When set to True this consolidates all suites/apartments/buildings at one address into a single result, using comma-delimited lists for the relevant fields.

SubBuilding - apt/suite/building identifiers.
PostalCodeSecondary - ZIP+4 codes for each unit.
MAK - MelissaAddressKey for each unit.

When set to False will return each suite/apartment as its own individual record.

Default:true

Enum:truefalse

countrystringrequired

Required. The ISO2Code or country name of the address.

Default:"US"

Example:country=US

ffstringrequired

Required. The free form address, with search terms delimited by %20 or a space.

Example:ff=22382+Avenida+Empresa,+Rancho+Santa+Margarita,+CA+92688

Acceptstringrequired

Format of the response.

Enum:"application/json""application/javascript""*/*"

Example:*/*

Content-Typestringrequired

Format of the request.

Enum:"application/json""application/xml""application/javascript""*/*"

Example:*/*

curl -i -X GET \
  'https://expressentry.melissadata.net/web/GlobalExpressFreeForm?id=%7BREPLACE-WITH-YOUR-LICENSE-KEY%7D&country=US&ff=22382%2BAvenida%2BEmpresa%2C%2BRancho%2BSanta%2BMargarita%2C%2BCA%2B92688' \
  -H 'Accept: */*' \
  -H 'Content-Type: */*'

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": [
    { … },
    { … }
  ]
}