Reference Field

Feature Snapshot

Summary:
Reference Field is an optional parameter used when retaining a TrustedForm certificate. It allows you to attach your own unique identifier—such as a CRM lead ID—to the certificate so you’ll be able to associate it with your internal records.

Key Benefits:

• Connects certificates with your internal lead records
• Simplifies auditing and compliance verification

Typical Use Cases:

• Mapping certificates to specific leads in your internal database
• Documenting additional details about the lead

How the Reference Field works

When you programmatically retain a certificate, you can include an optional parameter named “reference.” TrustedForm captures this value, stores it, and displys it on the certificate’s history section.

Step‑by‑Step Instructions

1. Identify the value you would like to use from your internal system (for example, the CRM Lead ID).
2. In your API request to retain a TrustedForm certificate, include the parameter:
   • reference: Set this to your unique lead identifier.
3. Ensure that your API request includes the proper HTTP headers (e.g., Accept: application/json, Content-Type: application/json) and correctly configured authentication.
4. Submit the POST request to the TrustedForm certificate URL (which begins with “https://cert.trustedform.com/”).
5. Review the API response to confirm that the returned JSON object includes the Reference Code matching the value you provided.

Expected Result:
The certificate is retained with the provided reference value stored in its history. When you view the certificate details via the TrustedForm dashboard or API, your unique lead identifier appears as the Reference.

Validation & Monitoring (optional)

• Test the Setup:
  After submitting your retention request, verify by checking the history tab of the certificate to confirm that the Reference listed matches the value you provided.

Best Practices

• Always include a unique reference value for each certificate retention request to ensure precise traceability.
• Double-check that the API request includes the correctly spelled parameter “reference” with proper encoding.
• Use a consistent format for your lead identifier (for example, always using the CRM Lead ID format) to maintain uniformity in your records.

Troubleshooting

Frequently Asked Questions (FAQ)

Q: What is the Reference Field?
A: It is an optional parameter in a TrustedForm certificate retention request that lets you attach an external unique identifier (such as a CRM Lead ID) to the certificate.

Q: Why is the Reference Field important?
A: It allows you to show a relationship between the certificate and your internal lead records, simplifying compliance audits, troubleshooting, and reporting.

Q: How do I use the Reference Field?
A: Include the parameter “reference” with your unique lead identifier in the API request when retaining a certificate. Ensure that your API request is correctly formatted and authenticated so that the returned certificate includes the corresponding Reference Code.

Glossary

• reference-field-screenshot.png30 KB