Lead Matching API Operation

Ayesha Akhtar
Ayesha Akhtar
  • Updated

Feature Snapshot

Summary:
TrustedForm Lead Matching is an API operation that compares A lead’s email address and/OR phone numbers with the data captured by TrustedForm certificate to confirm that the certificate truly belongs to the intended lead.

Key Benefits:

  • Ensures the authenticity of lead data by verifying that the certificate matches the lead’s contact details
  • Mitigates the risk of lead fraud and reduces legal exposure by confirming consent
  • Enhances regulatory compliance through reliable, automated matching of submitted data with certificate records

Typical Use Cases:

  • Verifying authenticity of purchased leads by cross-checking vendor-supplied contact information
  • Integrating lead validation into CRM or lead management systems to automatically flag mismatches

How the TrustedForm Lead Matching API Operation works

TrustedForm’s Lead Matching operation works when you make an API request that includes the lead’s email address and/or phone number as parameters inside a dedicated “match_lead” object. TrustedForm then normalizes these values (e.g., converting emails to lowercase and stripping non-digit characters from phone numbers), computes SHA1 hashes, and compares them to the certificate data. The response indicates whether the input values matched the certificate indicating if the lead data and the certificate are accurately together.

Step‑by‑Step Instructions

  1. Collect Required Data:
     Gather the certificate URL along with the lead’s contact information (ensure emails are in lowercase and phone numbers contain only digits).

  2. Send Your API Request:
     Format your JSON payload to include a “match_lead” object with fields for email and/or phone as shown in our API Documentation. For example:

 {
  "retain": { … },
  "match_lead": {
   "email": "user@example.com",
   "phone": "5551234567"
  }
 }
  1. Examine the API Response:
     Review the returned JSON to check if the email/phone match.

Expected Result:
A successful API call returns a JSON response with a successful result.


Validation & Monitoring (optional)

  • Test the Setup: Send a test API request with a certificate and known, properly formatted lead data. Confirm the response’s match status is “Matched.”
  • Where to Monitor?: Monitor your API response logs and review the TrustedForm Dashboard under the Retained Certificates section to verify lead matching outcomes.

Best Practices

  • Log both successful and failed matching attempts to create an audit trail for troubleshooting and compliance purposes.
  • Integrate automatic alerts or dashboard monitoring to quickly identify high rates of “Not Matched” outcomes, signaling potential data entry errors or issues with vendor submissions.

Troubleshooting

Symptom / Error Likely Cause Resolution
“None of the provided fingerprints match” Submitted email/phone does not correspond to certificate data. View the certificate’s session replay and reach out to your vendor if the email/phone shown does not match the lead data or was not recorded.

Frequently Asked Questions (FAQ)

Q: What is the TrustedForm Lead Matching API Operation?
A: It is an API operation that verifies whether the lead’s submitted contact information (email and phone) matches the secure, hashed values stored in the TrustedForm certificate, confirming the legitimacy and consent of the lead.

Q: Why is lead matching important?
A: Lead matching minimizes the risk of processing fraudulent or misattributed leads by ensuring the certificate data corresponds with the submitted lead information, supporting compliance with regulatory standards like the TCPA.

Q: How do I use the Lead Matching API Operation?
A: Include the lead’s email and/or phone number within a “match_lead” object in your API request to the certificate URL and verify the returned outcome in the JSON response.

Q: How fast is the lead matching process?
A: The matching process is designed to operate in near real-time, typically processing and returning a response within a few seconds of the API request.


Glossary

Term Definition
Lead Matching The process of comparing submitted lead contact data against SHA1-hashed data stored in a TrustedForm certificate to verify authenticity.
Fingerprinting The conversion of raw email addresses and phone numbers into secure SHA1 hash values as a means of non-invasively verifying lead data.
Normalization The process of converting data to a standard format (e.g., downcasing emails, stripping non-digit characters from phone numbers) to ensure accurate comparisons.
Certificate URL A unique URL provided by TrustedForm that links to a certificate documenting a lead event, including captured data and session replay.
Retain An API operation used to store a TrustedForm certificate in your account for future reference and evidence of consumer consent.
API Version Refers to the version of the TrustedForm Certificate API being used (e.g., v4.0) which determines the request and response structure.

Was this article helpful?

0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.