Reference Guide#
Introduction#
Global Express Entry consists of a Web service and support code that enable more accurate and convenient entry of address data by checking data as it is typed. Adding to your code is simple: just implement a solution in Visual Studio or use Javascript to connect to the Web service (sample code is provided). The result will be less time and labor lost due to common errors such as misspellings and wrong ZIP codes. Express Entry enables you to accomplish this with a minimum of coding time and can reduce the number of keystrokes required to enter address data.
Global Express Entry can:
Save time and effort by completing addresses with less than 1/2 of the keystrokes necessary to type the full address, checked against Melissa Data’s Multi-sourced data.
Validate addresses while they are being typed in, making sure that as addresses are added, misspellings and other errors are prevented.
Be implemented as a Web service client using REST in a language such as C#, Visual BASIC, or Javascript (examples provided).
Respond quickly to requests, enabling the user to find related addresses easily.
Correct for missing address components by adding elements such as suffixes where the user didn’t know they existed.
Base URL#
https://expressentry.melissadata.net
New to Melissa Cloud Services?#
We highly recommend first time users of our web services to review our Using Melissa Cloud APIs section. It will cover critical topics like:
Endpoints#
/web/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
postbox
Try It Now#
curl -X GET "https://expressentry.melissadata.net/web/GlobalExpressFreeForm?\
&cols=\
&format=json\
&id={{customerId}}\
&maxrecords=10\
&nativecharset=true\
&opt=\
&country=US\
&ff=22382+Avenida+Empresa,+Rancho+Santa+Margarita,+CA+92688" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
curl -X GET "https://expressentry.melissadata.net/web/GlobalExpressFreeForm?\
&cols=\
&format=xml\
&id={{customerId}}\
&maxrecords=10\
&nativecharset=true\
&opt=\
&country=US\
&ff=22382+Avenida+Empresa,+Rancho+Santa+Margarita,+CA+92688" \
-H "Content-Type: application/xml" \
-H "Accept: */*"
curl -X GET "https://expressentry.melissadata.net/jsonp/GlobalExpressFreeForm?\
&cols=\
&format=json\
&id={{customerId}}\
&maxrecords=10\
&nativecharset=true\
&opt=\
&country=US\
&ff=22382+Avenida+Empresa,+Rancho+Santa+Margarita,+CA+92688" \
-H "Content-Type: application/javascript" \
-H "Accept: application/javascript"
Request Parameters#
Code |
Description |
|---|---|
Record Level Parameters |
|
|
Specifies which column(s) to be output as a comma delimited string. See Columns for more information. |
|
|
|
Desired format of the response. Possible values are |
|
The License Key issued by Melissa. |
|
The maximum number of records to return. The default is |
|
|
|
|
Address Parameters |
|
|
Default set to US. The ISO2Code or country name of the address. |
|
The free form address, with search terms delimited by |
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 ,.
Column |
Returned Values |
|---|---|
|
GB Only. Return UPRN (SourceID) and UDPRN (SupplierID) values for each address. These will be in the |
|
US Only. Return Address Object result codes for each address in the Extras field. For example, a USPS only address will return |
Filtering#
The GlobalExpressFreeForm endpoint supports filtering. For more information on available filters and examples, see the following page:
Options#
List options in the following format, with multiple options delimited with a ;.
OptionName:Parameter;OptionName:Parameter
poboxes#
This options allows P.O. Boxes and military addresses to be returned with U.S. Addresses.
Parameter |
Description |
|---|---|
|
U.S. Addresses will return P.O. Boxes and military addresses. |
|
P.O. Boxes and military addresses will not be returned. |
Headers#
Content-Type: application/json
Accept: application/json
Content-Type: application/xml
Accept: application/xml
Content-Type: application/javascript
Accept: application/javascript
Response#
{
"Version": "8.0.0.1249",
"ResultCode": "XS01",
"ErrorString": "",
"Results": [
{
"Address": {
"Address": "22382 Avenida Empresa, Rancho Santa Margarita, CA 92688-2112",
"Address1": "22382 Avenida Empresa",
"Address2": "Rancho Santa Margarita, CA 92688-2112",
"Address3": "",
"Address4": "",
"Address5": "",
"Address6": "",
"Address7": "",
"Address8": "",
"Address9": "",
"Address10": "",
"Address11": "",
"Address12": "",
"DeliveryAddress": "22382 Avenida Empresa",
"DeliveryAddress1": "22382 Avenida Empresa",
"DeliveryAddress2": "",
"DeliveryAddress3": "",
"DeliveryAddress4": "",
"DeliveryAddress5": "",
"DeliveryAddress6": "",
"DeliveryAddress7": "",
"DeliveryAddress8": "",
"DeliveryAddress9": "",
"DeliveryAddress10": "",
"DeliveryAddress11": "",
"DeliveryAddress12": "",
"CountryName": "United States Of America",
"ISO3166_2": "US",
"ISO3166_3": "USA",
"ISO3166_N": "840",
"SuperAdministrativeArea": "",
"AdministrativeArea": "CA",
"SubAdministrativeArea": "Orange",
"Locality": "Rancho Santa Margarita",
"CityAccepted": "Rancho Sta Marg,Rsm,Rcho Sta Marg",
"CityNotAccepted": "",
"DependentLocality": "",
"DoubleDependentLocality": "",
"Thoroughfare": "Avenida Empresa",
"DependentThoroughfare": "",
"Building": "",
"Premise": "22382",
"SubBuilding": "",
"PostalCode": "92688-2112",
"PostalCodePrimary": "92688",
"PostalCodeSecondary": "2112",
"Organization": "",
"PostBox": "",
"Unmatched": "",
"GeneralDelivery": "",
"DeliveryInstallation": "",
"Route": "",
"AdditionalContent": "",
"CountrySubdivisionCode": "US-CA",
"MAK": "8008006245",
"BaseMAK": "",
"Latitude": "33.637562",
"Longitude": "-117.606887",
"DistanceFromPoint": 0
}
}
]
}
<ResponseGlobal
xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Version>8.0.0.1249</Version>
<ResultCode>XS01</ResultCode>
<ErrorString></ErrorString>
<Results>
<ResultGlobal>
<Address>
<Address>22382 Avenida Empresa, Rancho Santa Margarita, CA 92688-2112</Address>
<Address1>22382 Avenida Empresa</Address1>
<Address2>Rancho Santa Margarita, CA 92688-2112</Address2>
<Address3></Address3>
<Address4></Address4>
<Address5></Address5>
<Address6></Address6>
<Address7></Address7>
<Address8></Address8>
<Address9></Address9>
<Address10></Address10>
<Address11></Address11>
<Address12></Address12>
<DeliveryAddress>22382 Avenida Empresa</DeliveryAddress>
<DeliveryAddress1>22382 Avenida Empresa</DeliveryAddress1>
<DeliveryAddress2></DeliveryAddress2>
<DeliveryAddress3></DeliveryAddress3>
<DeliveryAddress4></DeliveryAddress4>
<DeliveryAddress5></DeliveryAddress5>
<DeliveryAddress6></DeliveryAddress6>
<DeliveryAddress7></DeliveryAddress7>
<DeliveryAddress8></DeliveryAddress8>
<DeliveryAddress9></DeliveryAddress9>
<DeliveryAddress10></DeliveryAddress10>
<DeliveryAddress11></DeliveryAddress11>
<DeliveryAddress12></DeliveryAddress12>
<CountryName>United States Of America</CountryName>
<ISO3166_2>US</ISO3166_2>
<ISO3166_3>USA</ISO3166_3>
<ISO3166_N>840</ISO3166_N>
<SuperAdministrativeArea></SuperAdministrativeArea>
<AdministrativeArea>CA</AdministrativeArea>
<SubAdministrativeArea>Orange</SubAdministrativeArea>
<Locality>Rancho Santa Margarita</Locality>
<CityAccepted>Rancho Sta Marg,Rsm,Rcho Sta Marg</CityAccepted>
<CityNotAccepted></CityNotAccepted>
<DependentLocality></DependentLocality>
<DoubleDependentLocality></DoubleDependentLocality>
<Thoroughfare>Avenida Empresa</Thoroughfare>
<DependentThoroughfare></DependentThoroughfare>
<Building></Building>
<Premise>22382</Premise>
<SubBuilding></SubBuilding>
<PostalCode>92688-2112</PostalCode>
<PostalCodePrimary>92688</PostalCodePrimary>
<PostalCodeSecondary>2112</PostalCodeSecondary>
<Organization></Organization>
<PostBox></PostBox>
<Unmatched></Unmatched>
<GeneralDelivery></GeneralDelivery>
<DeliveryInstallation></DeliveryInstallation>
<Route></Route>
<AdditionalContent></AdditionalContent>
<CountrySubdivisionCode>US-CA</CountrySubdivisionCode>
<MAK>8008006245</MAK>
<BaseMAK></BaseMAK>
<Latitude>33.637562</Latitude>
<Longitude>-117.606887</Longitude>
<DistanceFromPoint>0</DistanceFromPoint>
</Address>
</ResultGlobal>
</Results>
</ResponseGlobal>
{
"d": {
"__type": "ResponseGlobal",
"Version": "8.0.0.1249",
"ResultCode": "XS01",
"ErrorString": "",
"Results": [
{
"__type": "ResultGlobal",
"Address": {
"__type": "AddressGlobal",
"Address": "22382 Avenida Empresa, Rancho Santa Margarita, CA 92688-2112",
"Address1": "22382 Avenida Empresa",
"Address2": "Rancho Santa Margarita, CA 92688-2112",
"Address3": "",
"Address4": "",
"Address5": "",
"Address6": "",
"Address7": "",
"Address8": "",
"Address9": "",
"Address10": "",
"Address11": "",
"Address12": "",
"DeliveryAddress": "22382 Avenida Empresa",
"DeliveryAddress1": "22382 Avenida Empresa",
"DeliveryAddress2": "",
"DeliveryAddress3": "",
"DeliveryAddress4": "",
"DeliveryAddress5": "",
"DeliveryAddress6": "",
"DeliveryAddress7": "",
"DeliveryAddress8": "",
"DeliveryAddress9": "",
"DeliveryAddress10": "",
"DeliveryAddress11": "",
"DeliveryAddress12": "",
"CountryName": "United States Of America",
"ISO3166_2": "US",
"ISO3166_3": "USA",
"ISO3166_N": "840",
"SuperAdministrativeArea": "",
"AdministrativeArea": "CA",
"SubAdministrativeArea": "Orange",
"Locality": "Rancho Santa Margarita",
"CityAccepted": "Rancho Sta Marg,Rsm,Rcho Sta Marg",
"CityNotAccepted": "",
"DependentLocality": "",
"DoubleDependentLocality": "",
"Thoroughfare": "Avenida Empresa",
"DependentThoroughfare": "",
"Building": "",
"Premise": "22382",
"SubBuilding": "",
"PostalCode": "92688-2112",
"PostalCodePrimary": "92688",
"PostalCodeSecondary": "2112",
"Organization": "",
"PostBox": "",
"Unmatched": "",
"GeneralDelivery": "",
"DeliveryInstallation": "",
"Route": "",
"AdditionalContent": "",
"CountrySubdivisionCode": "US-CA",
"MAK": "8008006245",
"BaseMAK": "",
"Latitude": "33.637562",
"Longitude": "-117.606887",
"DistanceFromPoint": 0
}
}
]
}
}
Service Level Response Fields#
Output Name |
Description |
|---|---|
ErrorString |
Lists error codes from any errors caused by the most recent request. |
ResultCode |
Lists result codes for the most recent request. |
Results |
Array with Address array(s) containing the record level fields. |
Version |
The current service version number. |
Record Level Response Fields#
Output Name |
Description |
|---|---|
AdditionalContent |
Any additional content associated with the address. |
Address |
The full address in one line. |
Address1 |
Address line 1. |
Address2 |
Address line 2. |
Address3 |
Address line 3. |
Address4 |
Address line 4. |
Address5 |
Address line 5. |
Address6 |
Address line 6. |
Address7 |
Address line 7. |
Address8 |
Address line 8. |
Address9 |
Address line 9. |
Address10 |
Address line 10. |
Address11 |
Address line 11. |
Address12 |
Address line 12. |
AdministrativeArea |
State, Province. This is a common geographic area unit for larger countries. |
BaseMAK |
Melissa Address Key Base. If the address has suites or apartments the 10 digit proprietary BaseMAK will be returned and correspond to the overall building. |
Building |
A descriptive name identifying an individual location. |
CityAccepted |
A list of accepted city names. |
CityNotAccepted |
Any non-accepted city names will be included in this field. |
CountryName |
The name of the country. |
CountrySubdivisionCode |
This is the ISO3166-2 code for country subdivisions, usually the administrative area for a country. The format is the 2 letter country code followed by a dash followed by 2 or 3 characters or two numbers. |
DeliveryAddress |
The full delivery address in one line. |
DeliveryAddress1 |
Delivery address line 1. |
DeliveryAddress10 |
Delivery address line 10. |
DeliveryAddress11 |
Delivery address line 11. |
DeliveryAddress12 |
Delivery address line 12. |
DeliveryAddress2 |
Delivery address line 2. |
DeliveryAddress3 |
Delivery address line 3. |
DeliveryAddress4 |
Delivery address line 4. |
DeliveryAddress5 |
Delivery address line 5. |
DeliveryAddress6 |
Delivery address line 6. |
DeliveryAddress7 |
Delivery address line 7. |
DeliveryAddress8 |
Delivery address line 8. |
DeliveryAddress9 |
Delivery address line 9. |
DeliveryInstallation |
Canada Only. The delivery installation for the address. |
DependentLocality |
Urbanization. A dependent locality is a logical area unit that is smaller than a locality but larger than a double dependent locality or thoroughfare. It can often be associated with a neighborhood or sector. |
DependentThoroughfare |
Dependent Street. A second thoroughfare that is required to narrow down the final address. This is rarely used. |
DistanceFromPoint |
The distance in miles from the specified point. |
DoubleDependentLocality |
A logical area unit that is smaller than a dependent locality but bigger than a thoroughfare. This field is rarely used. |
Extras |
This element will be returned, depending on which additional columns are specified. |
GeneralDelivery |
The USPS address type assigned for the address. |
ISO3166_2 |
The 2 letter ISO 3166 country code value. For example: |
ISO3166_3 |
The 3 letter ISO 3166 country code value. For example: |
ISO3166_N |
The ISO 3166 country number value. For example: |
Latitude |
The latitude geographic coordinate of the output address. |
Locality |
City, Town. The most common geographic area, used by virtually all countries. |
Longitude |
The longitude geographic coordinate of the output address. |
MAK |
Melissa Address Key. A unique key assigned to the submitted address. |
Organization |
Business, Company. This name of the organization. |
PostalCode |
ZIP Code. Complete postal code for a particular delivery point. |
PostalCodePrimary |
The primary portion of the postal code. In the US, this is a 5-digit ZIP code. |
PostalCodeSecondary |
The secondary portion of the postal code. In the US this is the +4 of the ZIP code. |
PostBox |
Post box information for a particular delivery point. |
Premise |
Street Number. The premise identifying number. |
Route |
Canada Only. The route service number. |
SubAdministrativeArea |
County. A logical area that that is smaller than the administrative area but larger than a locality. Rarely used as part of an official address. |
SubBuilding |
A smaller division of a building. For example, if an address has a building name that is a part of a larger set of buildings, then the sub building may be populated. |
SuperAdministrativeArea |
A region within a country that has a higher level of administrative control or governance than other areas. |
Thoroughfare |
Street. The most common street or block data element. |
UDPRN |
GB Only. The Unique Delivery Point Reference Number issued by Royal Mail. This is an 8-digit unique number. |
Unmatched |
Any part of the address that did not match other fields will be saved in this field. |
UPRN |
GB Only. 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. |
/web/GlobalExpressAddress#
The GlobalExpressAddress service is consumed to retrieve results containing all of the available address elements of an address record:
FormattedAddress
AddressLine1-8
CountryISO3166_1_Alpha2
CountryISO3166_1_Alpha3
CountryISO3166_1_Numeric
SubNationalArea
PremisesNumber
AdministrativeArea
SubadministrativeArea
locality
dependentlocality
doubledependentlocality
thoroughfare
dependentthoroughfare
building
postalcode
postbox
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.
Try It Now#
curl -X GET "https://expressentry.melissadata.net/web/GlobalExpressAddress?\
&cols=\
&format=json\
&id={{customerId}}\
&maxrecords=10\
&nativecharset=True\
&opt=\
&address1=\
&administrativearea=CA\
&country=US\
&locality=Rancho+Santa+Margarita\
&postalcode=92688" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
curl -X GET "https://expressentry.melissadata.net/web/GlobalExpressAddress?\
&cols=\
&format=xml\
&id={{customerId}}\
&maxrecords=10\
&nativecharset=True\
&opt=\
&address1=\
&administrativearea=CA\
&country=US\
&locality=Rancho+Santa+Margarita\
&postalcode=92688" \
-H "Content-Type: application/xml" \
-H "Accept: */*"
curl -X GET "https://expressentry.melissadata.net/jsonp/GlobalExpressAddress?\
&cols=\
&format=json\
&id={{customerId}}\
&maxrecords=10\
&nativecharset=True\
&opt=\
&address1=\
&administrativearea=CA\
&country=US\
&locality=Rancho+Santa+Margarita\
&postalcode=92688" \
-H "Content-Type: application/javascript" \
-H "Accept: application/javascript"
Request Parameters#
Code |
Description |
|---|---|
Record Level Parameters |
|
|
Specifies which column(s) to be output as a comma delimited string. See Columns for more information. |
|
|
|
Desired format of the response. Possible values are |
|
The License Key issued by Melissa. |
|
The maximum number of records to return. The default is |
|
|
|
|
Address Parameters |
|
|
The input field for the address, delimited by |
|
An additional field for extra address lines. |
|
An additional field for extra address lines. |
|
Administrative Area, Province, State. The most common geographic data element. |
|
Default set to US. The ISO2Code or country name of the address. |
|
City, Locality, Munipality. The most common population center data element. |
|
Postal Code, ZIP. The complete postal code. |
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 ,.
Column |
Returned Values |
|---|---|
|
GB Only. Return UPRN (SourceID) and UDPRN (SupplierID) values for each address. These will be in the |
|
US Only. Return Address Object result codes for each address in the Extras field. For example, a USPS only address will return |
Filtering#
The GlobalExpressAddress endpoint supports filtering. For more information on available filters and examples, see the following page:
Options#
List options in the following format, with multiple options delimited with a ;.
OptionName:Parameter;OptionName:Parameter
poboxes#
This options allows P.O. Boxes and military addresses to be returned with U.S. Addresses.
Parameter |
Description |
|---|---|
|
U.S. Addresses will return P.O. Boxes and military addresses. |
|
P.O. Boxes and military addresses will not be returned. |
Headers#
Content-Type: application/json
Accept: application/json
Content-Type: application/xml
Accept: application/xml
Content-Type: application/javascript
Accept: application/javascript
Response#
{
"Version": "8.0.0.1249",
"ResultCode": "XS02",
"ErrorString": "",
"Results": [
{
"Address": {
"Address": "PO Box 80781, Rancho Santa Margarita, CA 92688-0546",
"Address1": "PO Box 80781",
"Address2": "Rancho Santa Margarita, CA 92688-0546",
"Address3": "",
"Address4": "",
"Address5": "",
"Address6": "",
"Address7": "",
"Address8": "",
"Address9": "",
"Address10": "",
"Address11": "",
"Address12": "",
"DeliveryAddress": "PO Box 80781",
"DeliveryAddress1": "PO Box 80781",
"DeliveryAddress2": "",
"DeliveryAddress3": "",
"DeliveryAddress4": "",
"DeliveryAddress5": "",
"DeliveryAddress6": "",
"DeliveryAddress7": "",
"DeliveryAddress8": "",
"DeliveryAddress9": "",
"DeliveryAddress10": "",
"DeliveryAddress11": "",
"DeliveryAddress12": "",
"CountryName": "United States Of America",
"ISO3166_2": "US",
"ISO3166_3": "USA",
"ISO3166_N": "840",
"SuperAdministrativeArea": "",
"AdministrativeArea": "CA",
"SubAdministrativeArea": "Orange",
"Locality": "Rancho Santa Margarita",
"CityAccepted": "Rancho Sta Marg,Rsm,Rcho Sta Marg",
"CityNotAccepted": "",
"DependentLocality": "",
"DoubleDependentLocality": "",
"Thoroughfare": "",
"DependentThoroughfare": "",
"Building": "",
"Premise": "",
"SubBuilding": "",
"PostalCode": "92688-0546",
"PostalCodePrimary": "92688",
"PostalCodeSecondary": "0546",
"Organization": "",
"PostBox": "PO Box 80781",
"Unmatched": "",
"GeneralDelivery": "",
"DeliveryInstallation": "",
"Route": "",
"AdditionalContent": "",
"CountrySubdivisionCode": "US-CA",
"MAK": "4462720540",
"BaseMAK": "1748370077",
"Latitude": "33.636760",
"Longitude": "-117.609379",
"DistanceFromPoint": 0
}
},
...
{
"Address": {
"Address": "1 Via Onagro, Rancho Santa Margarita, CA 92688-4126",
"Address1": "1 Via Onagro",
"Address2": "Rancho Santa Margarita, CA 92688-4126",
"Address3": "",
"Address4": "",
"Address5": "",
"Address6": "",
"Address7": "",
"Address8": "",
"Address9": "",
"Address10": "",
"Address11": "",
"Address12": "",
"DeliveryAddress": "1 Via Onagro",
"DeliveryAddress1": "1 Via Onagro",
"DeliveryAddress2": "",
"DeliveryAddress3": "",
"DeliveryAddress4": "",
"DeliveryAddress5": "",
"DeliveryAddress6": "",
"DeliveryAddress7": "",
"DeliveryAddress8": "",
"DeliveryAddress9": "",
"DeliveryAddress10": "",
"DeliveryAddress11": "",
"DeliveryAddress12": "",
"CountryName": "United States Of America",
"ISO3166_2": "US",
"ISO3166_3": "USA",
"ISO3166_N": "840",
"SuperAdministrativeArea": "",
"AdministrativeArea": "CA",
"SubAdministrativeArea": "Orange",
"Locality": "Rancho Santa Margarita",
"CityAccepted": "Rancho Sta Marg,Rsm,Rcho Sta Marg",
"CityNotAccepted": "",
"DependentLocality": "",
"DoubleDependentLocality": "",
"Thoroughfare": "Via Onagro",
"DependentThoroughfare": "",
"Building": "",
"Premise": "1",
"SubBuilding": "",
"PostalCode": "92688-4126",
"PostalCodePrimary": "92688",
"PostalCodeSecondary": "4126",
"Organization": "",
"PostBox": "",
"Unmatched": "",
"GeneralDelivery": "",
"DeliveryInstallation": "",
"Route": "",
"AdditionalContent": "",
"CountrySubdivisionCode": "US-CA",
"MAK": "1467463708",
"BaseMAK": "",
"Latitude": "33.647046",
"Longitude": "-117.615252",
"DistanceFromPoint": 0
}
}
]
}
<ResponseGlobal
xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Version>8.0.0.1249</Version>
<ResultCode>XS02</ResultCode>
<ErrorString></ErrorString>
<Results>
<ResultGlobal>
<Address>
<Address>PO Box 80781, Rancho Santa Margarita, CA 92688-0546</Address>
<Address1>PO Box 80781</Address1>
<Address2>Rancho Santa Margarita, CA 92688-0546</Address2>
<Address3></Address3>
<Address4></Address4>
<Address5></Address5>
<Address6></Address6>
<Address7></Address7>
<Address8></Address8>
<Address9></Address9>
<Address10></Address10>
<Address11></Address11>
<Address12></Address12>
<DeliveryAddress>PO Box 80781</DeliveryAddress>
<DeliveryAddress1>PO Box 80781</DeliveryAddress1>
<DeliveryAddress2></DeliveryAddress2>
<DeliveryAddress3></DeliveryAddress3>
<DeliveryAddress4></DeliveryAddress4>
<DeliveryAddress5></DeliveryAddress5>
<DeliveryAddress6></DeliveryAddress6>
<DeliveryAddress7></DeliveryAddress7>
<DeliveryAddress8></DeliveryAddress8>
<DeliveryAddress9></DeliveryAddress9>
<DeliveryAddress10></DeliveryAddress10>
<DeliveryAddress11></DeliveryAddress11>
<DeliveryAddress12></DeliveryAddress12>
<CountryName>United States Of America</CountryName>
<ISO3166_2>US</ISO3166_2>
<ISO3166_3>USA</ISO3166_3>
<ISO3166_N>840</ISO3166_N>
<SuperAdministrativeArea></SuperAdministrativeArea>
<AdministrativeArea>CA</AdministrativeArea>
<SubAdministrativeArea>Orange</SubAdministrativeArea>
<Locality>Rancho Santa Margarita</Locality>
<CityAccepted>Rancho Sta Marg,Rsm,Rcho Sta Marg</CityAccepted>
<CityNotAccepted></CityNotAccepted>
<DependentLocality></DependentLocality>
<DoubleDependentLocality></DoubleDependentLocality>
<Thoroughfare></Thoroughfare>
<DependentThoroughfare></DependentThoroughfare>
<Building></Building>
<Premise></Premise>
<SubBuilding></SubBuilding>
<PostalCode>92688-0546</PostalCode>
<PostalCodePrimary>92688</PostalCodePrimary>
<PostalCodeSecondary>0546</PostalCodeSecondary>
<Organization></Organization>
<PostBox>PO Box 80781</PostBox>
<Unmatched></Unmatched>
<GeneralDelivery></GeneralDelivery>
<DeliveryInstallation></DeliveryInstallation>
<Route></Route>
<AdditionalContent></AdditionalContent>
<CountrySubdivisionCode>US-CA</CountrySubdivisionCode>
<MAK>4462720540</MAK>
<BaseMAK>1748370077</BaseMAK>
<Latitude>33.636760</Latitude>
<Longitude>-117.609379</Longitude>
<DistanceFromPoint>0</DistanceFromPoint>
</Address>
</ResultGlobal>
...
<ResultGlobal>
<Address>
<Address>1 Via Onagro, Rancho Santa Margarita, CA 92688-4126</Address>
<Address1>1 Via Onagro</Address1>
<Address2>Rancho Santa Margarita, CA 92688-4126</Address2>
<Address3></Address3>
<Address4></Address4>
<Address5></Address5>
<Address6></Address6>
<Address7></Address7>
<Address8></Address8>
<Address9></Address9>
<Address10></Address10>
<Address11></Address11>
<Address12></Address12>
<DeliveryAddress>1 Via Onagro</DeliveryAddress>
<DeliveryAddress1>1 Via Onagro</DeliveryAddress1>
<DeliveryAddress2></DeliveryAddress2>
<DeliveryAddress3></DeliveryAddress3>
<DeliveryAddress4></DeliveryAddress4>
<DeliveryAddress5></DeliveryAddress5>
<DeliveryAddress6></DeliveryAddress6>
<DeliveryAddress7></DeliveryAddress7>
<DeliveryAddress8></DeliveryAddress8>
<DeliveryAddress9></DeliveryAddress9>
<DeliveryAddress10></DeliveryAddress10>
<DeliveryAddress11></DeliveryAddress11>
<DeliveryAddress12></DeliveryAddress12>
<CountryName>United States Of America</CountryName>
<ISO3166_2>US</ISO3166_2>
<ISO3166_3>USA</ISO3166_3>
<ISO3166_N>840</ISO3166_N>
<SuperAdministrativeArea></SuperAdministrativeArea>
<AdministrativeArea>CA</AdministrativeArea>
<SubAdministrativeArea>Orange</SubAdministrativeArea>
<Locality>Rancho Santa Margarita</Locality>
<CityAccepted>Rancho Sta Marg,Rsm,Rcho Sta Marg</CityAccepted>
<CityNotAccepted></CityNotAccepted>
<DependentLocality></DependentLocality>
<DoubleDependentLocality></DoubleDependentLocality>
<Thoroughfare>Via Onagro</Thoroughfare>
<DependentThoroughfare></DependentThoroughfare>
<Building></Building>
<Premise>1</Premise>
<SubBuilding></SubBuilding>
<PostalCode>92688-4126</PostalCode>
<PostalCodePrimary>92688</PostalCodePrimary>
<PostalCodeSecondary>4126</PostalCodeSecondary>
<Organization></Organization>
<PostBox></PostBox>
<Unmatched></Unmatched>
<GeneralDelivery></GeneralDelivery>
<DeliveryInstallation></DeliveryInstallation>
<Route></Route>
<AdditionalContent></AdditionalContent>
<CountrySubdivisionCode>US-CA</CountrySubdivisionCode>
<MAK>1467463708</MAK>
<BaseMAK></BaseMAK>
<Latitude>33.647046</Latitude>
<Longitude>-117.615252</Longitude>
<DistanceFromPoint>0</DistanceFromPoint>
</Address>
</ResultGlobal>
</Results>
</ResponseGlobal>
{
"d": {
"__type": "ResponseGlobal",
"Version": "8.0.0.1249",
"ResultCode": "XS02",
"ErrorString": "",
"Results": [
{
"__type": "ResultGlobal",
"Address": {
"__type": "AddressGlobal",
"Address": "PO Box 80781, Rancho Santa Margarita, CA 92688-0546",
"Address1": "PO Box 80781",
"Address2": "Rancho Santa Margarita, CA 92688-0546",
"Address3": "",
"Address4": "",
"Address5": "",
"Address6": "",
"Address7": "",
"Address8": "",
"Address9": "",
"Address10": "",
"Address11": "",
"Address12": "",
"DeliveryAddress": "PO Box 80781",
"DeliveryAddress1": "PO Box 80781",
"DeliveryAddress2": "",
"DeliveryAddress3": "",
"DeliveryAddress4": "",
"DeliveryAddress5": "",
"DeliveryAddress6": "",
"DeliveryAddress7": "",
"DeliveryAddress8": "",
"DeliveryAddress9": "",
"DeliveryAddress10": "",
"DeliveryAddress11": "",
"DeliveryAddress12": "",
"CountryName": "United States Of America",
"ISO3166_2": "US",
"ISO3166_3": "USA",
"ISO3166_N": "840",
"SuperAdministrativeArea": "",
"AdministrativeArea": "CA",
"SubAdministrativeArea": "Orange",
"Locality": "Rancho Santa Margarita",
"CityAccepted": "Rancho Sta Marg,Rsm,Rcho Sta Marg",
"CityNotAccepted": "",
"DependentLocality": "",
"DoubleDependentLocality": "",
"Thoroughfare": "",
"DependentThoroughfare": "",
"Building": "",
"Premise": "",
"SubBuilding": "",
"PostalCode": "92688-0546",
"PostalCodePrimary": "92688",
"PostalCodeSecondary": "0546",
"Organization": "",
"PostBox": "PO Box 80781",
"Unmatched": "",
"GeneralDelivery": "",
"DeliveryInstallation": "",
"Route": "",
"AdditionalContent": "",
"CountrySubdivisionCode": "US-CA",
"MAK": "4462720540",
"BaseMAK": "1748370077",
"Latitude": "33.636760",
"Longitude": "-117.609379",
"DistanceFromPoint": 0
}
},
...
{
"__type": "ResultGlobal",
"Address": {
"__type": "AddressGlobal",
"Address": "1 Via Onagro, Rancho Santa Margarita, CA 92688-4126",
"Address1": "1 Via Onagro",
"Address2": "Rancho Santa Margarita, CA 92688-4126",
"Address3": "",
"Address4": "",
"Address5": "",
"Address6": "",
"Address7": "",
"Address8": "",
"Address9": "",
"Address10": "",
"Address11": "",
"Address12": "",
"DeliveryAddress": "1 Via Onagro",
"DeliveryAddress1": "1 Via Onagro",
"DeliveryAddress2": "",
"DeliveryAddress3": "",
"DeliveryAddress4": "",
"DeliveryAddress5": "",
"DeliveryAddress6": "",
"DeliveryAddress7": "",
"DeliveryAddress8": "",
"DeliveryAddress9": "",
"DeliveryAddress10": "",
"DeliveryAddress11": "",
"DeliveryAddress12": "",
"CountryName": "United States Of America",
"ISO3166_2": "US",
"ISO3166_3": "USA",
"ISO3166_N": "840",
"SuperAdministrativeArea": "",
"AdministrativeArea": "CA",
"SubAdministrativeArea": "Orange",
"Locality": "Rancho Santa Margarita",
"CityAccepted": "Rancho Sta Marg,Rsm,Rcho Sta Marg",
"CityNotAccepted": "",
"DependentLocality": "",
"DoubleDependentLocality": "",
"Thoroughfare": "Via Onagro",
"DependentThoroughfare": "",
"Building": "",
"Premise": "1",
"SubBuilding": "",
"PostalCode": "92688-4126",
"PostalCodePrimary": "92688",
"PostalCodeSecondary": "4126",
"Organization": "",
"PostBox": "",
"Unmatched": "",
"GeneralDelivery": "",
"DeliveryInstallation": "",
"Route": "",
"AdditionalContent": "",
"CountrySubdivisionCode": "US-CA",
"MAK": "1467463708",
"BaseMAK": "",
"Latitude": "33.647046",
"Longitude": "-117.615252",
"DistanceFromPoint": 0
}
}
]
}
}
Service Level Response Fields#
Output Name |
Description |
|---|---|
ErrorString |
Lists error codes from any errors caused by the most recent request. |
ResultCode |
Lists result codes for the most recent request. |
Results |
Array with Address array(s) containing the record level fields. |
Version |
The current service version number. |
Record Level Response Fields#
Output Name |
Description |
|---|---|
AdditionalContent |
Any additional content associated with the address. |
Address |
The full address in one line. |
Address1 |
Address line 1. |
Address2 |
Address line 2. |
Address3 |
Address line 3. |
Address4 |
Address line 4. |
Address5 |
Address line 5. |
Address6 |
Address line 6. |
Address7 |
Address line 7. |
Address8 |
Address line 8. |
Address9 |
Address line 9. |
Address10 |
Address line 10. |
Address11 |
Address line 11. |
Address12 |
Address line 12. |
AdministrativeArea |
State, Province. This is a common geographic area unit for larger countries. |
BaseMAK |
Melissa Address Key Base. If the address has suites or apartments the 10 digit proprietary BaseMAK will be returned and correspond to the overall building. |
Building |
A descriptive name identifying an individual location. |
CityAccepted |
A list of accepted city names. |
CityNotAccepted |
Any non-accepted city names will be included in this field. |
CountryName |
The name of the country. |
CountrySubdivisionCode |
This is the ISO3166-2 code for country subdivisions, usually the administrative area for a country. The format is the 2 letter country code followed by a dash followed by 2 or 3 characters or two numbers. |
DeliveryAddress |
The full delivery address in one line. |
DeliveryAddress1 |
Delivery address line 1. |
DeliveryAddress2 |
Delivery address line 2. |
DeliveryAddress3 |
Delivery address line 3. |
DeliveryAddress4 |
Delivery address line 4. |
DeliveryAddress5 |
Delivery address line 5. |
DeliveryAddress6 |
Delivery address line 6. |
DeliveryAddress7 |
Delivery address line 7. |
DeliveryAddress8 |
Delivery address line 8. |
DeliveryAddress9 |
Delivery address line 9. |
DeliveryAddress10 |
Delivery address line 10. |
DeliveryAddress11 |
Delivery address line 11. |
DeliveryAddress12 |
Delivery address line 12. |
DeliveryInstallation |
Canada Only. The delivery installation for the address. |
DependentLocality |
Urbanization. A dependent locality is a logical area unit that is smaller than a locality but larger than a double dependent locality or thoroughfare. It can often be associated with a neighborhood or sector. |
DependentThoroughfare |
Dependent Street. A second thoroughfare that is required to narrow down the final address. This is rarely used. |
DistanceFromPoint |
The distance in miles from the specified point. |
DoubleDependentLocality |
A logical area unit that is smaller than a dependent locality but bigger than a thoroughfare. This field is rarely used. |
Extras |
This element will be returned, depending on which additional columns are specified. |
GeneralDelivery |
The USPS address type assigned for the address. |
ISO3166_2 |
The 2 letter ISO 3166 country code value. For example: |
ISO3166_3 |
The 3 letter ISO 3166 country code value. For example: |
ISO3166_N |
The ISO 3166 country number value. For example: |
Latitude |
The latitude geographic coordinate of the output address. |
Locality |
City, Town. The most common geographic area, used by virtually all countries. |
Longitude |
The longitude geographic coordinate of the output address. |
MAK |
Melissa Address Key. A unique key assigned to the submitted address. |
Organization |
Business, Company. This name of the organization. |
PostalCode |
ZIP Code. Complete postal code for a particular delivery point. |
PostalCodePrimary |
The primary portion of the postal code. In the US, this is a 5-digit ZIP code. |
PostalCodeSecondary |
The secondary portion of the postal code. In the US this is the +4 of the ZIP code. |
PostBox |
Post box information for a particular delivery point. |
Premise |
Street Number. The premise identifying number. |
Route |
Canada Only. The route service number. |
SubAdministrativeArea |
County. A logical area that that is smaller than the administrative area but larger than a locality. Rarely used as part of an official address. |
SubBuilding |
A smaller division of a building. For example, if an address has a building name that is a part of a larger set of buildings, then the sub building may be populated. |
SuperAdministrativeArea |
A region within a country that has a higher level of administrative control or governance than other areas. |
Thoroughfare |
Street. The most common street or block data element. |
UDPRN |
GB Only. The Unique Delivery Point Reference Number issued by Royal Mail. This is an 8-digit unique number. |
Unmatched |
Any part of the address that did not match other fields will be saved in this field. |
UPRN |
GB Only. 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. |
/web/GlobalExpressLocalityAdministrativeArea#
GlobalExpressLocalityAdministrativeArea is provided as a means of retrieving locality and administrative area combinations using the locality name.
Try It Now#
curl -X GET "https://expressentry.melissadata.net/web/GlobalExpressLocalityAdministrativeArea?\
&format=json\
&id={{customerId}}\
&maxrecords=10\
&nativecharset=true\
&country=US\
&locality=Rancho+Santa+Margarita\
&administrativearea=CA\
&postalcode=92688" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
curl -X GET "https://expressentry.melissadata.net/web/GlobalExpressLocalityAdministrativeArea?\
&format=xml\
&id={{customerId}}\
&maxrecords=10\
&nativecharset=true\
&country=US\
&locality=Rancho+Santa+Margarita\
&administrativearea=CA\
&postalcode=92688" \
-H "Content-Type: application/xml" \
-H "Accept: */*"
curl -X GET "https://expressentry.melissadata.net/jsonp/GlobalExpressLocalityAdministrativeArea?\
&format=json\
&id={{customerId}}\
&maxrecords=10\
&nativecharset=true\
&country=US\
&locality=Rancho+Santa+Margarita\
&administrativearea=CA\
&postalcode=92688" \
-H "Content-Type: application/javascript" \
-H "Accept: application/javascript"
Request Parameters#
Code |
Description |
|---|---|
Record Level Parameters |
|
|
|
|
Desired format of the response. Possible values are |
|
The License Key issued by Melissa. |
|
The maximum number of records to return. The default is |
|
|
Address Parameters |
|
|
Administrative Area, Province, State. The most common geographic data element. |
|
Default set to US. The ISO2Code or country name of the address. |
|
City, Locality, Munipality. The most common population center data element. |
|
Postal Code, ZIP. The complete postal code. |
Headers#
Content-Type: application/json
Accept: application/json
Content-Type: application/xml
Accept: application/xml
Content-Type: application/javascript
Accept: application/javascript
Response#
{
"Version": "8.0.0.1249",
"ResultCode": "XS01",
"ErrorString": "",
"Results": [
{
"Address": {
"Address": "",
"Address1": "",
"Address2": "",
"Address3": "",
"Address4": "",
"Address5": "",
"Address6": "",
"Address7": "",
"Address8": "",
"Address9": "",
"Address10": "",
"Address11": "",
"Address12": "",
"DeliveryAddress": "",
"DeliveryAddress1": "",
"DeliveryAddress2": "",
"DeliveryAddress3": "",
"DeliveryAddress4": "",
"DeliveryAddress5": "",
"DeliveryAddress6": "",
"DeliveryAddress7": "",
"DeliveryAddress8": "",
"DeliveryAddress9": "",
"DeliveryAddress10": "",
"DeliveryAddress11": "",
"DeliveryAddress12": "",
"CountryName": "United States Of America",
"ISO3166_2": "US",
"ISO3166_3": "USA",
"ISO3166_N": "840",
"SuperAdministrativeArea": "",
"AdministrativeArea": "CA",
"SubAdministrativeArea": "Orange",
"Locality": "Rancho Santa Margarita",
"CityAccepted": "Rancho Sta Marg,Rsm,Rcho Sta Marg",
"CityNotAccepted": "",
"DependentLocality": "",
"DoubleDependentLocality": "",
"Thoroughfare": "",
"DependentThoroughfare": "",
"Building": "",
"Premise": "",
"SubBuilding": "",
"PostalCode": "92688",
"PostalCodePrimary": "92688",
"PostalCodeSecondary": "",
"Organization": "",
"PostBox": "",
"Unmatched": "",
"GeneralDelivery": "",
"DeliveryInstallation": "",
"Route": "",
"AdditionalContent": "",
"CountrySubdivisionCode": "US-CA",
"MAK": "",
"BaseMAK": "",
"Latitude": "",
"Longitude": "",
"DistanceFromPoint": 0
}
}
]
}
<ResponseGlobal
xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Version>8.0.0.1249</Version>
<ResultCode>XS01</ResultCode>
<ErrorString></ErrorString>
<Results>
<ResultGlobal>
<Address>
<Address></Address>
<Address1></Address1>
<Address2></Address2>
<Address3></Address3>
<Address4></Address4>
<Address5></Address5>
<Address6></Address6>
<Address7></Address7>
<Address8></Address8>
<Address9></Address9>
<Address10></Address10>
<Address11></Address11>
<Address12></Address12>
<DeliveryAddress></DeliveryAddress>
<DeliveryAddress1></DeliveryAddress1>
<DeliveryAddress2></DeliveryAddress2>
<DeliveryAddress3></DeliveryAddress3>
<DeliveryAddress4></DeliveryAddress4>
<DeliveryAddress5></DeliveryAddress5>
<DeliveryAddress6></DeliveryAddress6>
<DeliveryAddress7></DeliveryAddress7>
<DeliveryAddress8></DeliveryAddress8>
<DeliveryAddress9></DeliveryAddress9>
<DeliveryAddress10></DeliveryAddress10>
<DeliveryAddress11></DeliveryAddress11>
<DeliveryAddress12></DeliveryAddress12>
<CountryName>United States Of America</CountryName>
<ISO3166_2>US</ISO3166_2>
<ISO3166_3>USA</ISO3166_3>
<ISO3166_N>840</ISO3166_N>
<SuperAdministrativeArea></SuperAdministrativeArea>
<AdministrativeArea>CA</AdministrativeArea>
<SubAdministrativeArea>Orange</SubAdministrativeArea>
<Locality>Rancho Santa Margarita</Locality>
<CityAccepted>Rancho Sta Marg,Rsm,Rcho Sta Marg</CityAccepted>
<CityNotAccepted></CityNotAccepted>
<DependentLocality></DependentLocality>
<DoubleDependentLocality></DoubleDependentLocality>
<Thoroughfare></Thoroughfare>
<DependentThoroughfare></DependentThoroughfare>
<Building></Building>
<Premise></Premise>
<SubBuilding></SubBuilding>
<PostalCode>92688</PostalCode>
<PostalCodePrimary>92688</PostalCodePrimary>
<PostalCodeSecondary></PostalCodeSecondary>
<Organization></Organization>
<PostBox></PostBox>
<Unmatched></Unmatched>
<GeneralDelivery></GeneralDelivery>
<DeliveryInstallation></DeliveryInstallation>
<Route></Route>
<AdditionalContent></AdditionalContent>
<CountrySubdivisionCode>US-CA</CountrySubdivisionCode>
<MAK></MAK>
<BaseMAK></BaseMAK>
<Latitude></Latitude>
<Longitude></Longitude>
<DistanceFromPoint>0</DistanceFromPoint>
</Address>
</ResultGlobal>
</Results>
</ResponseGlobal>
{
"d": {
"__type": "ResponseGlobal",
"Version": "8.0.0.1249",
"ResultCode": "XS01",
"ErrorString": "",
"Results": [
{
"__type": "ResultGlobal",
"Address": {
"__type": "AddressGlobal",
"Address": "",
"Address1": "",
"Address2": "",
"Address3": "",
"Address4": "",
"Address5": "",
"Address6": "",
"Address7": "",
"Address8": "",
"Address9": "",
"Address10": "",
"Address11": "",
"Address12": "",
"DeliveryAddress": "",
"DeliveryAddress1": "",
"DeliveryAddress2": "",
"DeliveryAddress3": "",
"DeliveryAddress4": "",
"DeliveryAddress5": "",
"DeliveryAddress6": "",
"DeliveryAddress7": "",
"DeliveryAddress8": "",
"DeliveryAddress9": "",
"DeliveryAddress10": "",
"DeliveryAddress11": "",
"DeliveryAddress12": "",
"CountryName": "United States Of America",
"ISO3166_2": "US",
"ISO3166_3": "USA",
"ISO3166_N": "840",
"SuperAdministrativeArea": "",
"AdministrativeArea": "CA",
"SubAdministrativeArea": "Orange",
"Locality": "Rancho Santa Margarita",
"CityAccepted": "Rancho Sta Marg,Rsm,Rcho Sta Marg",
"CityNotAccepted": "",
"DependentLocality": "",
"DoubleDependentLocality": "",
"Thoroughfare": "",
"DependentThoroughfare": "",
"Building": "",
"Premise": "",
"SubBuilding": "",
"PostalCode": "92688",
"PostalCodePrimary": "92688",
"PostalCodeSecondary": "",
"Organization": "",
"PostBox": "",
"Unmatched": "",
"GeneralDelivery": "",
"DeliveryInstallation": "",
"Route": "",
"AdditionalContent": "",
"CountrySubdivisionCode": "US-CA",
"MAK": "",
"BaseMAK": "",
"Latitude": "",
"Longitude": "",
"DistanceFromPoint": 0
}
}
]
}
}
Service Level Response Fields#
Output Name |
Description |
|---|---|
ErrorString |
Lists error codes from any errors caused by the most recent request. |
ResultCode |
Lists result codes for the most recent request. |
Results |
Array with Address array(s) containing the record level fields. |
Version |
The current service version number. |
Record Level Response Fields#
Output Name |
Description |
|---|---|
AdditionalContent |
Any additional content associated with the address. |
Address |
The full address in one line. |
Address1 |
Address line 1. |
Address10 |
Address line 10. |
Address11 |
Address line 11. |
Address12 |
Address line 12. |
Address2 |
Address line 2. |
Address3 |
Address line 3. |
Address4 |
Address line 4. |
Address5 |
Address line 5. |
Address6 |
Address line 6. |
Address7 |
Address line 7. |
Address8 |
Address line 8. |
Address9 |
Address line 9. |
AdministrativeArea |
State, Province. This is a common geographic area unit for larger countries. |
BaseMAK |
Melissa Address Key Base. If the address has suites or apartments the 10 digit proprietary BaseMAK will be returned and correspond to the overall building. |
Building |
A descriptive name identifying an individual location. |
CityAccepted |
A list of accepted city names. |
CityNotAccepted |
Any non-accepted city names will be included in this field. |
CountryName |
The name of the country. |
CountrySubdivisionCode |
This is the ISO3166-2 code for country subdivisions, usually the administrative area for a country. The format is the 2 letter country code followed by a dash followed by 2 or 3 characters or two numbers. |
DeliveryAddress |
The full delivery address in one line. |
DeliveryAddress1 |
Delivery address line 1. |
DeliveryAddress10 |
Delivery address line 10. |
DeliveryAddress11 |
Delivery address line 11. |
DeliveryAddress12 |
Delivery address line 12. |
DeliveryAddress2 |
Delivery address line 2. |
DeliveryAddress3 |
Delivery address line 3. |
DeliveryAddress4 |
Delivery address line 4. |
DeliveryAddress5 |
Delivery address line 5. |
DeliveryAddress6 |
Delivery address line 6. |
DeliveryAddress7 |
Delivery address line 7. |
DeliveryAddress8 |
Delivery address line 8. |
DeliveryAddress9 |
Delivery address line 9. |
DeliveryInstallation |
Canada Only. The delivery installation for the address. |
DependentLocality |
Urbanization. A dependent locality is a logical area unit that is smaller than a locality but larger than a double dependent locality or thoroughfare. It can often be associated with a neighborhood or sector. |
DependentThoroughfare |
Dependent Street. A second thoroughfare that is required to narrow down the final address. This is rarely used. |
DistanceFromPoint |
The distance in miles from the specified point. |
DoubleDependentLocality |
A logical area unit that is smaller than a dependent locality but bigger than a thoroughfare. This field is rarely used. |
GeneralDelivery |
The USPS address type assigned for the address. |
ISO3166_2 |
The 2 letter ISO 3166 country code value. For example: |
ISO3166_3 |
The 3 letter ISO 3166 country code value. For example: |
ISO3166_N |
The ISO 3166 country number value. For example: |
Latitude |
The latitude geographic coordinate of the output address. |
Locality |
City, Town. The most common geographic area, used by virtually all countries. |
Longitude |
The longitude geographic coordinate of the output address. |
MAK |
Melissa Address Key. A unique key assigned to the submitted address. |
Organization |
Business, Company. This name of the organization. |
PostalCode |
ZIP Code. Complete postal code for a particular delivery point. |
PostalCodePrimary |
The primary portion of the postal code. In the US, this is a 5-digit ZIP code. |
PostalCodeSecondary |
The secondary portion of the postal code. In the US this is the +4 of the ZIP code. |
PostBox |
Post box information for a particular delivery point. |
Premise |
Street Number. The premise identifying number. |
Route |
Canada Only. The route service number. |
SubAdministrativeArea |
County. A logical area that that is smaller than the administrative area but larger than a locality. Rarely used as part of an official address. |
SubBuilding |
A smaller division of a building. For example, if an address has a building name that is a part of a larger set of buildings, then the sub building may be populated. |
SuperAdministrativeArea |
A region within a country that has a higher level of administrative control or governance than other areas. |
Thoroughfare |
Street. The most common street or block data element. |
Unmatched |
Any part of the address that did not match other fields will be saved in this field. |
/web/GlobalExpressPostalCode#
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.
Try It Now#
curl -X GET "https://expressentry.melissadata.net/web/GlobalExpressPostalCode?\
&format=json\
&id={{customerId}}\
&maxrecords=10\
&country=US\
&postalcode=92688" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
curl -X GET "https://expressentry.melissadata.net/web/GlobalExpressPostalCode?\
&format=xml\
&id={{customerId}}\
&maxrecords=10\
&country=US\
&postalcode=92688" \
-H "Content-Type: application/xml" \
-H "Accept: */*"
curl -X GET "https://expressentry.melissadata.net/jsonp/GlobalExpressPostalCode?\
&format=json\
&id={{customerId}}\
&maxrecords=10\
&country=US\
&postalcode=92688" \
-H "Content-Type: application/javascript" \
-H "Accept: application/javascript"
Request Parameters#
Code |
Description |
|---|---|
Record Level Parameters |
|
|
|
|
Desired format of the response. Possible values are |
|
The License Key issued by Melissa. |
|
The maximum number of records to return. The default is |
Address Parameters |
|
|
Default set to US. The ISO2Code or country name of the address. |
|
Postal Code, ZIP. The complete postal code. |
Headers#
Content-Type: application/json
Accept: application/json
Content-Type: application/xml
Accept: application/xml
Content-Type: application/javascript
Accept: application/javascript
Response#
{
"Version": "8.0.0.1249",
"ResultCode": "XS01",
"ErrorString": "",
"Results": [
{
"Address": {
"Address": "",
"Address1": "",
"Address2": "",
"Address3": "",
"Address4": "",
"Address5": "",
"Address6": "",
"Address7": "",
"Address8": "",
"Address9": "",
"Address10": "",
"Address11": "",
"Address12": "",
"DeliveryAddress": "",
"DeliveryAddress1": "",
"DeliveryAddress2": "",
"DeliveryAddress3": "",
"DeliveryAddress4": "",
"DeliveryAddress5": "",
"DeliveryAddress6": "",
"DeliveryAddress7": "",
"DeliveryAddress8": "",
"DeliveryAddress9": "",
"DeliveryAddress10": "",
"DeliveryAddress11": "",
"DeliveryAddress12": "",
"CountryName": "United States Of America",
"ISO3166_2": "US",
"ISO3166_3": "USA",
"ISO3166_N": "840",
"SuperAdministrativeArea": "",
"AdministrativeArea": "CA",
"SubAdministrativeArea": "Orange",
"Locality": "Rancho Santa Margarita",
"CityAccepted": "Rancho Sta Marg,Rsm,Rcho Sta Marg",
"CityNotAccepted": "",
"DependentLocality": "",
"DoubleDependentLocality": "",
"Thoroughfare": "",
"DependentThoroughfare": "",
"Building": "",
"Premise": "",
"SubBuilding": "",
"PostalCode": "92688",
"PostalCodePrimary": "92688",
"PostalCodeSecondary": "",
"Organization": "",
"PostBox": "",
"Unmatched": "",
"GeneralDelivery": "",
"DeliveryInstallation": "",
"Route": "",
"AdditionalContent": "",
"CountrySubdivisionCode": "US-CA",
"MAK": "",
"BaseMAK": "",
"Latitude": "",
"Longitude": "",
"DistanceFromPoint": 0
}
}
]
}
<ResponseGlobal
xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Version>8.0.0.1249</Version>
<ResultCode>XS01</ResultCode>
<ErrorString></ErrorString>
<Results>
<ResultGlobal>
<Address>
<Address></Address>
<Address1></Address1>
<Address2></Address2>
<Address3></Address3>
<Address4></Address4>
<Address5></Address5>
<Address6></Address6>
<Address7></Address7>
<Address8></Address8>
<Address9></Address9>
<Address10></Address10>
<Address11></Address11>
<Address12></Address12>
<DeliveryAddress></DeliveryAddress>
<DeliveryAddress1></DeliveryAddress1>
<DeliveryAddress2></DeliveryAddress2>
<DeliveryAddress3></DeliveryAddress3>
<DeliveryAddress4></DeliveryAddress4>
<DeliveryAddress5></DeliveryAddress5>
<DeliveryAddress6></DeliveryAddress6>
<DeliveryAddress7></DeliveryAddress7>
<DeliveryAddress8></DeliveryAddress8>
<DeliveryAddress9></DeliveryAddress9>
<DeliveryAddress10></DeliveryAddress10>
<DeliveryAddress11></DeliveryAddress11>
<DeliveryAddress12></DeliveryAddress12>
<CountryName>United States Of America</CountryName>
<ISO3166_2>US</ISO3166_2>
<ISO3166_3>USA</ISO3166_3>
<ISO3166_N>840</ISO3166_N>
<SuperAdministrativeArea></SuperAdministrativeArea>
<AdministrativeArea>CA</AdministrativeArea>
<SubAdministrativeArea>Orange</SubAdministrativeArea>
<Locality>Rancho Santa Margarita</Locality>
<CityAccepted>Rancho Sta Marg,Rsm,Rcho Sta Marg</CityAccepted>
<CityNotAccepted></CityNotAccepted>
<DependentLocality></DependentLocality>
<DoubleDependentLocality></DoubleDependentLocality>
<Thoroughfare></Thoroughfare>
<DependentThoroughfare></DependentThoroughfare>
<Building></Building>
<Premise></Premise>
<SubBuilding></SubBuilding>
<PostalCode>92688</PostalCode>
<PostalCodePrimary>92688</PostalCodePrimary>
<PostalCodeSecondary></PostalCodeSecondary>
<Organization></Organization>
<PostBox></PostBox>
<Unmatched></Unmatched>
<GeneralDelivery></GeneralDelivery>
<DeliveryInstallation></DeliveryInstallation>
<Route></Route>
<AdditionalContent></AdditionalContent>
<CountrySubdivisionCode>US-CA</CountrySubdivisionCode>
<MAK></MAK>
<BaseMAK></BaseMAK>
<Latitude></Latitude>
<Longitude></Longitude>
<DistanceFromPoint>0</DistanceFromPoint>
</Address>
</ResultGlobal>
</Results>
</ResponseGlobal>
{
"d": {
"__type": "ResponseGlobal",
"Version": "8.0.0.1249",
"ResultCode": "XS01",
"ErrorString": "",
"Results": [
{
"__type": "ResultGlobal",
"Address": {
"__type": "AddressGlobal",
"Address": "",
"Address1": "",
"Address2": "",
"Address3": "",
"Address4": "",
"Address5": "",
"Address6": "",
"Address7": "",
"Address8": "",
"Address9": "",
"Address10": "",
"Address11": "",
"Address12": "",
"DeliveryAddress": "",
"DeliveryAddress1": "",
"DeliveryAddress2": "",
"DeliveryAddress3": "",
"DeliveryAddress4": "",
"DeliveryAddress5": "",
"DeliveryAddress6": "",
"DeliveryAddress7": "",
"DeliveryAddress8": "",
"DeliveryAddress9": "",
"DeliveryAddress10": "",
"DeliveryAddress11": "",
"DeliveryAddress12": "",
"CountryName": "United States Of America",
"ISO3166_2": "US",
"ISO3166_3": "USA",
"ISO3166_N": "840",
"SuperAdministrativeArea": "",
"AdministrativeArea": "CA",
"SubAdministrativeArea": "Orange",
"Locality": "Rancho Santa Margarita",
"CityAccepted": "Rancho Sta Marg,Rsm,Rcho Sta Marg",
"CityNotAccepted": "",
"DependentLocality": "",
"DoubleDependentLocality": "",
"Thoroughfare": "",
"DependentThoroughfare": "",
"Building": "",
"Premise": "",
"SubBuilding": "",
"PostalCode": "92688",
"PostalCodePrimary": "92688",
"PostalCodeSecondary": "",
"Organization": "",
"PostBox": "",
"Unmatched": "",
"GeneralDelivery": "",
"DeliveryInstallation": "",
"Route": "",
"AdditionalContent": "",
"CountrySubdivisionCode": "US-CA",
"MAK": "",
"BaseMAK": "",
"Latitude": "",
"Longitude": "",
"DistanceFromPoint": 0
}
}
]
}
}
Service Level Response Fields#
Output Name |
Description |
|---|---|
ErrorString |
Lists error codes from any errors caused by the most recent request. |
ResultCode |
Lists result codes for the most recent request. |
Results |
Array with Address array(s) containing the record level fields. |
Version |
The current service version number. |
Record Level Response Fields#
Output Name |
Description |
|---|---|
AdditionalContent |
Any additional content associated with the address. |
Address |
The full address in one line. |
Address1 |
Address line 1. |
Address10 |
Address line 10. |
Address11 |
Address line 11. |
Address12 |
Address line 12. |
Address2 |
Address line 2. |
Address3 |
Address line 3. |
Address4 |
Address line 4. |
Address5 |
Address line 5. |
Address6 |
Address line 6. |
Address7 |
Address line 7. |
Address8 |
Address line 8. |
Address9 |
Address line 9. |
AdministrativeArea |
State, Province. This is a common geographic area unit for larger countries. |
BaseMAK |
Melissa Address Key Base. If the address has suites or apartments the 10 digit proprietary BaseMAK will be returned and correspond to the overall building. |
Building |
A descriptive name identifying an individual location. |
CityAccepted |
A list of accepted city names. |
CityNotAccepted |
Any non-accepted city names will be included in this field. |
CountryName |
The name of the country. |
CountrySubdivisionCode |
This is the ISO3166-2 code for country subdivisions, usually the administrative area for a country. The format is the 2 letter country code followed by a dash followed by 2 or 3 characters or two numbers. |
DeliveryAddress |
The full delivery address in one line. |
DeliveryAddress1 |
Delivery address line 1. |
DeliveryAddress10 |
Delivery address line 10. |
DeliveryAddress11 |
Delivery address line 11. |
DeliveryAddress12 |
Delivery address line 12. |
DeliveryAddress2 |
Delivery address line 2. |
DeliveryAddress3 |
Delivery address line 3. |
DeliveryAddress4 |
Delivery address line 4. |
DeliveryAddress5 |
Delivery address line 5. |
DeliveryAddress6 |
Delivery address line 6. |
DeliveryAddress7 |
Delivery address line 7. |
DeliveryAddress8 |
Delivery address line 8. |
DeliveryAddress9 |
Delivery address line 9. |
DeliveryInstallation |
Canada Only. The delivery installation for the address. |
DependentLocality |
Urbanization. A dependent locality is a logical area unit that is smaller than a locality but larger than a double dependent locality or thoroughfare. It can often be associated with a neighborhood or sector. |
DependentThoroughfare |
Dependent Street. A second thoroughfare that is required to narrow down the final address. This is rarely used. |
DistanceFromPoint |
The distance in miles from the specified point. |
DoubleDependentLocality |
A logical area unit that is smaller than a dependent locality but bigger than a thoroughfare. This field is rarely used. |
GeneralDelivery |
The USPS address type assigned for the address. |
ISO3166_2 |
The 2 letter ISO 3166 country code value. For example: |
ISO3166_3 |
The 3 letter ISO 3166 country code value. For example: |
ISO3166_N |
The ISO 3166 country number value. For example: |
Latitude |
The latitude geographic coordinate of the output address. |
Locality |
City, Town. The most common geographic area, used by virtually all countries. |
Longitude |
The longitude geographic coordinate of the output address. |
MAK |
Melissa Address Key. A unique key assigned to the submitted address. |
Organization |
Business, Company. This name of the organization. |
PostalCode |
ZIP Code. Complete postal code for a particular delivery point. |
PostalCodePrimary |
The primary portion of the postal code. In the US, this is a 5-digit ZIP code. |
PostalCodeSecondary |
The secondary portion of the postal code. In the US this is the +4 of the ZIP code. |
PostBox |
Post box information for a particular delivery point. |
Premise |
Street Number. The premise identifying number. |
Route |
Canada Only. The route service number. |
SubAdministrativeArea |
County. A logical area that that is smaller than the administrative area but larger than a locality. Rarely used as part of an official address. |
SubBuilding |
A smaller division of a building. For example, if an address has a building name that is a part of a larger set of buildings, then the sub building may be populated. |
SuperAdministrativeArea |
A region within a country that has a higher level of administrative control or governance than other areas. |
Thoroughfare |
Street. The most common street or block data element. |
Unmatched |
Any part of the address that did not match other fields will be saved in this field. |
/web/GlobalExpressThoroughfare#
GlobalExpressThroughfare is a means for retrieving the thoroughfares within a Postal Code using the Postal Code and beginning of the thoroughfare name as the inputs.
Try It Now#
curl -X GET "https://expressentry.melissadata.net/web/GlobalExpressThoroughfare?\
&format=json\
&id={{customerId}}\
&maxrecords=10\
&country=US\
&postalcode=92688\
&thoroughfare=Avenida+Empresa" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
curl -X GET "https://expressentry.melissadata.net/web/GlobalExpressThoroughfare?\
&format=xml\
&id={{customerId}}\
&maxrecords=10\
&country=US\
&postalcode=92688\
&thoroughfare=Avenida+Empresa" \
-H "Content-Type: application/xml" \
-H "Accept: */*"
curl -X GET "https://expressentry.melissadata.net/jsonp/GlobalExpressThoroughfare?\
&format=json\
&id={{customerId}}\
&maxrecords=10\
&country=US\
&postalcode=92688\
&thoroughfare=Avenida+Empresa" \
-H "Content-Type: application/javascript" \
-H "Accept: application/javascript"
Request Parameters#
Code |
Description |
|---|---|
Record Level Parameters |
|
|
|
|
Desired format of the response. Possible values are |
|
The License Key issued by Melissa. |
|
The maximum number of records to return. The default is |
Address Parameters |
|
|
Default set to US. The ISO2Code or country name of the address. |
|
Postal Code, ZIP. The complete postal code. |
|
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, |
Headers#
Content-Type: application/json
Accept: application/json
Content-Type: application/xml
Accept: application/xml
Content-Type: application/javascript
Accept: application/javascript
Response#
{
"Version": "8.0.0.1249",
"ResultCode": "XS01",
"ErrorString": "",
"Results": [
{
"Address": {
"Address": "",
"Address1": "Avenida Empresa",
"Address2": "",
"Address3": "",
"Address4": "",
"Address5": "",
"Address6": "",
"Address7": "",
"Address8": "",
"Address9": "",
"Address10": "",
"Address11": "",
"Address12": "",
"DeliveryAddress": "",
"DeliveryAddress1": "",
"DeliveryAddress2": "",
"DeliveryAddress3": "",
"DeliveryAddress4": "",
"DeliveryAddress5": "",
"DeliveryAddress6": "",
"DeliveryAddress7": "",
"DeliveryAddress8": "",
"DeliveryAddress9": "",
"DeliveryAddress10": "",
"DeliveryAddress11": "",
"DeliveryAddress12": "",
"CountryName": "United States Of America",
"ISO3166_2": "US",
"ISO3166_3": "USA",
"ISO3166_N": "840",
"SuperAdministrativeArea": "",
"AdministrativeArea": "CA",
"SubAdministrativeArea": "CA",
"Locality": "Rancho Santa Margarita",
"CityAccepted": "Rancho Sta Marg,Rsm,Rcho Sta Marg",
"CityNotAccepted": "",
"DependentLocality": "",
"DoubleDependentLocality": "",
"Thoroughfare": "Avenida Empresa",
"DependentThoroughfare": "",
"Building": "",
"Premise": "",
"SubBuilding": "",
"PostalCode": "92688",
"PostalCodePrimary": "92688",
"PostalCodeSecondary": "",
"Organization": "",
"PostBox": "",
"Unmatched": "",
"GeneralDelivery": "",
"DeliveryInstallation": "",
"Route": "",
"AdditionalContent": "",
"CountrySubdivisionCode": "US-CA",
"MAK": "",
"BaseMAK": "",
"Latitude": "",
"Longitude": "",
"DistanceFromPoint": 0
}
}
]
}
<ResponseGlobal
xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Version>8.0.0.1249</Version>
<ResultCode>XS01</ResultCode>
<ErrorString></ErrorString>
<Results>
<ResultGlobal>
<Address>
<Address></Address>
<Address1>Avenida Empresa</Address1>
<Address2></Address2>
<Address3></Address3>
<Address4></Address4>
<Address5></Address5>
<Address6></Address6>
<Address7></Address7>
<Address8></Address8>
<Address9></Address9>
<Address10></Address10>
<Address11></Address11>
<Address12></Address12>
<DeliveryAddress></DeliveryAddress>
<DeliveryAddress1></DeliveryAddress1>
<DeliveryAddress2></DeliveryAddress2>
<DeliveryAddress3></DeliveryAddress3>
<DeliveryAddress4></DeliveryAddress4>
<DeliveryAddress5></DeliveryAddress5>
<DeliveryAddress6></DeliveryAddress6>
<DeliveryAddress7></DeliveryAddress7>
<DeliveryAddress8></DeliveryAddress8>
<DeliveryAddress9></DeliveryAddress9>
<DeliveryAddress10></DeliveryAddress10>
<DeliveryAddress11></DeliveryAddress11>
<DeliveryAddress12></DeliveryAddress12>
<CountryName>United States Of America</CountryName>
<ISO3166_2>US</ISO3166_2>
<ISO3166_3>USA</ISO3166_3>
<ISO3166_N>840</ISO3166_N>
<SuperAdministrativeArea></SuperAdministrativeArea>
<AdministrativeArea>CA</AdministrativeArea>
<SubAdministrativeArea>CA</SubAdministrativeArea>
<Locality>Rancho Santa Margarita</Locality>
<CityAccepted>Rancho Sta Marg,Rsm,Rcho Sta Marg</CityAccepted>
<CityNotAccepted></CityNotAccepted>
<DependentLocality></DependentLocality>
<DoubleDependentLocality></DoubleDependentLocality>
<Thoroughfare>Avenida Empresa</Thoroughfare>
<DependentThoroughfare></DependentThoroughfare>
<Building></Building>
<Premise></Premise>
<SubBuilding></SubBuilding>
<PostalCode>92688</PostalCode>
<PostalCodePrimary>92688</PostalCodePrimary>
<PostalCodeSecondary></PostalCodeSecondary>
<Organization></Organization>
<PostBox></PostBox>
<Unmatched></Unmatched>
<GeneralDelivery></GeneralDelivery>
<DeliveryInstallation></DeliveryInstallation>
<Route></Route>
<AdditionalContent></AdditionalContent>
<CountrySubdivisionCode>US-CA</CountrySubdivisionCode>
<MAK></MAK>
<BaseMAK></BaseMAK>
<Latitude></Latitude>
<Longitude></Longitude>
<DistanceFromPoint>0</DistanceFromPoint>
</Address>
</ResultGlobal>
</Results>
</ResponseGlobal>
{
"d": {
"__type": "ResponseGlobal",
"Version": "8.0.0.1249",
"ResultCode": "XS01",
"ErrorString": "",
"Results": [
{
"__type": "ResultGlobal",
"Address": {
"__type": "AddressGlobal",
"Address": "",
"Address1": "Avenida Empresa",
"Address2": "",
"Address3": "",
"Address4": "",
"Address5": "",
"Address6": "",
"Address7": "",
"Address8": "",
"Address9": "",
"Address10": "",
"Address11": "",
"Address12": "",
"DeliveryAddress": "",
"DeliveryAddress1": "",
"DeliveryAddress2": "",
"DeliveryAddress3": "",
"DeliveryAddress4": "",
"DeliveryAddress5": "",
"DeliveryAddress6": "",
"DeliveryAddress7": "",
"DeliveryAddress8": "",
"DeliveryAddress9": "",
"DeliveryAddress10": "",
"DeliveryAddress11": "",
"DeliveryAddress12": "",
"CountryName": "United States Of America",
"ISO3166_2": "US",
"ISO3166_3": "USA",
"ISO3166_N": "840",
"SuperAdministrativeArea": "",
"AdministrativeArea": "CA",
"SubAdministrativeArea": "CA",
"Locality": "Rancho Santa Margarita",
"CityAccepted": "Rancho Sta Marg,Rsm,Rcho Sta Marg",
"CityNotAccepted": "",
"DependentLocality": "",
"DoubleDependentLocality": "",
"Thoroughfare": "Avenida Empresa",
"DependentThoroughfare": "",
"Building": "",
"Premise": "",
"SubBuilding": "",
"PostalCode": "92688",
"PostalCodePrimary": "92688",
"PostalCodeSecondary": "",
"Organization": "",
"PostBox": "",
"Unmatched": "",
"GeneralDelivery": "",
"DeliveryInstallation": "",
"Route": "",
"AdditionalContent": "",
"CountrySubdivisionCode": "US-CA",
"MAK": "",
"BaseMAK": "",
"Latitude": "",
"Longitude": "",
"DistanceFromPoint": 0
}
}
]
}
}
Service Level Response Fields#
Output Name |
Description |
|---|---|
ErrorString |
Lists error codes from any errors caused by the most recent request. |
ResultCode |
Lists result codes for the most recent request. |
Results |
Array with Address array(s) containing the record level fields. |
Version |
The current service version number. |
Record Level Response Fields#
Output Name |
Description |
|---|---|
AdditionalContent |
Any additional content associated with the address. |
Address |
The full address in one line. |
Address1 |
Address line 1. |
Address10 |
Address line 10. |
Address11 |
Address line 11. |
Address12 |
Address line 12. |
Address2 |
Address line 2. |
Address3 |
Address line 3. |
Address4 |
Address line 4. |
Address5 |
Address line 5. |
Address6 |
Address line 6. |
Address7 |
Address line 7. |
Address8 |
Address line 8. |
Address9 |
Address line 9. |
AdministrativeArea |
State, Province. This is a common geographic area unit for larger countries. |
BaseMAK |
Melissa Address Key Base. If the address has suites or apartments the 10 digit proprietary BaseMAK will be returned and correspond to the overall building. |
Building |
A descriptive name identifying an individual location. |
CityAccepted |
A list of accepted city names. |
CityNotAccepted |
Any non-accepted city names will be included in this field. |
CountryName |
The name of the country. |
CountrySubdivisionCode |
This is the ISO3166-2 code for country subdivisions, usually the administrative area for a country. The format is the 2 letter country code followed by a dash followed by 2 or 3 characters or two numbers. |
DeliveryAddress |
The full delivery address in one line. |
DeliveryAddress1 |
Delivery address line 1. |
DeliveryAddress10 |
Delivery address line 10. |
DeliveryAddress11 |
Delivery address line 11. |
DeliveryAddress12 |
Delivery address line 12. |
DeliveryAddress2 |
Delivery address line 2. |
DeliveryAddress3 |
Delivery address line 3. |
DeliveryAddress4 |
Delivery address line 4. |
DeliveryAddress5 |
Delivery address line 5. |
DeliveryAddress6 |
Delivery address line 6. |
DeliveryAddress7 |
Delivery address line 7. |
DeliveryAddress8 |
Delivery address line 8. |
DeliveryAddress9 |
Delivery address line 9. |
DeliveryInstallation |
Canada Only. The delivery installation for the address. |
DependentLocality |
Urbanization. A dependent locality is a logical area unit that is smaller than a locality but larger than a double dependent locality or thoroughfare. It can often be associated with a neighborhood or sector. |
DependentThoroughfare |
Dependent Street. A second thoroughfare that is required to narrow down the final address. This is rarely used. |
DistanceFromPoint |
The distance in miles from the specified point. |
DoubleDependentLocality |
A logical area unit that is smaller than a dependent locality but bigger than a thoroughfare. This field is rarely used. |
GeneralDelivery |
The USPS address type assigned for the address. |
ISO3166_2 |
The 2 letter ISO 3166 country code value. For example: |
ISO3166_3 |
The 3 letter ISO 3166 country code value. For example: |
ISO3166_N |
The ISO 3166 country number value. For example: |
Latitude |
The latitude geographic coordinate of the output address. |
Locality |
City, Town. The most common geographic area, used by virtually all countries. |
Longitude |
The longitude geographic coordinate of the output address. |
MAK |
Melissa Address Key. A unique key assigned to the submitted address. |
Organization |
Business, Company. This name of the organization. |
PostalCode |
ZIP Code. Complete postal code for a particular delivery point. |
PostalCodePrimary |
The primary portion of the postal code. In the US, this is a 5-digit ZIP code. |
PostalCodeSecondary |
The secondary portion of the postal code. In the US this is the +4 of the ZIP code. |
PostBox |
Post box information for a particular delivery point. |
Premise |
Street Number. The premise identifying number. |
Route |
Canada Only. The route service number. |
SubAdministrativeArea |
County. A logical area that that is smaller than the administrative area but larger than a locality. Rarely used as part of an official address. |
SubBuilding |
A smaller division of a building. For example, if an address has a building name that is a part of a larger set of buildings, then the sub building may be populated. |
SuperAdministrativeArea |
A region within a country that has a higher level of administrative control or governance than other areas. |
Thoroughfare |
Street. The most common street or block data element. |
Unmatched |
Any part of the address that did not match other fields will be saved in this field. |
/web/GlobalExpressCountry#
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.
Try It Now#
curl -X GET "https://expressentry.melissadata.net/web/GlobalExpressCountry?\
&format=json\
&id={{customerId}}\
&country=US" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
curl -X GET "https://expressentry.melissadata.net/web/GlobalExpressCountry?\
&format=xml\
&id={{customerId}}\
&country=US" \
-H "Content-Type: application/xml" \
-H "Accept: */*"
curl -X GET "https://expressentry.melissadata.net/jsonp/GlobalExpressCountry?\
&format=json\
&id={{customerId}}\
&country=US" \
-H "Content-Type: application/javascript" \
-H "Accept: application/javascript"
Request Parameters#
Code |
Description |
|---|---|
Record Level Parameters |
|
|
Desired format of the response. Possible values are |
|
The License Key issued by Melissa. |
Address Parameters |
|
|
The search term for the country/countries desired. |
Headers#
Content-Type: application/json
Accept: application/json
Content-Type: application/xml
Accept: application/xml
Content-Type: application/javascript
Accept: application/javascript
Response#
{
"Version": "8.0.0.1249",
"ResultCode": "XS01",
"ErrorString": "",
"Results": [
{
"Country": "Usbekistan",
"English": "Uzbekistan",
"Spanish": "Uzbekistán",
"French": "Ouzbékistan",
"German": "Usbekistan",
"SimplifiedChinese": "乌兹别克斯坦 ",
"Char2ISO": "UZ",
"Char3ISO": "UZB",
"ISONumeric": "860"
},
...
{
"Country": "Tierras Australes y Antárticas Francesas",
"English": "French Southern Territories",
"Spanish": "Tierras Australes y Antárticas Francesas",
"French": "Terres Australes Françaises",
"German": "Französische Süd- und Antarktisgebiete",
"SimplifiedChinese": "法属南部领土",
"Char2ISO": "TF",
"Char3ISO": "ATF",
"ISONumeric": "260"
}
]
}
<Response
xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Version>8.0.0.1249</Version>
<ResultCode>XS01</ResultCode>
<ErrorString></ErrorString>
<Results>
<Result>
<Country>Usbekistan</Country>
<English>Uzbekistan</English>
<Spanish>Uzbekistán</Spanish>
<French>Ouzbékistan</French>
<German>Usbekistan</German>
<SimplifiedChinese>乌兹别克斯坦 </SimplifiedChinese>
<Char2ISO>UZ</Char2ISO>
<Char3ISO>UZB</Char3ISO>
<ISONumeric>860</ISONumeric>
</Result>
...
<Result>
<Country>Tierras Australes y Antárticas Francesas</Country>
<English>French Southern Territories</English>
<Spanish>Tierras Australes y Antárticas Francesas</Spanish>
<French>Terres Australes Françaises</French>
<German>Französische Süd- und Antarktisgebiete</German>
<SimplifiedChinese>法属南部领土</SimplifiedChinese>
<Char2ISO>TF</Char2ISO>
<Char3ISO>ATF</Char3ISO>
<ISONumeric>260</ISONumeric>
</Result>
</Results>
</Response>
{
"d": {
"Version": "8.0.0.1249",
"ResultCode": "XS01",
"ErrorString": "",
"Results": [
{
"Country": "Usbekistan",
"English": "Uzbekistan",
"Spanish": "Uzbekistán",
"French": "Ouzbékistan",
"German": "Usbekistan",
"SimplifiedChinese": "乌兹别克斯坦 ",
"Char2ISO": "UZ",
"Char3ISO": "UZB",
"ISONumeric": "860"
},
...
{
"Country": "Tierras Australes y Antárticas Francesas",
"English": "French Southern Territories",
"Spanish": "Tierras Australes y Antárticas Francesas",
"French": "Terres Australes Françaises",
"German": "Französische Süd- und Antarktisgebiete",
"SimplifiedChinese": "法属南部领土",
"Char2ISO": "TF",
"Char3ISO": "ATF",
"ISONumeric": "260"
}
]
}
}
Service Level Response Fields#
Output Name |
Description |
|---|---|
ErrorString |
Lists error codes from any errors caused by the most recent request. |
ResultCode |
Lists result codes for the most recent request. |
Results |
Array containing the record level fields. |
Version |
The current service version number. |
Record Level Response Fields#
Output Name |
Description |
|---|---|
Char2ISO |
The 2 letter ISO 3166 country code value. For example: |
Char3ISO |
The 3 letter ISO 3166 country code value. For example: |
Country |
The name of the country. |
English |
The standardized country name spelling/script for English pronunciation. |
French |
The standardized country name spelling/script for French pronunciation. |
German |
The standardized country name spelling/script for German pronunciation. |
ISONumeric |
The ISO 3166 country number value. For example: |
SimplifiedChinese |
The standardized country name spelling/script for Simplified Chinese pronunciation. |
Spanish |
The standardized country name spelling/script for Spanish pronunciation. |
Deprecated Endpoints#
Caution
These endpoints are deprecated. They are not recommended for new development unless advised by Melissa staff. Please see the Global Express Entry endpoints for new development.
Documentation for Deprecated Endpoints:
Token Server#
Using the Token Server#
Global Express Entry supports the use of authentication tokens to access the service. The token server is most often used when your license string must be concealed, such as in a web page using Express Entry that is facing the public.
Tokens are more secure when compared to the other methods of passing sensitive information in plain text over a network, where it could be observed by a third party. PHP code and a JavaScript script which calls the PHP are provided to demonstrate how to implement tokens in a web page.
In order to implement the PHP and JavaScript sample:
The server must have PHP enabled.
The sample PHP must be loaded on the server and your License Key must be entered where marked in the code.
The JavaScript sample must be pasted into your webpage and edited with your IP information.
Both the PHP sample and the calling Javascript must be on the same domain.
Note that the page where the JavaScript resides must be in the same domain as the file containing the PHP token-handling code. This is due to ‘same origin policy’ of AJAX. If Express Entry does not respond with addresses after inserting/adding the Javascript and PHP code, make sure that the JavaScript is called from the same domain as the server hosting the PHP, and that the token variable is being used instead of your ident or License Key.
The code is commented where the necessary changes (such as adding the License Key) are to be made.
REST#
You may also make a REST request to the token server. The service URL is:
https://token.melissadata.net/v3/web/Service.svc/RequestToken?
The available REST request parameters are:
L=[LICENSE KEY]
&P=[PACKAGE OR PACKAGES]
&IP=[IP ADDRESS]
&TS=[TIMESPAN (optional)]
A sample REST request would be:
https://token.melissadata.net/v3/web/Service.svc/RequestToken?L=[LICENSE KEY]&p=pkgExpressEntry&IP=[IP ADDRESS]&TS=0015
or if you have Geocoding enabled:
https://token.melissadata.net/v3/web/Service.svc/RequestToken?L=[LICENSE KEY]&p=pkgExpressEntry,PkgExpressEntryGeo&IP=[IP ADDRESS]&TS=0015
This returns a token starting with T:.
The IP Address is optional added security.
If you send the client IP Address in your public-facing web page setup, we can detect unauthorized use of your tokens and take preventative measures.
&TS controls the token lifetime.
The argument HHMM will set the token timespan to HH hours and MM minutes, with a default and maximum of 24 hours 0 minutes.
The minimum token lifetime is 10 minutes.
A sample REST response would be:
<RequestTokenResponse>
<result/>
<token> T:pr6HTPwPUBeJ3XWpIC6UyC**Bc4ElmAuNlvsd7pri75pJL** </token>
</RequestTokenResponse>
Token Server Support Sample Project#
Token Server Support Sample Code#
PHP Code#
<?php
// change this to your License Key
$License = '########';
//APACHE - You can use any other ways to get your external IP. Make sure that its echoing external IP not internal LAN IP.
//Depending on how secure or optimized you want to capture your IP address. You may want to change how IP is determined
//EXAMPLE ONLY
//$host= gethostname();
//$ip = gethostbyname($host);
//IIS
//EXAMPLE ONLY
$ip = gethostbyname($_SERVER['SERVER_NAME']);
//check for function
if ( !isset($_REQUEST['function']) )
exit();
else
$func = $_REQUEST['function'];
//get the token
if ($func == 'gettoken')
{
//customize the token request
//example for Check Action
$xml = file_get_contents('http://token.melissadata.net/v3/web/Service.svc/RequestToken?L=' . $License . '&P=pkgExpressEntry&IP=' . $ip);
//Personator Packages
//pkgBorgCheck Personator Web Service (Check Action)
//pkgBorgVerify Personator Web Service (Verify Action)
//pkgBorgMoveUpdate Personator Web Service (Move Update Action)
//pkgBorgAppend Personator Web Service (Append Action)
//pkgBorgGeoCode Personator Web Service (Geocode Action)
//pkgBorgGeoPoint Personator Web Service (GeoPoint Action)
//pkgExpressEntry Express Entry
//Global Address Packages
//pkgIntAddressCheck Global Address Web Service
//unpack the xml
$xml_r = new SimpleXMLElement($xml);
//grab out the token
$token = (string)$xml_r->Token;
//send the token to the client in a json packet
$data[] = array('token' => $token);
//this encodes the data and sends it back to the client
echo json_encode($data);
flush();
}
?>
JavaScript Code (for your web page)#
var token;
window.onload = function()
{
$.ajax(
{
type: "POST",
// Your PHP server hostname or IP in the following line
url: "http://192.168.13.237/licensekey.php", //NOTE: ajax requires that the client and server side scripts be located on the same domain
data: {function:"gettoken"},
dataType: 'json',
success: function(data)
{
token = data[0].token;
//alert(token); // uncomment this if you want to see the token being returned
}
});
}
Dev Console#
Result Codes#
Please visit Global Express Entry Result Codes for the full list of result codes returned by Global Express Entry.
Interpreting Results#
Global Express Entry Free Form returns 3 result codes to indicate whether the set of addresses in the output is complete, if the User should narrow down the results by adding more characters, or if there was no match for the partial address given as input.
Code |
Description |
Recommendation |
|---|---|---|
|
The search was completed and the complete result set was returned. |
Good |
|
The search was completed and a partial result set was returned. |
Increase |
|
The search was completed and no results were found. |
Have the user correct the input |