Global Express Entry

Introduction

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

Click here to learn more about the Global Express Entry Cloud API.

Licensing

The License Key is a software key required to use the web service. You will receive your license key from your Melissa representative. If you don’t have a license key, contact the Melissa sales team at Sales@Melissa.com or 800-MELISSA ext. 3 (800-635-4772 ext. 3). Without a license key, Global Express Entry will not function.

Initialization

There are two different constructors that you can utilize when initializing Global Express Entry.

GlobalExpressEntry(string license)

Initialize the Cloud API object with a license key

Note

MELISSA_LICENSE_KEY is replaced with your license.

Get your license key here

• C#
• Python

GlobalExpressEntry globalExpressEntry = new GlobalExpressEntry(MELISSA_LICENSE_KEY);

global_express_entry = GlobalExpressEntry(MELISSA_LICENSE_KEY)

GlobalExpressEntry()

Initialize the Cloud API object, which will read the license key from the environment variable MD_LICENSE or configured using a set method

Click here to learn more about setting up the environment variable.

• C#
• Python

GlobalExpressEntry globalExpressEntry = new GlobalExpressEntry()

global_express_entry = GlobalExpressEntry()

Configuration

Global Express Entry supports GET requests.

Requests

GET

To send a GET request, there are three ways you can configure the parameters to make a request.

• Method 1: Using the Set Value Method to specify the parameter and value you want to set it to

• Method 2: Using direct property access to set parameter values

• Method 3: Using specialized Set Methods to set parameter values

Method 1: Using Set Value Method

This function allows you to specify input parameters and the values you went to set them to.

Format

Note

Replace ADDRESS_LINE_1, CITY, STATE, and POSTAL_CODE with variables or values.

• C#
• Python

globalExpressEntry.SetValue("AddressLine1", ADDRESS_LINE_1);
globalExpressEntry.SetValue("City", CITY);
globalExpressEntry.SetValue("State", STATE);
globalExpressEntry.SetValue("Postal", POSTAL_CODE);

global_express_entry.set_value("address_line_1", ADDRESS_LINE_1)
global_express_entry.set_value("city", LOCALITY)
global_express_entry.set_value("state", ADMINISTRATIVE_AREA)
global_express_entry.set_value("postal", POSTAL_CODE)

Example

• C#
• Python

globalExpressEntry.SetValue("AddressLine1", "22382 Avenida Empresa");
globalExpressEntry.SetValue("City", "RSM");
globalExpressEntry.SetValue("State", "CA");
globalExpressEntry.SetValue("Postal", "92688");

global_express_entry.set_value("address_line_1", "22382 Avenida Empresa")
global_express_entry.set_value("city", "RSM")
global_express_entry.set_value("state", "CA")
global_express_entry.set_value("postal", "92688")

Method 2: Using Direct Property Access

This allows you to set values directly using the Cloud API’s parameter names.

Format

Note

Replace ADDRESS_LINE_1, CITY, STATE, and POSTAL_CODE with variables or values.

• C#
• Python

globalExpressEntry.AddressLine1 = ADDRESS_LINE_1;
globalExpressEntry.City = CITY;
globalExpressEntry.State = STATE;
globalExpressEntry.Postal = POSTAL_CODE;

global_express_entry.address_line_1 = ADDRESS_LINE_1
global_express_entry.city = CITY
global_express_entry.state = STATE
global_express_entry.postal = POSTAL_CODE

Example

• C#
• Python

globalExpressEntry.AddressLine1 = "22382 Avenida Empresa";
globalExpressEntry.City = "Rancho Santa Margarita";
globalExpressEntry.State = "CA";
globalExpressEntry.Postal = "92688";

global_express_entry.address_line_1 = "22382 Avenida Empresa"
global_express_entry.city = "Rancho Santa Margarita"
global_express_entry.state = "CA"
global_express_entry.postal = "92688"

Method 3: Using Specialized Methods

These functions allow you to set the input parameters for the Cloud API.

See Set Methods for a list of available parameters.

Format

Note

Replace ADDRESS_LINE_1, CITY, STATE, and POSTAL_CODE with variables or values.

• C#
• Python

globalExpressEntry.SetAddressLine1(ADDRESS_LINE_1);
globalExpressEntry.SetCity(CITY);
globalExpressEntry.SetState(STATE);
globalExpressEntry.SetPostal(POSTAL_CODE);

global_express_entry.set_address_line_1(ADDRESS_LINE_1)
global_express_entry.set_city(CITY)
global_express_entry.set_state(STATE)
global_express_entry.set_postal(POSTAL_CODE)

