Form completion refers to capturing the event when a user successfully submits a form. This solution automates the process, eliminating the need for manual integration and ensuring seamless tracking of form submissions.
To enable form completion on your forms, add the following class to the Submit button of your form:
consent-confirmation-form-submit
When this class is added to the button element, our script will:
onclick functionality and capture the form's completion.onclick is present for the button with this class.Additionally, observers will ensure that:
onsubmit event to handle any edge cases.
<form id="submit-form">
<button type="submit" class="consent-confirmation-form-submit">
Submit
</button>
</form>
<form id="submit-form">
<button type="submit" class="consent-confirmation-form-submit">
Submit Form
</button>
</form>
To mark the form as completed on pressing the Enter key in the last input field with type email, text or number, you can optionally add the consent-confirmation-form-submit class to this field. This ensures that the form is marked as completed even if it is not submitted via a button.
Example:
<form id="no-submit-form">
<label for="email">Email:</label>
<input type="text" id="email" placeholder="Enter your email" required />
<!-- Last input with the target class -->
<label for="phone">Phone:</label>
<input
type="text"
id="phone"
class="consent-confirmation-form-submit"
placeholder="Enter your phone number"
required
/>
<button type="submit" class="consent-confirmation-form-submit">Submit</button>
</form>
TCPA disclosure refers to the message displayed to users regarding consent for communications. This solution automatically captures the TCPA disclosure text from forms using a unique identifier, ensuring it is recorded and processed without manual effort.
The TCPA Disclosure label should be placed around the disclosure text displayed on forms. The class will allow us to capture the entire text contained within the element. To enable this functionality, add the following class to the HTML element containing the TCPA disclosure text:
consent-confirmation-tcpa-disclosure
This class will be used to extract and display the TCPA on the certificate details page in a pop-up after applying any required formatting (in the case of HTML).
<div class="consent-confirmation-tcpa-disclosure">
<p>
TCPA Consent: By submitting this form, I expressly consent to receive
marketing communications from [Company Name] and its representatives via:
</p>
<ul>
<li>Automated telephone dialing system</li>
<li>Prerecorded messages</li>
<li>Text messages</li>
<li>Emails</li>
</ul>
<p>
at the number/email provided, even if my number is on a do-not-call list. I
understand consent is not required for purchase.
</p>
</div>
This feature allows capturing and tracking the selection of insurance carriers within forms. It observes user interactions with checkboxes or radio buttons to automatically record and update the selected options for processing.
To enable this functionality, add the following class to the input elements containing the insurance carrier names:
consent-confirmation-brand
Note: This is the class to be used for individual checkbox/radio/image elements.
The Form Completion functionality must be implemented for the "Insurance Carriers" capture to work. Ensure the required steps outlined in the Form Completion section are completed before proceeding.
data-brand-name Attribute:
<label> for better accessibility and usability.
<div>
<div>
<input
type="checkbox"
id="companies_1"
value="true"
class="consent-confirmation-brand"
data-brand-name="State Farm"
/>
<label for="companies_1">
<p>
<img src="statefarm.png" alt="State Farm" />
</p>
</label>
</div>
<div>
<input
type="checkbox"
id="companies_2"
value="true"
class="consent-confirmation-brand"
data-brand-name="Allstate Insurance"
/>
<label for="companies_2"> Allstate Insurance </label>
</div>
</div>
<div>
<div>
<input
type="radio"
id="companies_1"
value="true"
name="insurance_companies"
class="consent-confirmation-brand"
data-brand-name="State Farm"
/>
<label for="companies_1">
<p>
<img src="statefarm.png" alt="State Farm" />
</p>
</label>
</div>
<div>
<input
type="radio"
id="companies_2"
value="true"
name="insurance_companies"
class="consent-confirmation-brand"
data-brand-name="Allstate Insurance"
/>
<label for="companies_2">
<p>
<img src="allstate.png" alt="Allstate Insurance" />
</p>
</label>
</div>
</div>
If the form includes a Select All checkbox option which controls the checked state of other checkboxes, then setting the following class is recommended.
consent-confirmation-brand-selectall
If the form does not have a Select All checkbox, this class is not required.
<div>
<!-- Select All Checkbox -->
<div>
<input
type="checkbox"
id="select_all"
class="consent-confirmation-brand-selectall"
data-brand-name="select-all"
/>
<label for="select_all">
<strong>Select All</strong>
</label>
</div>
<!-- Individual Insurance Carrier - State Farm -->
<div>
<input
type="checkbox"
id="companies_1"
class="consent-confirmation-brand"
data-brand-name="State Farm"
/>
<label for="companies_1">
<p>
<img
src="statefarm.png"
alt="State Farm"
class="carrier-logo"
width="150"
height="auto"
/>
</p>
</label>
</div>
<!-- Individual Insurance Carrier - Allstate Insurance -->
<div>
<input
type="checkbox"
id="companies_2"
class="consent-confirmation-brand"
data-brand-name="Allstate Insurance"
/>
<label for="companies_2">
<p>
<img
src="allstate.png"
alt="Allstate Insurance"
class="carrier-logo"
width="150"
height="auto"
/>
</p>
</label>
</div>
</div>
This API allows you to retrieve insurance carrier consent details against a certificate_id. It provides both the detailed carrier consent status and TCPA (Telephone Consumer Protection Act) related disclaimers.
GET /public/consentDetails/:certificate_id
The API requires a Bearer Token for authorization. Include the token in the request headers as follows:
Authorization: Bearer <your account API token>
If no request body is provided, the API will return all consented insurance carriers. To filter specific carriers, pass the following JSON body:
{
"insurance_carriers": ["Carrier 1", "Carrier 2"]
}
| Parameter | Type | Description |
|---|---|---|
insurance_carriers
|
Array of String | A list of carrier names to filter by |
The response contains the consent details of insurance carriers and TCPA disclaimers.
{
"consent_details": {
"certificate_id": "24fc3c9f3591421891197cd2ef78645a",
"insurance_carriers": [
{
"carrier_name": "carrier 1",
"consented": true
},
{
"carrier_name": "carrier 2",
"consented": true
},
{
"carrier_name": "21st Century Insurance",
"consented": true
},
{
"carrier_name": "Farmers Insurance ",
"consented": true
},
{
"carrier_name": "21st Century Insurance ",
"consented": true
}
],
"tcpa_disclaimer": "<p style="text-align: justify;">\n By clicking the "Continue & Get Quote" button, I provide my electronic signature and represent that I am at least 18 and agree to this website's \n <a style="text-decoration: underline; color: #3486e5 !important;" href="/privacy-policy">Privacy Policy</a> and \n <a style="text-decoration: underline; color: #3486e5 !important;" href="/terms-of-use">Terms of Services</a>.\n</p>\n<p style="text-align: justify;">\n By clicking the "Continue & Get Quote" button, I provide my express written consent and authorization to the owner of this website and/or of the listed agency to contact me for marketing/telemarketing purposes at the number and address provided above, including my wireless number if provided, using live operators, automated telephone dialing systems, artificial voice or pre-recorded messages, text messages and/or emails, if applicable, even if I have previously registered the provided number on any Federal or State Do Not Call Registry. I understand that my consent is not required as a condition of purchasing goods or services and can be revoked by me at any time.\n</p>\n<p style="text-align: justify;">\n Message and data rates may apply. Message frequency varies. Reply HELP for customer support or STOP to opt-out. See \n <a style="text-decoration: underline; color: #3486e5 !important;" href="/sms-terms">SMS Terms of Service</a> for more details.\n</p>\n",
"tcpa_disclaimer_text": "By clicking the \"Continue & Get Quote\" button, I provide my electronic signature and represent that I am at least 18 and agree to this website's Privacy Policy and Terms of Services. By clicking the \"Continue & Get Quote\" button, I provide my express written consent and authorization to the owner of this website and/or of the listed agency to contact me for marketing/telemarketing purposes at the number and address provided above, including my wireless number if provided, using live operators, automated telephone dialing systems, artificial voice or pre-recorded messages, text messages and/or emails, if applicable, even if I have previously registered the provided number on any Federal or State Do Not Call Registry. I understand that my consent is not required as a condition of purchasing goods or services and can be revoked by me at any time. Message and data rates may apply. Message frequency varies. Reply HELP for customer support or STOP to opt-out. See SMS Terms of Service for more details."
},
"status": "success"
}
| Field | Type | Description |
|---|---|---|
certificate_id |
String | Unique identifier for the certificate |
insurance_carriers |
Array of Objects | List of carriers with consent status |
carrier_name |
String | Name of the insurance carrier |
consented |
Boolean | Indicates whether consent was provided |
tcpa_disclaimer |
String (HTML) | TCPA disclaimer content in HTML format |
tcpa_disclaimer_text |
String | TCPA disclaimer content in plain text |
status |
String | API status, e.g., "success" |
tcpa_disclaimer provides HTML content for TCPA compliance, while tcpa_disclaimer_text provides the raw text version.
GET /public/consentDetails/24fc3c9f3591421891197cd2ef78645a
Authorization: Bearer <your account API token>
POST /public/consentDetails/24fc3c9f3591421891197cd2ef78645a
Authorization: Bearer <your account API token>
Content-Type: application/json
{
"insurance_carriers": ["Carrier 1", "Carrier 2"]
}