Express Entry:GlobalExpressFreeForm

← Global Express Entry

URL

REST

Use	URL
Standard	http://expressentry.melissadata.net/web/GlobalExpressFreeForm
Secure	https://expressentry.melissadata.net/web/GlobalExpressFreeForm

JSON

Use	URL
Standard	http://expressentry.melissadata.net/jsonp/GlobalExpressFreeForm
Secure	https://expressentry.melissadata.net/jsonp/GlobalExpressFreeForm

GlobalExpressFreeForm

The GlobalExpressFreeForm service is provided as a means of retrieving all available address elements using a free form search. GlobalExpressFreeForm returns FormattedAddress, AddressLine1-8, CountryISO3166_1_Alpha2, CountryISO3166_1_Alpha3, CountryISO3166_1_Numeric, SubNationalArea, PremisesNumber, AdministrativeArea, SubadministrativeArea, locality, dependentlocality, doubledependentlocality, thoroughfare, dependentthoroughfare, building, postalcode, and postbox.

Example Call

http://expressentry.melissadata.net/web/GlobalExpressFreeForm?format={FORMAT}&id={ID}&ff={FF}&country={COUNTRY}&maxrecords={MAXRECORDS}&nativecharset={True|False|(blank)}&opt={poboxes:true}&cols={gbextras,results}

Requested Field	Input	Description
Format	{XML, JSON}	The return format of the request.
ID	Text	The License Key or token
FF	Text	The Free Form request.
Country	Text	The ISO2Code or country name of the address (required, Default US).
Maxrecords	Number	The maximum number of records to return (required). (Default 10, Maximum 100)
Nativecharset	True/False/Blank	Optional. Return results in the native character set for the country.
Opt	poboxes:true	US Only: Return P.O. Boxes and military addresses
Cols	gbextras	GB Only: Return UPRN (SourceID) and UDPRN (SupplierID) values for each address.
	results	Return Address Object result codes for each address in the Extras field.

Schema

?format=

The response will be formatted according to the value set here.

Valid values are: XML and JSON.

&id=

The ID element can contain your user ID, a complete License Key, or a token.

&ff=

The service uses this term to complete addresses in Free Form. Searches use the allwords search.

&country=

The ISO2Code or full country name of the country to search (Default US).

&maxrecords=

Maxrecords is provided to control the number of results returned from a request to the service.

The default value is 10 and the maximum is 100 records.

&nativecharset=

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.

&opt=

• When set to poboxes:true, U.S. Addresses will return P.O. Boxes and military addresses along with the usual address results. Multiple options for &opt can be delimited by semicolon.

&cols=

• When set to gbextras this will return UPRN and UDPRN values for each address. These will be in the Extras element.
• When set to results this will return the Address Object result codes for each address in the Extras field. For example, a USPS only address will return AddrObjectResultCode": "AS01".

Extras

If you specify &cols=gbextras in the request options, we will return additional outputs. These outputs are presented in a different format. They will look like this below.

<Extras>
    <root>
        <extra>
            <key>UDPRN</key>
            <value>25877698</value>
        </extra>
        <extra>
            <key>UPRN</key>
            <value>217122173</value>
        </extra>
    </root>
</Extras>

Here are the possible output and groups:

Output Name	Description
UDPRN	The Unique Delivery Point Reference Number issued by Royal Mail. This is an 8-digit unique number.
UPRN	The Unique Property Reference Number issued by Royal Mail. This is a number unique to each address in GB. This is a unique number up to 12-digits long.