Example

• C#
• Python

globalExpressEntry.SetAddressLine1("22382 Avenida Empresa");
globalExpressEntry.SetCity("Rancho Santa Margarita");
globalExpressEntry.SetState("CA");
globalExpressEntry.SetPostal("92688");

global_express_entry.set_address_line_1("22382 Avenida Empresa")
global_express_entry.set_city("Rancho Santa Margarita")
global_express_entry.set_state("CA")
global_express_entry.set_postal("92688")

Response

When submitting a request, you have the option to either get the response as a string or encapsulate the response into the respective Cloud API response object. The Global Express Entry Cloud API has two different response objects that you can use the encapsulate the response.

When using global related endpoints, please use the GlobalExpressEntryResponse class. When using normal express endpoints, please use the ExpressEntryResponse class.

As a String

Submit a GET request and get the response as a string.

• C#
• Python

string response = globalExpressEntry.GetExpressAddress<string>();

response = global_express_entry.get(str)

As a Response Object

Submit a GET request and encapsulate the response into the Cloud API response object.

Global Express Entry

• C#
• Python

GlobalExpressEntryResponse responseObject = globalExpressEntry.GetGlobalExpressAddress<GlobalExpressEntryResponse>();

response_object = global_express_entry.get_global_express_address(GlobalExpressEntryResponse)

Express Entry

• C#
• Python

ExpressEntryResponse responseObject = globalExpressEntry.GetExpressAddress<ExpressEntryResponse>();

response_object = global_express_entry.get_express_address(ExpressEntryResponse)

Accessing Values

When encapsulating the response into the Cloud API’s respective response object, there are three ways to access values. The response object structure matches the respective Cloud API’s response format.

Click here to learn more about the Global Express Entry response format.

The record responses are typically stored in a list. In the examples below, record represents an individual record at an arbitrary position within this list.

1. Using the Get Value Method:

Pass the field name as a string to the Get Value Method, and it will return the corresponding field value.

• C#
• Python

record.GetValue("RecordID");
record.GetValue("Results");

record.get_value("RecordID")
record.get_value("Results")

2. Accessing Properties directly

Values can be accessed directly using the response object’s field names.

• C#
• Python

record.RecordID;
record.Results;

record.record_id
record.results

3. Use Specialized Methods

Use get methods corresponding to field name to get the field value.

• C#
• Python

record.GetRecordID();
record.GetResults();

record.get_record_id()
record.get_results()

Methods

The methods listed below pertain to the Global Express Entry Cloud API object.

For methods related to the respective Cloud API’s response object click here.

Constructors

These methods initialize and configure instances of the Cloud API object. Use these methods to create a new object, optionally providing initial values such as a license string to customize the instance during its creation.

• C#
• Python

Method	Description
GlobalExpressEntry()	Constructor to initialize the Global Express Entry object.
GlobalExpressEntry(string license)	Constructor to initialize the Global Express Entry object with a license string.

Method	Description
GlobalExpressEntry()	Constructor to initialize the Global Express Entry object.
GlobalExpressEntry(license)	Constructor to initialize the Global Express Entry object with a license string.

Set Methods

These methods configure or modify parameters at the record level for the Cloud API object. Use these methods to make adjustments to the parameters during the execution of the Cloud API, ensuring flexibility in customizing API requests.

• C#
• Python

Method	Description
void SetBaseUrl(string baseUrl)	Set the base URL.
void SetLicense(string license)	Set the license string.
void SetEndpoint(string endpoint)	Set the endpoint.
void SetFormat(string format)	Set the format.
void SetAddressLine1(string addressLine1)	Set the address line 1.
void SetCity(string city)	Set the city.
void SetState(string state)	Set the state.
void SetPostal(string postal)	Set the postal code.
void SetFreeForm(string freeForm)	Set the free form.
void SetThoroughfare(string thoroughfare)	Set the thoroughfare.
void SetLocality(string locality)	Set the locality.
void SetAdministrativeArea(string administrativeArea)	Set the administrative area.
void SetCountry(string country)	Set the country.
void SetMaxRecords(string maxRecords)	Set the max records.
void SetOpt(string opt)	Set the option.
void SetCols(string cols)	Set the columns.
void SetNativeCharSet(string nativeCharSet)	Set the native character set.
void SetValue(string parameter, string value)	Set the input parameter to a specified value.

