Schedule a Demo
Get Started

Base path URL

POST

Below is an example of Request Headers, Request Body, and Response Body, including all mandatory fields/keys needed to make an API call. Find your X-LIC-KEY here: My API Keys page.

Request Headers

*Required keys: X-LIC-KEY and Filterkey

{
  X-LIC-KEY: 123-ABC-456,
  Filterkey: 987-XYZ-654
}

Request Body

*Required fields for every call: firstname, lastname and phone

{
  "Firstname": "John",
  "Lastname": "Doe",
  "Phone": "2179999999",
  "Email": "test@example.com",
  "Address": {
    "Street": "123 Main Street",
    "City": "San Diego",
    "State": "CA",
    "Zipcode": "92130",
  }
}

Response Body

200/OK

{
  "Master Response": "Fail",
  "Phone": {
      "Phone Matches Name %": "45",
      "Phone Seen Recent Activity": "Yes",
      "Phone is Mobile": "No"
  },
  "Email": {
      "Email Matches Name %": "10",
      "Email is Valid": "Yes"
  },
  "Address": {
      "Address Matches Name %": "0",
      "Address is Valid": "Yes"
  }
}

Code Snippets

Curl
Javascript
Python
Go
Ruby
PHP
curl --location 'https://leadidentitycheck-node.vercel.app/main/lic/v1' \
--header 'X-LIC-KEY: 123-ABC-456' \
--header 'Filterkey: 987-XYZ-654' \
--header 'Content-Type: application/json' \
--data-raw '{
    "Firstname": "John",
    "Lastname": "Doe",
    "Phone": "2179999999",
    "Email": "test@example.com",
    "Address": {
      "Street": "123 Main Street",
      "City": "San Diego",
      "State": "CA",
      "Zipcode": "92130",
    }
}'

const axios = require('axios');
let data = JSON.stringify({
  "Firstname": "John",
  "Lastname": "Doe",
  "Phone": "2179999999",
  "Email": "test@example.com",
  "Address": {
    "Street": "123 Main Street",
    "City": "San Diego",
    "State": "CA",
    "Zipcode": "92130",
  }
});

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'https://leadidentitycheck-node.vercel.app/main/lic/v1',
  headers: { 
    'X-LIC-KEY': "123-ABC-456",
    'Filterkey': "987-XYZ-654",
    'Content-Type': 'application/json'
  },
  data : data
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

import requests
import json

url = "https://leadidentitycheck-node.vercel.app/main/lic/v1"

