Deprecated

Deprecated#

Deprecated Endpoints#

/web/ExpressFreeForm#

Caution

This endpoint is deprecated. It is not recommended for new development unless advised by Melissa staff. Please see the GlobalExpressFreeForm endpoint for new development.

The ExpressFreeForm endpoint is provided as a means of retrieving all available U.S. address elements with a Free Form query. ExpressFreeForm returns:

  • AddressLine1

  • City

  • State

  • PostalCode

  • AddressKey

  • SuiteName

  • SuiteCount

  • SuiteList

  • PlusFour

Try It Now#

  • GET JSON
  • GET XML
  • GET JSONP
curl -X GET "https://expressentry.melissadata.net/web/ExpressFreeForm?\
&cols=\
&format=json\
&id={{customerId}}\
&maxrecords=10\
&opt=\
&ff=Rancho+Santa+Margarita,+CA+92688" \
-H "Content-Type: application/json" \
-H "Accept: application/json"

curl -X GET "https://expressentry.melissadata.net/web/ExpressFreeForm?\
&cols=\
&format=xml\
&id={{customerId}}\
&maxrecords=10\
&opt=\
&ff=Rancho+Santa+Margarita,+CA+92688" \
-H "Content-Type: application/xml" \
-H "Accept: */*"

curl -X GET "https://expressentry.melissadata.net/jsonp/ExpressFreeForm?\
&cols=\
&format=jsonp\
&id={{customerId}}\
&maxrecords=10\
&opt=\
&ff=Rancho+Santa+Margarita,+CA+92688" \
-H "Content-Type: application/javascript" \
-H "Accept: application/javascript"

Request Parameters#

Code

Description

Record Level Parameters

cols

Specifies which column(s) to be output as a comma delimited string. See Columns for more information.

format

Desired format of the response. Possible values are json, jsonp, or xml, depending on the endpoint.

id

The License Key issued by Melissa.

maxrecords

The maximum number of records to return. The default is 10 with a maximum of 100.

opt

Set Options

poboxes

Address Parameters

ff

The free form address, with search terms delimited by %20 or a space.
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

results

Return Address Object result codes for each address in the Extras field. For example, a USPS only address will return "AddrObjectResultCode": "AS01".

County

Return County Name field for CountyName in the Extras element.
Filtering#

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

true

U.S. Addresses will return P.O. Boxes and military addresses.

false

P.O. Boxes and military addresses will not be returned.

Headers#

  • GET JSON
  • GET XML
  • GET JSONP
Content-Type: application/json
Accept: application/json

Content-Type: application/xml
Accept: application/xml

Content-Type: application/javascript
Accept: application/javascript

Response#

  • GET JSON
  • GET XML
  • GET JSONP
{
  "Version": "8.0.0.1249",
  "ResultCode": "XS02",
  "ErrorString": "",
  "Results": [
    {
      "Address": {
        "AddressLine1": "9 Santa Agatha",
        "City": "Rancho Santa Margarita",
        "CityAccepted": "Rancho Sta Marg,Rsm,Rcho Sta Marg",
        "CityNotAccepted": "",
        "State": "CA",
        "PostalCode": "92688-2427",
        "CountrySubdivisionCode": "US-CA",
        "AddressKey": "92688242709",
        "SuiteName": "",
        "SuiteCount": 0,
        "SuiteList": [
          ""
        ],
        "PlusFour": [
          "2427"
        ],
        "MAK": "1279312453",
        "BaseMAK": ""
      }
    },
    ...
    {
      "Address": {
        "AddressLine1": "9 Floramar",
        "City": "Rancho Santa Margarita",
        "CityAccepted": "Rancho Sta Marg,Rsm,Rcho Sta Marg",
        "CityNotAccepted": "",
        "State": "CA",
        "PostalCode": "92688-1307",
        "CountrySubdivisionCode": "US-CA",
        "AddressKey": "92688130709",
        "SuiteName": "",
        "SuiteCount": 0,
        "SuiteList": [
          ""
        ],
        "PlusFour": [
          "1307"
        ],
        "MAK": "6148025901",
        "BaseMAK": ""
      }
    }
  ]
}