Method	Description
set_base_url(base_url)	Set the base URL.
set_license(license)	Set the license string.
set_endpoint(endpoint)	Set the endpoint.
set_format(format)	Set the format.
set_address_line_1(address_line_1)	Set the address line 1.
set_city(city)	Set the city.
set_state(state)	Set the state.
set_postal(postal)	Set the postal code.
set_free_form(free_form)	Set the free form.
set_thoroughfare(thoroughfare)	Set the thoroughfare.
set_locality(locality)	Set the locality.
set_administrative_area(administrative_area)	Set the administrative area.
set_country(country)	Set the country.
set_max_records(max_records)	Set the max records.
set_opt(opt)	Set the option.
set_cols(cols)	Set the columns.
set_native_char_set(native_char_set)	Set the native character set.
set_value(parameter, value)	Set the input parameter to a specified value.

Get Methods

These methods retrieve parameter values from the Cloud API object. Use these methods to access the parameters configured for the Cloud API at the record level, providing insight into the current state of the object’s settings.

• C#
• Python

Method	Description
string GetBaseUrl()	Get the base URL.
string GetLicense()	Get the license string.
string GetEndpoint()	Get the endpoint.
string GetFormat()	Get the format.
string GetAddressLine1()	Get the address line 1.
string GetCity()	Get the city.
string GetState()	Get the state.
string GetPostal()	Get the postal code.
string GetFreeForm()	Get the free form.
string GetThoroughfare()	Get the thoroughfare.
string GetLocality()	Get the locality.
string GetAdministrativeArea()	Get the administrative area.
string GetCountry()	Get the country.
string GetMaxRecords()	Get the max records.
string GetOpt()	Get the option.
string GetCols()	Get the columns.
string GetNativeCharSet()	Get the native character set.
void GetValue(string parameter)	Get the value of an input parameter.

Method	Description
get_base_url()	Get the base URL.
get_license()	Get the license string.
get_endpoint()	Get the endpoint.
get_format()	Get the format.
get_address_line_1()	Get the address line 1.
get_city()	Get the city.
get_state()	Get the state.
get_postal()	Get the postal code.
get_free_form()	Get the free form.
get_thoroughfare()	Get the thoroughfare.
get_locality()	Get the locality.
get_administrative_area()	Get the administrative area.
get_country()	Get the country.
get_max_records()	Get the max records.
get_opt()	Get the option.
get_cols()	Get the columns.
get_native_char_set()	Get the native character set.
get_value(parameter)	Get the value of an input parameter.

Class Methods

These methods perform service-level operations, handling the core processing and interactions for the Cloud API object. Use these methods to execute primary functionalities such as assembling records, clearing records, and making API requests.

• C#
• Python

Method	Description
T GetExpressAddress<T>()	Endpoint: /web/ExpressAddress Makes a synchronous GET request to the CloudAPI and returns the response (string or deserialized response object).
async Task<T> GetExpressAddressAsync<T>()	Endpoint: /web/ExpressAddress Makes an asynchronous GET request to the CloudAPI and returns the response.
T GetExpressCityState<T>()	Endpoint: /web/ExpressCityState Makes a synchronous GET request to the CloudAPI.
async Task<T> GetExpressCityStateAsync<T>()	Endpoint: /web/ExpressCityState Makes an asynchronous GET request to the CloudAPI.
T GetExpressPostalCode<T>()	Endpoint: /web/ExpressPostalCode Makes a synchronous GET request to the CloudAPI.
async Task<T> GetExpressPostalCodeAsync<T>()	Endpoint: /web/ExpressPostalCode Makes an asynchronous GET request.
T GetExpressStreet<T>()	Endpoint: /web/ExpressStreet Makes a synchronous GET request.
async Task<T> GetExpressStreetAsync<T>()	Endpoint: /web/ExpressStreet Makes an asynchronous GET request.
T GetExpressFreeForm<T>()	Endpoint: /web/ExpressFreeForm Makes a synchronous GET request.
async Task<T> GetExpressFreeFormAsync<T>()	Endpoint: /web/ExpressFreeForm Makes an asynchronous GET request.
T GetGlobalExpressAddress<T>()	Endpoint: /web/GlobalExpressAddress Makes a synchronous GET request.
async Task<T> GetGlobalExpressAddressAsync<T>()	Endpoint: /web/GlobalExpressAddress Makes an asynchronous GET request.
T GetGlobalExpressLocalityAdministrativeArea<T>()	Endpoint: /web/GlobalExpressLocalityAdministrativeArea Makes a synchronous GET request.
async Task<T> GetGlobalExpressLocalityAdministrativeAreaAsync<T>()	Endpoint: /web/GlobalExpressLocalityAdministrativeArea Makes an asynchronous GET request.
T GetGlobalExpressCountry<T>()	Endpoint: /web/GlobalExpressCountry Makes a synchronous GET request.
async Task<T> GetGlobalExpressCountryAsync<T>()	Endpoint: /web/GlobalExpressCountry Makes an asynchronous GET request.
T GetGlobalExpressFreeForm<T>()	Endpoint: /web/GlobalExpressFreeForm Makes a synchronous GET request.
async Task<T> GetGlobalExpressFreeFormAsync<T>()	Endpoint: /web/GlobalExpressFreeForm Makes an asynchronous GET request.
T GetGlobalExpressPostalCode<T>()	Endpoint: /web/GlobalExpressPostalCode Makes a synchronous GET request.
async Task<T> GetGlobalExpressPostalCodeAsync<T>()	Endpoint: /web/GlobalExpressPostalCode Makes an asynchronous GET request.
T GetGlobalExpressThoroughfare<T>()	Endpoint: /web/GlobalExpressThoroughfare Makes a synchronous GET request.
async Task<T> GetGlobalExpressThoroughfareAsync<T>()	Endpoint: /web/GlobalExpressThoroughfare Makes an asynchronous GET request.
string GetApiVersion()	Makes a synchronous getversion request and returns the parsed Cloud API version.
async Task<string> GetApiVersionAsync()	Makes an asynchronous getversion request and returns the parsed Cloud API version.

