Skip to end of banner
Go to start of banner

POST melissa_data/verify

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Available from CRM.COM R10.0.0


This method verifies an address registered in CRM.COM against the information of Melissa Data System. Only one address can be verified in each call.


Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

account_id

(mandatory)

String

The Melissa Data Account ID as specified in the Address Registry Settings

street_number

(optional)

String

Input street number information to be verified

 

street_name

(optional)

String

Input street name information to be verified

municipality

(optional)

StringInput municipality information to be verified

city

(optional)

String


Input city information to be verified

postal_code

(optional)

StringInput postal code information to be verified

country

(optional)

StringRestricts 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

Restrictions

  • It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

Name

Type

Description

resultStringDefines the address verification result. In case of failed verification, the description of all of the invalid address information will be included in the results 
formatted_addressStringThe Full address
cityStringAddress city
municipalityStringAddress municipality
postal_codeStringAddress post code
countryStringAddress Country
street_nameStringAddress street name
street_numberStringAddress street number
apartmentStringAddress apartment number
po_pox_postal_codeStringAddress PO Box post code


Examples

 Example 1

HTTP Method: GET

 

Request:

Body:

 {
 "token":"{{token}}",
  "account_id":"114452481",
   "street_name":"Odos Pindarou",
   "street_number":"10",
   "municipality":"Lefkosia",
   "city":"Latsia",
   "postal_code":"2020",
   "country":"CY"
}

Response:

 {
  "status": {
    "message": "",
    "description": "",
    "code": "OK"
  },
  "data": {
    "formatted_address": "10 Odos Pindarou;Agios Georgios;2020 Latsia",
    "postal_code": "2020",
    "apartment": null,
    "street_number": null,
    "country": "Cyprus",
    "street_name": "Odos Pindarou",
    "city": "Latsia",
    "po_pox_postal_code": "",
    "municipality": "Lefkosia",
    "result": "AC09,AV24"
  }
}
  • No labels