<Response
  xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Version>8.0.0.1249</Version>
  <ResultCode>XS02</ResultCode>
  <ErrorString></ErrorString>
  <Results>
    <Result>
      <Address>
        <AddressLine1>9 Santa Agatha</AddressLine1>
        <City>Rancho Santa Margarita</City>
        <CityAccepted>Rancho Sta Marg,Rsm,Rcho Sta Marg</CityAccepted>
        <CityNotAccepted></CityNotAccepted>
        <State>CA</State>
        <PostalCode>92688-2427</PostalCode>
        <CountrySubdivisionCode>US-CA</CountrySubdivisionCode>
        <AddressKey>92688242709</AddressKey>
        <SuiteName></SuiteName>
        <SuiteCount>0</SuiteCount>
        <SuiteList>
          <string></string>
        </SuiteList>
        <PlusFour>
          <string>2427</string>
        </PlusFour>
        <MAK>1279312453</MAK>
        <BaseMAK></BaseMAK>
      </Address>
    </Result>
    ...
    <Result>
      <Address>
        <AddressLine1>9 Floramar</AddressLine1>
        <City>Rancho Santa Margarita</City>
        <CityAccepted>Rancho Sta Marg,Rsm,Rcho Sta Marg</CityAccepted>
        <CityNotAccepted></CityNotAccepted>
        <State>CA</State>
        <PostalCode>92688-1307</PostalCode>
        <CountrySubdivisionCode>US-CA</CountrySubdivisionCode>
        <AddressKey>92688130709</AddressKey>
        <SuiteName></SuiteName>
        <SuiteCount>0</SuiteCount>
        <SuiteList>
          <string></string>
        </SuiteList>
        <PlusFour>
          <string>1307</string>
        </PlusFour>
        <MAK>6148025901</MAK>
        <BaseMAK></BaseMAK>
      </Address>
    </Result>
  </Results>
</Response>

{
  "d": {
    "__type": "Response",
    "Version": "8.0.0.1249",
    "ResultCode": "XS02",
    "ErrorString": "",
    "Results": [
      {
        "__type": "Result",
        "Address": {
          "__type": "Address",
          "AddressLine1": "9 Santa Agatha",
          "City": "Rancho Santa Margarita",
          "CityAccepted": "Rancho Sta Marg,Rsm,Rcho Sta Marg",
          "CityNotAccepted": "",
          "State": "CA",
          "PostalCode": "92688-2427",
          "CountrySubdivisionCode": "US-CA",
          "AddressKey": "92688242709",
          "SuiteName": "",
          "SuiteCount": 0,
          "SuiteList": [
            ""
          ],
          "PlusFour": [
            "2427"
          ],
          "MAK": "1279312453",
          "BaseMAK": ""
        }
      },
      ...
      {
        "__type": "Result",
        "Address": {
          "__type": "Address",
          "AddressLine1": "9 Floramar",
          "City": "Rancho Santa Margarita",
          "CityAccepted": "Rancho Sta Marg,Rsm,Rcho Sta Marg",
          "CityNotAccepted": "",
          "State": "CA",
          "PostalCode": "92688-1307",
          "CountrySubdivisionCode": "US-CA",
          "AddressKey": "92688130709",
          "SuiteName": "",
          "SuiteCount": 0,
          "SuiteList": [
            ""
          ],
          "PlusFour": [
            "1307"
          ],
          "MAK": "6148025901",
          "BaseMAK": ""
        }
      }
    ]
  }
}
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

AddressKey

This is a country dependent field:

  • US: This returns a 11 digit code representing the combination of the zip code, the plus4, and the delivery point. This is a fairly good representation of a unique US address and often used as the core of postal barcode. However, this code is not guaranteed to be unique to an individual address, please use the MelissaAddressKey instead for that purpose. It is possible that this field is empty or not 11 digits if the address is a Non-USPS address (link to something about non-usps addresses).

  • GB: This field returns the UDPRN, which stands for Unique Delivery Point Reference Number. It is an 8 character code that is assigned and maintained by Royal Mail to each delivery point address.

  • AU: This returns the DPID (Delivery Point ID). This is a 8 digit number that identifies a mailbox according to Australia Post.

AddressLine1

The first line of the address line.

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.

City

The city of the address.

CityAccepted

A list of accepted city names.

CityNotAccepted

