API Documentation

We try to make it very simple and fast to submit a direct request to our API and retrieve your LeadMatchID from your system.

You will find below the specification to send a request. Your request can be sent using GET or POST.

API Request URL: http://www.leadmatchid.com/request/


Field Type Required Description
access_key string Yes Your Access Key
company string Yes Your Customer Name
website string No Your Customer Website
zip string Yes Your Customer Zip Code
address string No Your Customer Address
city string No Your Customer City
state string Yes Your Customer State
phone1 string No Your Customer Phone Number
phone2 string No Your Customer Alternative Phone Number
phone3 string No Your Customer Alternative Phone Number
email1 string No Your Customer Email
email2 string No Your Customer Alternative Email
email3 string No Your Customer Alternative Email

Request Example

Here is an example of request using GET:

http://www.leadmatchid.com/request/?access_key=YOUR_API_KEY&company=Test+LLC&website=test.com&zip=28202&address=123+Main+St&city=Charlotte&state=NC&phone1=7043332222&phone2=&phone3=&email1=test@test.com&email2=&email3=

API Response

The API response will be in a JSON format. Here are some examples:

{"status":"success","leadmatchid":"eccbc87e2e6ce2fe28308fd9f2a7baf3","message":""}
{"status":"fail","leadmathid":"","message":"Invalid access KEY"}


Here are the meaning of the returned parameters:

status
This parameter indicate if the request was successful received

leadmatchid
This is the LeadMatchID for the customer. Save that ID in your database in the customer's account. Use that ID to safely exchange leads with affiliates and prevent duplicates. Note that your affiliate also needs to have the LeadMatchID on their end to match the record.

message
If there is an issue with your request, this field will contain the issue details.