Sign in

v1

OpenAPI 3.1.22026-08-0661077.2 KB
Address Autocompletion

Global Express Free Form

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

get/GlobalExpressFreeForm

Query parameters

cols'gbextras' | 'results'

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".
diacriticreplacetrue | false

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

format'xml' | 'json' | 'jsonp'

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

idstring password required

Required. The License Key issued by Melissa.

maxrecordsnumber

The maximum number of records to return.

nativecharsettrue | false

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.

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.
countrystring required

Required. The ISO2Code or country name of the address.

ffstring required

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

Headers

Accept'application/json' | 'application/javascript' | '*/*' required

Format of the response.

Content-Type'application/json' | 'application/xml' | 'application/javascript' | '*/*' required
Example:*/*

Format of the request.

Response

Global Express Free Form response

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.