Any non-accepted city names will be included in this field.

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.

MAK

Melissa Address Key. A unique key assigned to the submitted address.

PlusFour

The ZIP+4 portion of a ZIP Code.

PostalCode

ZIP Code. Complete postal code for a particular delivery point.

State

The state of the address. The format is the 2 letter state code.

SuiteName

Returns the suite for the address in the AddressLine field, if any.

SuiteCount

The number of suites at the address.

SuiteList

A list of suites at the address.

/web/ExpressAddress#

Caution

This endpoint is deprecated. It is not recommended for new development unless advised by Melissa staff. Please see the GlobalExpressAddress endpoint for new development.

The ExpressAddress service is consumed to retrieve U.S. results containing all of the available address elements of an address record: AddressLine1, City, State, PostalCode, SuiteName, SuiteRange, and SuiteCount.

A typical use of the ExpressAddress method is preceded by a call to the ExpressPostalCode service. The ExpressPostalCode service is provided as a means of retrieving postal code, city, and state combinations using the postal code as the search input.

Try It Now#

  • GET JSON
  • GET XML
  • GET JSONP
curl -X GET "https://expressentry.melissadata.net/web/ExpressAddress?\
&cols=\
&format=json\
&id={{customerId}}\
&maxrecords=10\
&opt=\
&city=Rancho+Santa+Margarita\
&line1=\
&postalcode=92688\
&state=CA" \
-H "Content-Type: application/json" \
-H "Accept: application/json"

curl -X GET "https://expressentry.melissadata.net/web/ExpressAddress?\
&cols=\
&format=xml\
&id={{customerId}}\
&maxrecords=10\
&opt=\
&city=Rancho+Santa+Margarita\
&line1=\
&postalcode=92688\
&state=CA" \
-H "Content-Type: application/xml" \
-H "Accept: application/xml"

curl -X GET "https://expressentry.melissadata.net/jsonp/ExpressAddress?\
&cols=\
&format=jsonp\
&id={{customerId}}\
&maxrecords=10\
&opt=\
&city=Rancho+Santa+Margarita\
&line1=\
&postalcode=92688\
&state=CA" \
-H "Content-Type: application/javascript" \
-H "Accept: application/javascript"

Request Parameters#

Code

Description

Record Level Parameters

cols

Specifies which column(s) to be output as a comma delimited string. See Columns for more information.

format

Desired format of the response. Possible values are json, jsonp, or xml, depending on the endpoint.

id

The License Key issued by Melissa.

maxrecords

The maximum number of records to return. The default is 10 with a maximum of 100.

opt

Set Options

poboxes

Address Parameters

city

City, Locality, Municipality. The most common population center data element.

line1

The input field for the address, delimited by %20 or a space. This should contain the street address information (house number, thoroughfare, building, suite, etc.)

postalcode

Postal Code, ZIP. The complete postal code.

state

Administrative Area, Province, State. The most common geographic data element.
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

results

Return Address Object result codes for each address in the Extras field. For example, a USPS only address will return "AddrObjectResultCode": "AS01".

County

Return County Name field for CountyName in the Extras element.
Filtering#

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

true

U.S. Addresses will return P.O. Boxes and military addresses.

false

P.O. Boxes and military addresses will not be returned.

Headers#

  • GET JSON
  • GET XML
  • GET JSONP
Content-Type: application/json
Accept: application/json

Content-Type: application/xml
Accept: application/xml

Content-Type: application/javascript
Accept: application/javascript

Response#

  • GET JSON
  • GET XML
  • GET JSONP
{
  "Version": "8.0.0.1249",
  "ResultCode": "XS02",
  "ErrorString": "",
  "Results": [
    {
      "Address": {
        "AddressLine1": "PO Box 80781",
        "City": "Rancho Santa Margarita",
        "CityAccepted": "Rancho Sta Marg,Rsm,Rcho Sta Marg",
        "CityNotAccepted": "",
        "State": "CA",
        "PostalCode": "92688-0546",
        "CountrySubdivisionCode": "US-CA",
        "AddressKey": "92688054646",
        "SuiteName": "",
        "SuiteCount": 0,
        "SuiteList": [
          ""
        ],
        "PlusFour": [
          "0546"
        ],
        "MAK": "4462720540",
        "BaseMAK": "1748370077"
      }
    },
    ...
    {
      "Address": {
        "AddressLine1": "1 Via Onagro",
        "City": "Rancho Santa Margarita",
        "CityAccepted": "Rancho Sta Marg,Rsm,Rcho Sta Marg",
        "CityNotAccepted": "",
        "State": "CA",
        "PostalCode": "92688-4126",
        "CountrySubdivisionCode": "US-CA",
        "AddressKey": "92688412601",
        "SuiteName": "",
        "SuiteCount": 0,
        "SuiteList": [
          ""
        ],
        "PlusFour": [
          "4126"
        ],
        "MAK": "1467463708",
        "BaseMAK": ""
      }
    }
  ]
}

