Verify API Operation

Feature Snapshot

Summary:
The Verify API Operation is a real‑time TrustedForm API call that checks whether a lead’s certificate meets predefined consent and compliance requirements before the lead is approved for further use.

Key Benefits:

• Confirms every lead meets specific requirements for prior express written consent before contact
• Automates compliance checks to reduce legal risk
• Provides a detailed JSON response with clear outcomes and failure reasons

Typical Use Cases:

• Validating lead consent just before lead purchase or distribution
• Integrating automated verification into CRM systems or lead filter workflows

How the Verify API Operation works

Step‑by‑Step Instructions

1. Obtain the Certificate URL:
   Retrieve the unique TrustedForm Certificate URL provided with the lead during the certification process.

2. Configure Your API Request:
   Prepare an HTTP POST request to the TrustedForm Verify endpoint per the API Documentation. Include mandatory headers such as:
   • api-version: 4.0
   • Content-Type: application/json
   • Accept: application/json
   Also, include proper HTTP Basic Authentication credentials using your API key.

3. Submit the Verification Request:
   Send the POST request with the certificate URL and any optional parameters (for example, lead’s email or phone for fingerprint matching) in the JSON payload.

4. Interpret the Response:
   The API returns a JSON response with an outcome field that indicates “success”, “failure”, or “error”. Additional fields like reason provide insight into any issues if the verification fails.

5. Act on the Verification Result:
   Use the response data to automatically route, approve, or flag leads. If the outcome is failure or error, review the reasons and adjust your lead acceptance criteria or request additional vendor data.

Expected Result:
A JSON response displaying an outcome (e.g., "outcome": "success") along with detailed fields such as consent attributes and matching flags.

Validation & Monitoring (optional)

• Test the Setup: Submit a test lead with a valid TrustedForm Certificate URL and verify that the response returns "outcome": "success" when all consent criteria are met.
• Where to Monitor?: Review results in your API logs for outcome and error details.

Best Practices

• Always include all required headers and correct authentication details in your API requests.
• Test the integration with sample leads before going into production, and build fallback logic to handle "failure" or "error" outcomes.
• Regularly audit your verification criteria and update consent language approvals as regulatory standards or business requirements evolve.

Troubleshooting

Frequently Asked Questions (FAQ)

Q: What exactly does the Verify API Operation do?
A: It examines a TrustedForm certificate to ensure that the lead meets your specified consent and compliance requirements by checking for elements such as approved consent language and proper formatting.

Q: Why is the Verify API Operation important?
A: It automates the critical step of verifying consumer consent, reducing legal and regulatory risks while ensuring that only leads for consumers who have given their consent are contacted.

Q: How do I use the Verify API Operation?
A: By constructing and sending an HTTP POST request to the TrustedForm Verify endpoint with the required headers, certificate URL, and optional lead data. Then, interpret the JSON response to decide if the lead meets your consent criteria.

Q: How fast is the Verify API Operation?
A: It is designed for real‑time processing and typically returns a response in less than 1 second.

Glossary