Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.clickterm.com/llms.txt

Use this file to discover all available pages before exploring further.

Latest SDK versions: Web 2.2.1 · Android 2.1.1 — View changelog
This guide walks you through displaying a clickwrap agreement to your users and verifying their consent on your backend. For a detailed overview of how the pieces fit together, see the Integration flow.

​
Prerequisites

Before you start, make sure you have:
  1. A ClickTerm account
  2. A published template with an effective version (see Product Guide)
  3. An integration with your App ID and App Key (from Integrations)
Need to set up your credentials and template first? See Creating an app & template.

​
1. Install the SDK

Add the ClickTerm SDK script tag to your frontend app: 
<script src="https://cdn.clickterm.com/sdk/clickterm-widget-2.2.1.min.js"></script>
The SDK is loaded from the ClickTerm CDN. No npm package is required.
For more details, see Web SDK Installation.

​
2. Initialize the SDK

After loading the script, initialize the client with your App ID. You can obtain it from the Integrations menu in the ClickTerm dashboard. 
const { ClicktermClient, ClicktermDialog } = window.Clickterm;
ClicktermClient.initialize("YOUR_CLICKTERM_APP_ID");
Never expose your App Key in client-side code. The App Key is used only for backend verification calls. The client SDK uses only the App ID. Store the App Key safely — it won’t display again after creation, but can be regenerated. Regenerating the key requires updating your backend configuration.
Without initialization the SDK will not work and you will get an error when trying to request a clickwrap.

​
3. Show the clickwrap dialog

Call ClicktermDialog.show() to present the clickwrap to your user. The SDK:
  1. Fetches the current effective template version from ClickTerm
  2. Displays it in a modal dialog
  3. Creates an event in ClickTerm once the end user accepts or declines
  4. Returns a Signature to your application
The event remains unverified until your backend calls the verification endpoint.
example.js
ClicktermDialog.show({
  endUserId: "user-123",                // Your identifier for the end user
  clickwrapTemplateId: "YOUR_TEMPLATE_ID", // From the ClickTerm dashboard
  language: "en"                         // Optional — falls back to default language
}).then((result) => {
  if (result.clicktermSignature) {
    // Send Signature to your backend for verification
    sendToBackend(result.clicktermSignature);
  } else if (result.isAlreadyAccepted) {
    // User already accepted the latest major version — no dialog was shown
  }
}).catch((error) => {
  console.error("Clickwrap error:", error);
});
The dialog only appears if the user hasn’t already accepted the latest major version. Requests to show a clickwrap are not counted toward billing. For the full list of parameters, result fields, and configuration options, see Displaying a clickwrap.

​
4. Verify on your backend

After the end user accepts or declines the clickwrap, the SDK creates an unverified event in ClickTerm and returns a Signature. Send this Signature to your server, then call ClickTerm’s verification endpoint with your App ID and App Key. This verifies the event — confirming the Signature hasn’t been forged or tampered with. For accepted events, a Certificate of Acceptance is generated. 
curl -X POST https://api.clickterm.com/public-client/v1/clickwrap/verify \
  -H "X-APP-ID: YOUR_APP_ID" \
  -H "X-APP-KEY: YOUR_APP_KEY" \
  -H "Content-Type: application/json" \
  -d '{"clicktermSignature": "SIGNATURE_FROM_SDK"}'
The response contains clickwrapEventStatus ("ACCEPTED" or "DECLINED") along with the full event metadata (event ID, template version, timestamps, etc.).
  • ACCEPTED — The user accepted the terms. The event is now verified and a Certificate of Acceptance is generated.
  • DECLINED — The event is still verified, but no Certificate of Acceptance is generated. It’s up to your application to decide how to handle this (e.g., block the user journey or restrict features).
Requests to /clickwrap/verify are counted toward billing. Implement rate limiting or a Captcha check before this step to prevent abuse.
For full request/response details and framework-specific examples (Node.js, Python, Java), see Verifying a Signature.

​
5. Alternative: Inline clickwrap

If you prefer to embed a consent checkbox directly in your page instead of showing a modal, use ClicktermDom.renderInline() (SDK v2.2.0+): 
<div id="my-consent"></div>

const { ClicktermClient, ClicktermDom } = window.Clickterm;
ClicktermClient.initialize("YOUR_CLICKTERM_APP_ID");

const handle = await ClicktermDom.renderInline(
  "my-consent",
  {
    endUserId: "user-123",
    clickwrapTemplateId: "YOUR_TEMPLATE_ID",
  },
  {
    onChange: (checked) => {
      document.getElementById("submit-btn").disabled = !checked;
    },
  }
);

// Finalize when the user submits your form
const result = await handle.finalize();
// Send result.clicktermSignature to your backend for verification
Inline mode is ideal for registration forms, checkouts, and multi-consent flows. For the full guide, see Displaying an inline clickwrap.

​
Next steps

Integration flow

Understand the complete integration architecture.

Template placeholders

Pass user-specific data into your clickwrap templates.

Widget customization

Customize the dialog appearance from the dashboard.

API Reference

Explore all available API endpoints.