<Response
  xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Version>8.0.0.1249</Version>
  <ResultCode>XS02</ResultCode>
  <ErrorString></ErrorString>
  <Results>
    <Result>
      <Address>
        <AddressLine1>PO Box 80781</AddressLine1>
        <City>Rancho Santa Margarita</City>
        <CityAccepted>Rancho Sta Marg,Rsm,Rcho Sta Marg</CityAccepted>
        <CityNotAccepted></CityNotAccepted>
        <State>CA</State>
        <PostalCode>92688-0546</PostalCode>
        <CountrySubdivisionCode>US-CA</CountrySubdivisionCode>
        <AddressKey>92688054646</AddressKey>
        <SuiteName></SuiteName>
        <SuiteCount>0</SuiteCount>
        <SuiteList>
          <string></string>
        </SuiteList>
        <PlusFour>
          <string>0546</string>
        </PlusFour>
        <MAK>4462720540</MAK>
        <BaseMAK>1748370077</BaseMAK>
      </Address>
    </Result>
    ...
    <Result>
      <Address>
        <AddressLine1>1 Via Onagro</AddressLine1>
        <City>Rancho Santa Margarita</City>
        <CityAccepted>Rancho Sta Marg,Rsm,Rcho Sta Marg</CityAccepted>
        <CityNotAccepted></CityNotAccepted>
        <State>CA</State>
        <PostalCode>92688-4126</PostalCode>
        <CountrySubdivisionCode>US-CA</CountrySubdivisionCode>
        <AddressKey>92688412601</AddressKey>
        <SuiteName></SuiteName>
        <SuiteCount>0</SuiteCount>
        <SuiteList>
          <string></string>
        </SuiteList>
        <PlusFour>
          <string>4126</string>
        </PlusFour>
        <MAK>1467463708</MAK>
        <BaseMAK></BaseMAK>
      </Address>
    </Result>
  </Results>
</Response>

{
  "d": {
    "__type": "Response",
    "Version": "8.0.0.1249",
    "ResultCode": "XS02",
    "ErrorString": "",
    "Results": [
      {
        "__type": "Result",
        "Address": {
          "__type": "Address",
          "AddressLine1": "PO Box 80781",
          "City": "Rancho Santa Margarita",
          "CityAccepted": "Rancho Sta Marg,Rsm,Rcho Sta Marg",
          "CityNotAccepted": "",
          "State": "CA",
          "PostalCode": "92688-0546",
          "CountrySubdivisionCode": "US-CA",
          "AddressKey": "92688054646",
          "SuiteName": "",
          "SuiteCount": 0,
          "SuiteList": [
            ""
          ],
          "PlusFour": [
            "0546"
          ],
          "MAK": "4462720540",
          "BaseMAK": "1748370077"
        }
      },
      ...
      {
        "__type": "Result",
        "Address": {
          "__type": "Address",
          "AddressLine1": "1 Via Onagro",
          "City": "Rancho Santa Margarita",
          "CityAccepted": "Rancho Sta Marg,Rsm,Rcho Sta Marg",
          "CityNotAccepted": "",
          "State": "CA",
          "PostalCode": "92688-4126",
          "CountrySubdivisionCode": "US-CA",
          "AddressKey": "92688412601",
          "SuiteName": "",
          "SuiteCount": 0,
          "SuiteList": [
            ""
          ],
          "PlusFour": [
            "4126"
          ],
          "MAK": "1467463708",
          "BaseMAK": ""
        }
      }
    ]
  }
}
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

AddressKey

