GET melissa_data/quick_lookup

Available from CRM.COM R10.0.0

This method returns address information from the Melissa Data Address Registry System with which CRM.COM integrates with. Multiple addresses might be returned by each call.

Resource URL

Parameters

Name	Type	Description
token	String	The token retrieved from the login method
address (mandatory)	String	Detailed information about the address that will be retrieved through the Address Registry System in free text.
country (optional)	String	Restricts the retrieved addresses to the addresses of the specified Country. Always defaults to the Country specified in Admin Settings. If specified, then the Country's 2-characters code must be defined
max_records (optional)	Integer	Defines the maximum number of addresses to be returned. Always defaults to 10.

Restrictions

It is mandatory to specify at least one of the semi-optional parameters. Multiple of those parameters are allowed to be specified.

Response Data

Name	Type	Description
result_code	String	Code indicating whether a successful request was sent or not. For successful requests, the code denote the number of addresses included in the response and the available values are ALL, NONE and SOME. For un-successfull requests the results_description provides information of the erroneous request.
result_description	String	Description of the error returned by Melissa Data Global Express Entry. Available only when the request was not successfully sent
addresses	List of Melissa Data Address Objects	A list of addresses returned by the address search in Melissa Data Express Entry/Melissa Data Express Entry Form

Referred Objects Response Data

melissa_data object response data

Name	Type	Description
address	String	Full formatted address
street_name	String	Address Street Name
street_number	String	Address Street Number
postal_code	String	Address Postal Code
apartment_number	String	Address Apartment Number
area	String	Address Area
city	String	Address City/Town
district	String	Address District
municipality	String	Address Municipality
po_box	String	Address PO Box
country	String	Address Country

Examples

Example 1

HTTP Method: GET

Request:

Response:

 {
  "status": {
    "message": "",
    "description": "",
    "code": "OK"
  },
  "data": {
    "addresses": [
      {
        "postal_code": "",
        "address": "1 Odos Ilia Papakyriakou, Paralimni",
        "street_number": "1",
        "apartment_number": null,
        "country": "Cyprus",
        "street_name": "Odos Ilia Papakyriakou",
        "city": "Paralimni",
        "po_box": "",
        "municipality": "Ammochostos",
        "area": "",
        "district": ""
      },
      {
        "postal_code": "",
        "address": "2 Odos Ilia Papakyriakou, Paralimni",
        "street_number": "2",
        "apartment_number": null,
        "country": "Cyprus",
        "street_name": "Odos Ilia Papakyriakou",
        "city": "Paralimni",
        "po_box": "",
        "municipality": "Ammochostos",
        "area": "",
        "district": ""
      },
      {
        "postal_code": "",
        "address": "3 Odos Ilia Papakyriakou, Paralimni",
        "street_number": "3",
        "apartment_number": null,
        "country": "Cyprus",
        "street_name": "Odos Ilia Papakyriakou",
        "city": "Paralimni",
        "po_box": "",
        "municipality": "Ammochostos",
        "area": "",
        "district": ""
      },
      {
        "postal_code": "",
        "address": "4 Odos Ilia Papakyriakou, Paralimni",
        "street_number": "4",
        "apartment_number": null,
        "country": "Cyprus",
        "street_name": "Odos Ilia Papakyriakou",
        "city": "Paralimni",
        "po_box": "",
        "municipality": "Ammochostos",
        "area": "",
        "district": ""
      },
      {
        "postal_code": "",
        "address": "5 Odos Ilia Papakyriakou, Paralimni",
        "street_number": "5",
        "apartment_number": null,
        "country": "Cyprus",
        "street_name": "Odos Ilia Papakyriakou",
        "city": "Paralimni",
        "po_box": "",
        "municipality": "Ammochostos",
        "area": "",
        "district": ""
      },
      {
        "postal_code": "",
        "address": "6 Odos Ilia Papakyriakou, Paralimni",
        "street_number": "6",
        "apartment_number": null,
        "country": "Cyprus",
        "street_name": "Odos Ilia Papakyriakou",
        "city": "Paralimni",
        "po_box": "",
        "municipality": "Ammochostos",
        "area": "",
        "district": ""
      },
      {
        "postal_code": "",
        "address": "7 Odos Ilia Papakyriakou, Paralimni",
        "street_number": "7",
        "apartment_number": null,
        "country": "Cyprus",
        "street_name": "Odos Ilia Papakyriakou",
        "city": "Paralimni",
        "po_box": "",
        "municipality": "Ammochostos",
        "area": "",
        "district": ""
      },
      {
        "postal_code": "",
        "address": "8 Odos Ilia Papakyriakou, Paralimni",
        "street_number": "8",
        "apartment_number": null,
        "country": "Cyprus",
        "street_name": "Odos Ilia Papakyriakou",
        "city": "Paralimni",
        "po_box": "",
        "municipality": "Ammochostos",
        "area": "",
        "district": ""
      },
      {
        "postal_code": "",
        "address": "9 Odos Ilia Papakyriakou, Paralimni",
        "street_number": "9",
        "apartment_number": null,
        "country": "Cyprus",
        "street_name": "Odos Ilia Papakyriakou",
        "city": "Paralimni",
        "po_box": "",
        "municipality": "Ammochostos",
        "area": "",
        "district": ""
      },
      {
        "postal_code": "",
        "address": "10 Odos Ilia Papakyriakou, Paralimni",
        "street_number": "10",
        "apartment_number": null,
        "country": "Cyprus",
        "street_name": "Odos Ilia Papakyriakou",
        "city": "Paralimni",
        "po_box": "",
        "municipality": "Ammochostos",
        "area": "",
        "district": ""
      }
    ],
    "result_description": "null",
    "result_code": "ALL"
  }
}