Feature Snapshot
Summary:
The Vendor Field is an optional parameter that allows you to include the name of the vendor or partner responsible for supplying the lead on your certificates. This parameter is recorded with the retained certificate and displayed in the History tab for easy tracking and auditing.
Key Benefits:
- Associates each retained certificate with its originating vendor to document the source of the lead.
- Facilitates improved reporting and auditing of vendor performance.
Typical Use Cases:
- Including a vendor name in certificate retention API requests to document which partner supplied the lead.
- Improving lead quality analysis and compliance reviews by tracking vendor performance.
How the Vendor Field works
When you retain a TrustedForm certificate, you have the option to include a vendor name in your request. TrustedForm records the vendor name along with the certificate metadata, making it visible on your account’s History tab. This enables you to rapidly identify the lead’s source and supports additional reporting.
Step‑by‑Step Instructions
- Add the vendor parameter (commonly named “vendor”) per the API documentation and set its value to the name of the vendor or partner that provided the lead.
- Submit Retain request along with all required parameters.
- Check that the certificate is successfully retained and that the vendor information appears on your History tab.
Expected Result:
The certificate will be retained with the vendor name recorded, and you will see the vendor information clearly displayed in your TrustedForm account’s History tab.
Validation & Monitoring (optional)
-
Test the Setup:
Submit a certificate retention request including the vendor parameter and then verify in your TrustedForm account’s History tab that the vendor name appears as expected. -
Where to Monitor?:
Monitor the Vendor Reports section of your TrustedForm account to confirm that the vendor used is being reported correctly.
Best Practices
- Always use a consistent naming convention for the vendor value across all API requests to ensure accurate tracking.
- Cross-reference internal vendor records with the vendor names recorded in your certificates for reliable auditing.
- Clearly document and communicate the usage of the vendor field with all team members responsible for lead processing and compliance.
Troubleshooting
| Symptom / Error | Likely Cause | Resolution |
|---|---|---|
| Vendor field is missing in the certificate record | The vendor parameter was omitted or misnamed in the API request. | Ensure that the API request includes the vendor parameter with the exact name as specified in documentation. |
| Vendor field displays unexpected value | The vendor name includes formatting errors or unintended characters. | Verify that the vendor value follows your established naming conventions and remove any extraneous characters. |
| API error related to the vendor parameter | The supplied vendor parameter doesn’t match the API schema requirements. | Review the TrustedForm API documentation and adjust the parameter name or format as needed. |
Frequently Asked Questions (FAQ)
Q: What is the Vendor Field in TrustedForm Retain?
A: It is an optional API parameter that records the name of the company or partner that supplied the lead, thereby ensuring that each certificate is linked to its source.
Q: Why is including a Vendor Field important?
A: Including the vendor field improves transparency and accountability by linking each retained certificate to its originating vendor, which aids in compliance, auditing, and performance analysis.
Q: How do I use the Vendor Field?
A: Add the vendor parameter with the correct vendor name to your Retain request. After the certificate is retained, you will be able to view the vendor information in your TrustedForm account’s History tab.
9. Glossary
| Term | Definition |
|---|---|
| Vendor Field | An optional parameter in the TrustedForm Retain API that records the name of the company or partner supplying the lead. |
| Certificate Retain | The process of storing a TrustedForm certificate for long-term audit and compliance purposes. |
| API Request | A call made from your system to TrustedForm to perform operations such as retaining a certificate. |
Comments
0 comments
Please sign in to leave a comment.