This is a country dependent field:

  • US: This returns a 11 digit code representing the combination of the zip code, the plus4, and the delivery point. This is a fairly good representation of a unique US address and often used as the core of postal barcode. However, this code is not guaranteed to be unique to an individual address, please use the MelissaAddressKey instead for that purpose. It is possible that this field is empty or not 11 digits if the address is a Non-USPS address (link to something about non-usps addresses).

  • GB: This field returns the UDPRN, which stands for Unique Delivery Point Reference Number. It is an 8 character code that is assigned and maintained by Royal Mail to each delivery point address.

  • AU: This returns the DPID (Delivery Point ID). This is a 8 digit number that identifies a mailbox according to Australia Post.

AddressLine1

The first line of the address line.

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.

City

The city of the address.

CityAccepted

The accepted city value.

CityNotAccepted

The non-accepted city value.

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.

MAK

Melissa Address Key. A unique key assigned to the submitted address.

PlusFour

The ZIP+4 portion of a ZIP Code.

PostalCode

Complete postal code for a particular delivery point.

State

The state of the address. The format is the 2 letter state code.

SuiteCount

The number of suites at the address.

SuiteList

A list of suites at the address.

SuiteName

Returns the suite for the address in the AddressLine field, if any.

/web/ExpressCityState#

Caution

This endpoint is deprecated. It is not recommended for new development unless advised by Melissa staff. Please see the GlobalExpressLocalityAdministrativeArea endpoint for new development.

ExpressCityState is provided as a means of retrieving U.S. city, state, and postal code combinations using the city name. This can be useful when a list of postal code information for a city is desired.

Try It Now#

  • GET JSON
  • GET XML
  • GET JSONP
curl -X GET "https://expressentry.melissadata.net/web/ExpressCityState?\
&format=json\
&id={{customerId}}\
&maxrecords=10\
&city=Rancho+Santa+Margarita\
&postalcode=92688\
&state=CA" \
-H "Content-Type: application/json" \
-H "Accept: application/json"

curl -X GET "https://expressentry.melissadata.net/web/ExpressCityState?\
&format=xml\
&id={{customerId}}\
&maxrecords=10\
&city=Rancho+Santa+Margarita\
&postalcode=92688\
&state=CA" \
-H "Content-Type: application/xml" \
-H "Accept: */*"

curl -X GET "https://expressentry.melissadata.net/jsonp/ExpressCityState?\
&format=json\
&id={{customerId}}\
&maxrecords=10\
&city=Rancho+Santa+Margarita\
&postalcode=92688\
&state=CA" \
-H "Content-Type: application/javascript" \
-H "Accept: application/javascript"

Request Parameters#

Code

Description

Record Level Parameters

format

Desired format of the response. Possible values are json, jsonp, or xml, depending on the endpoint.

id

The License Key issued by Melissa.

maxrecords

The maximum number of records to return. The default is 10 with a maximum of 100.

Address Parameters

city

City, Locality, Municipality. The most common population center data element.

postalcode

Postal Code, ZIP. The complete postal code.

state

Administrative Area, Province, State. The most common geographic data element.

Headers#

  • GET JSON
  • GET XML
  • GET JSONP
Content-Type: application/json
Accept: application/json

Content-Type: application/xml
Accept: application/xml

Content-Type: application/javascript
Accept: application/javascript

Response#

  • GET JSON
  • GET XML
  • GET JSONP
{
  "Version": "8.0.0.1249",
  "ResultCode": "XS01",
  "ErrorString": "",
  "Results": [
    {
      "Address": {
        "AddressLine1": "",
        "City": "Rancho Santa Margarita",
        "CityAccepted": "Rancho Sta Marg,Rsm,Rcho Sta Marg",
        "CityNotAccepted": "",
        "State": "CA",
        "PostalCode": "92688",
        "CountrySubdivisionCode": "US-CA",
        "AddressKey": "",
        "SuiteName": "",
        "SuiteCount": 0,
        "SuiteList": [
          ""
        ],
        "PlusFour": [
          ""
        ],
        "MAK": "",
        "BaseMAK": ""
      }
    }
  ]
}