Method	Description
get_express_address(response_type)	Endpoint: /web/ExpressAddress Makes a synchronous GET request to the CloudAPI and returns the response.
get_express_address_async(response_type)	Endpoint: /web/ExpressAddress Makes an asynchronous GET request.
get_express_city_state(response_type)	Endpoint: /web/ExpressCityState Makes a synchronous GET request.
get_express_city_state_async(response_type)	Endpoint: /web/ExpressCityState Makes an asynchronous GET request.
get_express_postal_code(response_type)	Endpoint: /web/ExpressPostalCode Makes a synchronous GET request.
get_express_postal_code_async(response_type)	Endpoint: /web/ExpressPostalCode Makes an asynchronous GET request.
get_express_street(response_type)	Endpoint: /web/ExpressStreet Makes a synchronous GET request.
get_express_street_async(response_type)	Endpoint: /web/ExpressStreet Makes an asynchronous GET request.
get_express_free_form(response_type)	Endpoint: /web/ExpressFreeForm Makes a synchronous GET request.
get_express_free_form_async(response_type)	Endpoint: /web/ExpressFreeForm Makes an asynchronous GET request.
get_global_express_address(response_type)	Endpoint: /web/GlobalExpressAddress Makes a synchronous GET request.
get_global_express_address_async(response_type)	Endpoint: /web/GlobalExpressAddress Makes an asynchronous GET request.
get_global_express_locality_administrative_area(response_type)	Endpoint: /web/GlobalExpressLocalityAdministrativeArea Makes a synchronous GET request.
get_global_express_locality_administrative_area_async(response_type)	Endpoint: /web/GlobalExpressLocalityAdministrativeArea Makes an asynchronous GET request.
get_global_express_country(response_type)	Endpoint: /web/GlobalExpressCountry Makes a synchronous GET request.
get_global_express_country_async(response_type)	Endpoint: /web/GlobalExpressCountry Makes an asynchronous GET request.
get_global_express_free_form(response_type)	Endpoint: /web/GlobalExpressFreeForm Makes a synchronous GET request.
get_global_express_free_form_async(response_type)	Endpoint: /web/GlobalExpressFreeForm Makes an asynchronous GET request.
get_global_express_postal_code(response_type)	Endpoint: /web/GlobalExpressPostalCode Makes a synchronous GET request.
get_global_express_postal_code_async(response_type)	Endpoint: /web/GlobalExpressPostalCode Makes an asynchronous GET request.
get_global_express_thoroughfare(response_type)	Endpoint: /web/GlobalExpressThoroughfare Makes a synchronous GET request.
get_global_express_thoroughfare_async(response_type)	Endpoint: /web/GlobalExpressThoroughfare Makes an asynchronous GET request.
get_api_version()	Makes a synchronous getversion request and returns the parsed Cloud API version.
get_api_version_async()	Makes an asynchronous getversion request and returns the parsed Cloud API version.