RetainResult - ActiveProspect Developer Documentation

{
  "campaign_id": "summer_promo_2024",
  "reference": "1128238382829",
  "results": {
    "expires_at": "2023-07-18T12:03:52.000Z",
    "masked_cert_url": "<string>",
    "previously_retained": "false",
    "session_replay_status": "available"
  },
  "vendor": "Acme Co."
}

campaign_id

string

The campaign identifier submitted with the retain request, if provided.

Example:

"summer_promo_2024"

reference

string

Any text that may help you identify the lead associated with the certificate such as a unique lead identifier or URL pointing to the lead in another system. This value will be displayed in your copy of the certificate for your future reference.

Example:

"1128238382829"

results

object

Show child attributes

vendor

string

When retaining a certificate, you can optionally pass the vendor name. This is intended for tracking the name of the company that provided the lead associated with the certificate. TrustedForm will record this value on the certificate stored in your account. Other accounts cannot see this value. When you use TrustedForm reporting, you can easily filter or group by vendor.

Example:

"Acme Co."