<Response
  xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Version>8.0.0.1249</Version>
  <ResultCode>XS01</ResultCode>
  <ErrorString></ErrorString>
  <Results>
    <Result>
      <Address>
        <AddressLine1></AddressLine1>
        <City>Rancho Santa Margarita</City>
        <CityAccepted>Rancho Sta Marg,Rsm,Rcho Sta Marg</CityAccepted>
        <CityNotAccepted></CityNotAccepted>
        <State>CA</State>
        <PostalCode>92688</PostalCode>
        <CountrySubdivisionCode>US-CA</CountrySubdivisionCode>
        <AddressKey></AddressKey>
        <SuiteName></SuiteName>
        <SuiteCount>0</SuiteCount>
        <SuiteList>
          <string></string>
        </SuiteList>
        <PlusFour>
          <string></string>
        </PlusFour>
        <MAK></MAK>
        <BaseMAK></BaseMAK>
      </Address>
    </Result>
  </Results>
</Response>

{
  "d": {
    "__type": "Response",
    "Version": "8.0.0.1249",
    "ResultCode": "XS01",
    "ErrorString": "",
    "Results": [
      {
        "__type": "Result",
        "Address": {
          "__type": "Address",
          "AddressLine1": "",
          "City": "Rancho Santa Margarita",
          "CityAccepted": "Rancho Sta Marg,Rsm,Rcho Sta Marg",
          "CityNotAccepted": "",
          "State": "CA",
          "PostalCode": "92688",
          "CountrySubdivisionCode": "US-CA",
          "AddressKey": "",
          "SuiteName": "",
          "SuiteCount": 0,
          "SuiteList": [
            ""
          ],
          "PlusFour": [
            ""
          ],
          "MAK": "",
          "BaseMAK": ""
        }
      }
    ]
  }
}
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

AddressKey

This is a country dependent field:

AddressLine1

The first line of the address line.

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.

City

The city of the address.

CityAccepted

A list of accepted city names.

CityNotAccepted

Any non-accepted city names will be included in this field.

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.

MAK

Melissa Address Key. A unique key assigned to the submitted address.

PlusFour

The ZIP+4 portion of a ZIP Code.

PostalCode

ZIP Code. Complete postal code for a particular delivery point.

State

The state of the address. The format is the 2 letter state code.

SuiteCount

The number of suites at the address.

SuiteList

A list of suites at the address.

SuiteName

Returns the suite for the address in the AddressLine field, if any.

/web/ExpressPostalCode#

Caution

This endpoint is deprecated. It is not recommended for new development unless advised by Melissa staff. Please see the GlobalExpressPostalCode endpoint for new development.

ExpressPostalCode is provided as a convenient method for quickly retrieving U.S. city and state information using the ZIP code as the input. A subsequent call to ExpressAddress benefits greatly by using the city and state information from ExpressPostalCode.

Try It Now#

  • GET JSON
  • GET XML
  • GET JSONP
curl -X GET "https://expressentry.melissadata.net/web/ExpressPostalCode?\
&format=json\
&id={{customerId}}\
&maxrecords=10\
&postalcode=92688" \
-H "Content-Type: application/json" \
-H "Accept: application/json"

curl -X GET "https://expressentry.melissadata.net/web/ExpressPostalCode?\
&format=xml\
&id={{customerId}}\
&maxrecords=10\
&postalcode=92688" \
-H "Content-Type: application/xml" \
-H "Accept: */*"

curl -X GET "https://expressentry.melissadata.net/jsonp/ExpressPostalCode?\
&format=json\
&id={{customerId}}\
&maxrecords=10\
&postalcode=92688" \
-H "Content-Type: application/javascript" \
-H "Accept: application/javascript"

Request Parameters#

Code

Description

Record Level Parameters

format

Desired format of the response. Possible values are json, jsonp, or xml, depending on the endpoint.

id

The License Key issued by Melissa.

maxrecords

The maximum number of records to return. The default is 10 with a maximum of 100.

Address Parameters

postalcode

Postal Code, ZIP. The complete postal code.

Headers#

  • GET JSON
  • GET XML
  • GET JSONP
Content-Type: application/json
Accept: application/json

Content-Type: application/xml
Accept: application/xml

Content-Type: application/javascript
Accept: application/javascript

