For the complete documentation index, see llms.txt. This page is also available as Markdown.

Consent Proof Capture Requirements

Submit Jornaya LeadiD or TrustedForm consent proof with API lead requests.

Consent proof is accepted on API submissions only. It is not supported in Engine-hosted embeds.

Overview

Engine supports third-party consent verification through Jornaya and ActiveProspect. Partners collecting consent on their own forms can submit the provider token or certificate URL with a lead.

A consent proof records the user's consent event. It does not replace the consent fields in legalInformation.

Provider

consentProofSource

consentProof

Jornaya (LeadiD)

external_jornaya

LeadiD token, such as A271FDE6-E09C-...

ActiveProspect (TrustedForm)

external_trusted_form

Certificate URL, such as https://cert.trustedform.com/abc123...

Integration flow

1

Install the provider tag

Install the Jornaya or TrustedForm JavaScript tag on each consent form page.

  • Jornaya: Add the LeadiD script tag to your page. The tag generates a unique LeadiD token for each user session.

  • TrustedForm: Add the TrustedForm Certify script tag to your page. The tag generates a certificate URL for each user session.

2

Capture the proof

Store the generated token or certificate URL in a hidden form field so it is available at submission time.

3

Submit the proof

Add consentProofInformation to the top level of your POST /leads/rateTables request.

API submission format

Include the consentProofInformation object at the top level of your POST /leads/rateTables request body, alongside your existing fields (personalInformation, loanInformation, legalInformation, etc.).

Examples

Field Reference

Field
Type
Required
Description

consentProofInformation

Object

No

Consent proof container. Omit it when proof is unavailable.

consentProofInformation.consentProof

String

Yes, when present

Jornaya token or TrustedForm certificate URL.

consentProofInformation.consentProofSource

String

Yes, when present

external_jornaya or external_trusted_form.

Installation Guides

Add the Jornaya campaign script. Replace YOUR_CAMPAIGN_KEY with your Jornaya campaign key.

Add a hidden field. The tag populates it with the LeadiD token.

Read this value at submission and send it as consentProof.

Add the TrustedForm Certify script to your form page.

Add a hidden field. The tag populates it with the certificate URL.

Read this value at submission and send it as consentProof.

TCPA Disclosure Requirements

Your form must display appropriate TCPA disclosure language. Submit the exact displayed text in legalInformation.tcpaLanguage.

See Collecting User Information for consent and disclosure requirements.

Troubleshooting

Issue
Resolution

consentProof is empty

Confirm the provider tag loads before submission. Check for ad blockers or script-blocking extensions.

API rejects consentProofSource

Use exactly external_jornaya or external_trusted_form. Values are case-sensitive.

Leads do not receive TCPA-eligible offers

Set consentsToTcpa to true. Send the disclosure text in tcpaLanguage.

Last updated

Was this helpful?