payload = json.dumps({
  "Firstname": "John",
  "Lastname": "Doe",
  "Phone": "2179999999",
  "Email": "test@example.com",
  "Address": {
    "Street": "123 Main Street",
    "City": "San Diego",
    "State": "CA",
    "Zipcode": "92130",
  }
})
headers = {
  'X-LIC-KEY': '123-ABC-456',
  'Filterkey': '987-XYZ-654',
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

package main
import (
  "fmt"
  "strings"
  "net/http"
  "io"
)

func main() {

  url := "https://leadidentitycheck-node.vercel.app/main/lic/v1"
  method := "POST"

  payload := strings.NewReader(`{
        "Firstname": "John",
        "Lastname" : "Doe",
        "Phone"    : "2179999999",
        "Email"    : "test@example.com",
        "Address"  : {
          "Street"   : "123 Main Street",
          "City"     : "San Diego",
          "State"    : "CA",
          "Zipcode"  : "92130"
        }
     }`)

  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("X-LIC-KEY", "123-ABC-456")
  req.Header.Add("Filterkey", "987-XYZ-654")
  req.Header.Add("Content-Type", "application/json")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := io.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

require "uri"
require "json"
require "net/http"

url = URI("https://leadidentitycheck-node.vercel.app/main/lic/v1")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["X-LIC-KEY"] = "123-ABC-456"
request["Filterkey"] = "987-XYZ-654"
request["Content-Type"] = "application/json"
request.body = JSON.dump({
  "Firstname": "John",
  "Lastname": "Doe",
  "Phone": "2179999999",
  "Email": "test@example.com",
  "Address": {
    "Street": "123 Main Street",
    "City": "San Diego",
    "State": "CA",
    "Zipcode": "92130",
  }
})

response = http.request(request)
puts response.read_body

 
$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://leadidentitycheck-node.vercel.app/main/lic/v1',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'
      {
        "Firstname": "John",
        "Lastname" : "Doe",
        "Phone"    : "2179999999",
        "Email"    : "test@example.com",
        "Address": {
          "Street": "123 Main Street",
          "City": "San Diego",
          "State": "CA",
          "Zipcode": "92130",
        }
     }
',
  CURLOPT_HTTPHEADER => array(
    'X-LIC-KEY: 123-ABC-456',
    'Filterkey: 987-XYZ-654',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Authentication

POST

Request Headers

*Required keys: X-LIC-KEY

{
  X-LIC-KEY: 123-ABC-456
}

Response Body

200/OK

{
  "email": "support@leadidentitycheck.com
}

Trigger - Fetch filters

POST

Request Headers

*Required keys: X-LIC-KEY

{
  X-LIC-KEY: 123-ABC-456
}

Response Body

200/OK

{
  "id": "123456MNO",
  "filterkey": "111222333444555",
  "name": "Zaper-Phone-Acitve/75/Mobile"
},
{
  "id": "0987654EFG",
  "filterkey": "000999888777666",
  "name": "Newsletter-Email-Active/68"
}

Action - Verify a Lead - Fetch Filter Config

POST

Request Headers

*Required keys: X-LIC-KEY and Filterkey

{
  X-LIC-KEY: 123-ABC-456,
  Filterkey: 987-XYZ-654
}

Response Body

200/OK

{
  "id": "1",
  "key": "Firstname",
  "label": "First Name",
  "type": "string",
  "required": true
},
{
  "id": "2",
  "key": "Lastname",
  "label": "Last Name",
  "type": "string",
  "required": true
},
{
  "id": "3",
  "key": "Phone",
  "label": "Phone Number",
  "type": "string",
  "required": true
}

Action - Verify a Lead - Run Lead Check

POST

Request Headers

*Required keys: X-LIC-KEY and Filterkey

{
  X-LIC-KEY: 123-ABC-456,
  Filterkey: 987-XYZ-654
}

Request Body

*Required fields for every call: firstname, lastname and phone

{
  "Firstname": "John",
  "Lastname": "Doe",
  "Phone": "2179999999",
  "Email": "test@example.com",
  "Address": {
    "Street": "123 Main Street",
    "City": "San Diego",
    "State": "CA",
    "Zipcode": "92130",
  }
}

Response Body

200/OK

{
  "Master Response": "Fail",
  "Phone": {
    "Phone Matches Name %": "45",
    "Phone Seen Recent Activity": "Yes",
    "Phone is Mobile": "No"
  },
  "Email": {
    "Email Matches Name %": "10",
    "Email is Valid": "Yes"
  },
  "Address": {
    "Address Matches Name %": "0",
    "Address is Valid": "Yes"
  }
}

Introduction to Filters

Filters are an essential feature of our lead identity verification tool, enabling you to refine and manage leads with precision. They act as customizable funnels, helping you score, categorize, and mark leads as good or bad based on specific conditions you define. By setting up filters, you can ensure that only the most relevant and high-quality leads are highlighted, saving you time and resources.

Understanding Filter Conditions

A filter condition is a criterion that a lead must meet to pass through the filter. These conditions can be based on various parameters such as phone activity, email validation, address verification, and IP address consistency. Here's how you can configure and use these conditions:

  1. Phone Activity: Determine if a phone number has recent activity.
    • Example Condition: Phone Seen Activity = Yes
    • This condition checks whether the phone number associated with a lead has shown any recent activity, ensuring it is active and potentially valid.
  2. Phone Matches Name Percentage: Check the match percentage of the phone number with the lead's name.
    • Example Condition: Phone Matches Name% ≥ 68
    • This condition validates the likelihood that the phone number belongs to the person named in the lead. A higher percentage indicates a stronger match.
  3. Email Validation: Ensure the provided email address is valid and active.
    • Example Condition: Email Valid = Yes
    • This condition checks the authenticity and activity status of the email address.
  4. Address Verification: Confirm the provided address is valid and matches the lead's details.
    • Example Condition: Address Valid = Yes
    • This condition ensures that the physical address is real and correctly linked to the lead.
  5. IP Address Consistency: Verify the consistency and location of the IP address.
    • Example Condition: IP Address Matches Region = Yes
    • This condition checks if the IP address is consistent with the region claimed by the lead.

Setting Up and Using Filters

  1. Accessing Filters:
    • Navigate to the Filters section in your dashboard.
    • Click on "Add New Filter" to create a custom filter based on your criteria.
  2. Creating a Filter:
    • Name: Give your filter a descriptive name for easy identification.
    • Conditions: Add the desired conditions by selecting parameters and defining their values. You can combine multiple conditions using logical operators (AND/OR).
  3. Applying Filters:
    • Once a filter is created, apply it to your lead data.
    • The system will automatically evaluate each lead against the filter conditions.
    • Leads that meet the conditions will be scored and marked as "Good" or "Bad" based on the predefined criteria.
  4. Managing Filters:
    • You can edit, deactivate, or delete filters at any time.
    • Regularly review and update your filters to adapt to changing lead validation needs.

Example Use Case

Imagine you want to identify leads that are likely to be genuine and actively interested based on their phone activity and name match percentage. You can set up a filter with the following conditions:

  • Phone Seen Activity: Yes
  • Phone Matches Name%: ≥ 68

This filter will help you focus on leads with active phone numbers and a high likelihood of the phone number matching the lead's name.

Conclusion

Filters are a powerful tool in our lead identity verification system, allowing you to fine-tune your lead management process. By setting precise conditions, you can ensure that only the most relevant leads are prioritized, enhancing the quality and accuracy of your lead scoring. Remember, all sorts of leads can pass through the filter, but the filter will decide if a lead is good or bad based on the conditions you set.

For any further assistance or advanced configurations, contact our support team at support@leadidentitycheck.com

Schedule a Demo
Get Started