Response#

  • GET JSON
  • GET XML
  • GET JSONP
{
  "Version": "8.0.0.1249",
  "ResultCode": "XS01",
  "ErrorString": "",
  "Results": [
    {
      "Address": {
        "AddressLine1": "",
        "City": "Rancho Santa Margarita",
        "CityAccepted": "Rancho Sta Marg,Rsm,Rcho Sta Marg",
        "CityNotAccepted": "",
        "State": "CA",
        "PostalCode": "92688",
        "CountrySubdivisionCode": "US-CA",
        "AddressKey": "",
        "SuiteName": "",
        "SuiteCount": 0,
        "SuiteList": [
          ""
        ],
        "PlusFour": [
          ""
        ],
        "MAK": "",
        "BaseMAK": ""
      }
    }
  ]
}

<Response
  xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Version>8.0.0.1249</Version>
  <ResultCode>XS01</ResultCode>
  <ErrorString></ErrorString>
  <Results>
    <Result>
      <Address>
        <AddressLine1></AddressLine1>
        <City>Rancho Santa Margarita</City>
        <CityAccepted>Rancho Sta Marg,Rsm,Rcho Sta Marg</CityAccepted>
        <CityNotAccepted></CityNotAccepted>
        <State>CA</State>
        <PostalCode>92688</PostalCode>
        <CountrySubdivisionCode>US-CA</CountrySubdivisionCode>
        <AddressKey></AddressKey>
        <SuiteName></SuiteName>
        <SuiteCount>0</SuiteCount>
        <SuiteList>
          <string></string>
        </SuiteList>
        <PlusFour>
          <string></string>
        </PlusFour>
        <MAK></MAK>
        <BaseMAK></BaseMAK>
      </Address>
    </Result>
  </Results>
</Response>

{
  "d": {
    "__type": "Response",
    "Version": "8.0.0.1249",
    "ResultCode": "XS01",
    "ErrorString": "",
    "Results": [
      {
        "__type": "Result",
        "Address": {
          "__type": "Address",
          "AddressLine1": "",
          "City": "Rancho Santa Margarita",
          "CityAccepted": "Rancho Sta Marg,Rsm,Rcho Sta Marg",
          "CityNotAccepted": "",
          "State": "CA",
          "PostalCode": "92688",
          "CountrySubdivisionCode": "US-CA",
          "AddressKey": "",
          "SuiteName": "",
          "SuiteCount": 0,
          "SuiteList": [
            ""
          ],
          "PlusFour": [
            ""
          ],
          "MAK": "",
          "BaseMAK": ""
        }
      }
    ]
  }
}
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

AddressKey

This is a country dependent field:

AddressLine1

The first line of the address line.

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.

City

The city of the address.

CityAccepted

A list of accepted city names.

CityNotAccepted

Any non-accepted city names will be included in this field.

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.

MAK

Melissa Address Key. A unique key assigned to the submitted address.

PlusFour

The ZIP+4 portion of a ZIP Code.

PostalCode

ZIP Code. Complete postal code for a particular delivery point.

State

The state of the address. The format is the 2 letter state code.

SuiteCount

The number of suites at the address.

SuiteList

A list of suites at the address.

SuiteName

Returns the suite for the address in the AddressLine field, if any.

/web/ExpressStreet#

Caution

This endpoint is deprecated. It is not recommended for new development unless advised by Melissa staff. Please see the GlobalExpressThoroughfare endpoint for new development.

ExpressStreet is a means for retrieving the streets (U.S.) within a ZIP Code using the ZIP Code and beginning of the street name (line 1) as the Input.

Try It Now#

  • GET JSON
  • GET XML
  • GET JSONP
curl -X GET "https://expressentry.melissadata.net/web/ExpressStreet?\
&format=json\
&id={{customerId}}\
&maxrecords=10\
&line1=22382+Avenida+Empresa\
&postalcode=92688" \
-H "Content-Type: application/json" \
-H "Accept: application/json"

curl -X GET "https://expressentry.melissadata.net/web/ExpressStreet?\
&format=xml\
&id={{customerId}}\
&maxrecords=10\
&line1=22382+Avenida+Empresa\
&postalcode=92688" \
-H "Content-Type: application/xml" \
-H "Accept: */*"

curl -X GET "https://expressentry.melissadata.net/jsonp/ExpressStreet?\
&format=json\
&id={{customerId}}\
&maxrecords=10\
&line1=22382+Avenida+Empresa\
&postalcode=92688" \
-H "Content-Type: application/javascript" \
-H "Accept: application/javascript"

Request Parameters#

Code

Description

Record Level Parameters

format

Desired format of the response. Possible values are json, jsonp, or xml, depending on the endpoint.

id

The License Key issued by Melissa.

maxrecords

The maximum number of records to return. The default is 10 with a maximum of 100.

Address Parameters

line1

The input field for the address, delimited by %20 or a space. This should contain the street address information (house number, thoroughfare, building, suite, etc.)

postalcode

Postal Code, ZIP. The complete postal code.

Headers#

  • GET JSON
  • GET XML
  • GET JSONP
Content-Type: application/json
Accept: application/json

Content-Type: application/xml
Accept: application/xml

Content-Type: application/javascript
Accept: application/javascript

Response#

  • GET JSON
  • GET XML
  • GET JSONP
{
  "Version": "8.0.0.1249",
  "ResultCode": "XS01",
  "ErrorString": "",
  "Results": [
    {
      "Address": {
        "AddressLine1": "Avenida Empresa",
        "City": "Rancho Santa Margarita",
        "CityAccepted": "Rancho Sta Marg,Rsm,Rcho Sta Marg",
        "CityNotAccepted": "",
        "State": "CA",
        "PostalCode": "92688",
        "CountrySubdivisionCode": "US-CA",
        "AddressKey": "",
        "SuiteName": "",
        "SuiteCount": 0,
        "SuiteList": [
          ""
        ],
        "PlusFour": [
          ""
        ],
        "MAK": "",
        "BaseMAK": ""
      }
    }
  ]
}

<Response
  xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Version>8.0.0.1249</Version>
  <ResultCode>XS01</ResultCode>
  <ErrorString></ErrorString>
  <Results>
    <Result>
      <Address>
        <AddressLine1>Avenida Empresa</AddressLine1>
        <City>Rancho Santa Margarita</City>
        <CityAccepted>Rancho Sta Marg,Rsm,Rcho Sta Marg</CityAccepted>
        <CityNotAccepted></CityNotAccepted>
        <State>CA</State>
        <PostalCode>92688</PostalCode>
        <CountrySubdivisionCode>US-CA</CountrySubdivisionCode>
        <AddressKey></AddressKey>
        <SuiteName></SuiteName>
        <SuiteCount>0</SuiteCount>
        <SuiteList>
          <string></string>
        </SuiteList>
        <PlusFour>
          <string></string>
        </PlusFour>
        <MAK></MAK>
        <BaseMAK></BaseMAK>
      </Address>
    </Result>
  </Results>
</Response>

{
  "d": {
    "__type": "Response",
    "Version": "8.0.0.1249",
    "ResultCode": "XS01",
    "ErrorString": "",
    "Results": [
      {
        "__type": "Result",
        "Address": {
          "__type": "Address",
          "AddressLine1": "Avenida Empresa",
          "City": "Rancho Santa Margarita",
          "CityAccepted": "Rancho Sta Marg,Rsm,Rcho Sta Marg",
          "CityNotAccepted": "",
          "State": "CA",
          "PostalCode": "92688",
          "CountrySubdivisionCode": "US-CA",
          "AddressKey": "",
          "SuiteName": "",
          "SuiteCount": 0,
          "SuiteList": [
            ""
          ],
          "PlusFour": [
            ""
          ],
          "MAK": "",
          "BaseMAK": ""
        }
      }
    ]
  }
}
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

AddressKey

This is a country dependent field:

AddressLine1

The first line of the address line.

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.

City

The city of the address.

CityAccepted

A list of accepted city names.

CityNotAccepted

Any non-accepted city names will be included in this field.

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.

MAK

Melissa Address Key. A unique key assigned to the submitted address.

PlusFour

The ZIP+4 portion of a ZIP Code.

PostalCode

ZIP Code. Complete postal code for a particular delivery point.

State

The state of the address. The format is the 2 letter state code.

SuiteCount

The number of suites at the address.

SuiteList

A list of suites at the address.

SuiteName

Returns the suite for the address in the AddressLine field, if any.
Contents