ClickTerm Docs — Clickwrap Consent Management

Prerequisites: A published template with placeholder tokens configured in the template editor, and the SDK installed.

Placeholders inject dynamic, user-specific values into template content without changing the published text. Provide values through your integration whenever a clickwrap flow is triggered.

Starting from Web SDK 2.3.0, Android SDK 2.2.0, and React Native SDK 0.3.0, custom placeholders are passed through customPlaceholders instead of flat custom1 to custom10 fields. If you are on an older version, see the older versions section below.

Available placeholders

String

Full Name — End user’s full name. Max 100 chars. Letters, digits, spaces, basic punctuation.

String

Email — End user’s email address. Max 254 chars. Standard email format.

String

Company — Organization name. Max 100 chars. Letters, digits, spaces, basic punctuation.

String

Job Title — End user’s role. Max 80 chars. Letters, digits, spaces, basic punctuation.

String

Date — Optional date string rendered into the template.

String

Phone — Contact number. Max 30 chars. Digits, spaces, basic punctuation.

String

Registration No. — Company registration identifier. Max 50 chars. Letters, digits, spaces, basic punctuation.

String

VAT Number — VAT identifier. Max 50 chars. Letters, digits, spaces, basic punctuation.

String

Address — Physical address. Max 500 chars. Letters, digits, spaces, punctuation, newlines.

Map<String, String>

Custom placeholders — User-defined placeholder key-value pairs. Max 10000 chars. Letters, digits, spaces, punctuation, newlines

If a placeholder value is not supplied, it appears as a dash (-) in the rendered agreement.

Usage

Current versions (recommended)
Older versions

Applies to Web SDK 2.3.0+, Android SDK 2.2.0+, and React Native SDK 0.3.0+.

const templatePlaceholders = {
  fullName: "Alice Example",
  email: "[email protected]",
  company: "Acme Corp",
  jobTitle: "Senior Counsel",
  date: "2026-06-23",
  phoneNumber: "+12025550123",
  registrationNumber: "HRB 123456",
  vatNumber: "GB123456789",
  address: "221B Baker St\nLondon NW1",
  customPlaceholders: {
    region: "EMEA",
    plan: "Enterprise",
    purchaseOrder: "12345-XYZ",
  },
};

ClicktermDialog.show({
  endUserId: "user-123",
  clickwrapTemplateId: "YOUR_TEMPLATE_ID",
  templatePlaceholders,
  language: "en"
}).then((result) => {
  console.log("Clickwrap result:", result);
}).catch((error) => {
  console.error("Clickwrap error:", error);
});

const templatePlaceholders = {
  fullName: "Alice Example",
  email: "[email protected]",
  company: "Acme Corp",
  jobTitle: "Senior Counsel",
  date: "2026-06-23",
  phoneNumber: "+12025550123",
  registrationNumber: "HRB 123456",
  vatNumber: "GB123456789",
  address: "221B Baker St\nLondon NW1",
  customPlaceholders: {
    region: "EMEA",
    plan: "Enterprise",
    purchaseOrder: "12345-XYZ",
  },
};

const handle = await ClicktermDom.renderInline(
  "my-consent",
  {
    endUserId: "user-123",
    clickwrapTemplateId: "YOUR_TEMPLATE_ID",
    templatePlaceholders,
    language: "en",
  }
);

val templatePlaceholders = TemplatePlaceholdersRequestDto(
    fullName = "Alice Example",
    email = "[email protected]",
    company = "Acme Corp",
    jobTitle = "Senior Counsel",
    date = "2026-06-23",
    phoneNumber = "+12025550123",
    registrationNumber = "HRB 123456",
    vatNumber = "GB123456789",
    address = "221B Baker St\nLondon NW1",
    customPlaceholders = mapOf(
        "region" to "EMEA",
        "plan" to "Enterprise",
        "purchaseOrder" to "12345-XYZ",
    ),
)

val contentRequestBody = ClickwrapTemplate(
    "YOUR_TEMPLATE_ID", endUserId, templatePlaceholders, "en"
)

ClicktermDialog.show(this, contentRequestBody, null,
    object : ClicktermDialog.OnAgreementResultListener {
        override fun onSuccess(clicktermSignature: String?) {
            // Handle success
        }
        override fun onError(message: String) {
            // Handle error
        }
    }
)

Applies to Web SDK < 2.3.0, Android SDK < 2.2.0, and React Native SDK < 0.3.0.In older versions, custom placeholders are passed as flat numbered fields (custom1 through custom10) instead of the customPlaceholders map.

const templatePlaceholders = {
  fullName: "Alice Example",
  email: "[email protected]",
  company: "Acme Corp",
  jobTitle: "Senior Counsel",
  date: "2026-06-23",
  phoneNumber: "+12025550123",
  registrationNumber: "HRB 123456",
  vatNumber: "GB123456789",
  address: "221B Baker St\nLondon NW1",
  custom1: "EMEA",
  custom2: "Enterprise",
  custom3: "12345-XYZ",
};

ClicktermDialog.show({
  endUserId: "user-123",
  clickwrapTemplateId: "YOUR_TEMPLATE_ID",
  templatePlaceholders,
  language: "en"
}).then((result) => {
  console.log("Clickwrap result:", result);
}).catch((error) => {
  console.error("Clickwrap error:", error);
});

const templatePlaceholders = {
  fullName: "Alice Example",
  email: "[email protected]",
  company: "Acme Corp",
  jobTitle: "Senior Counsel",
  date: "2026-06-23",
  phoneNumber: "+12025550123",
  registrationNumber: "HRB 123456",
  vatNumber: "GB123456789",
  address: "221B Baker St\nLondon NW1",
  custom1: "EMEA",
  custom2: "Enterprise",
  custom3: "12345-XYZ",
};

const handle = await ClicktermDom.renderInline(
  "my-consent",
  {
    endUserId: "user-123",
    clickwrapTemplateId: "YOUR_TEMPLATE_ID",
    templatePlaceholders,
    language: "en",
  }
);

val templatePlaceholders = TemplatePlaceholdersRequestDto(
    fullName = "Alice Example",
    email = "[email protected]",
    company = "Acme Corp",
    jobTitle = "Senior Counsel",
    date = "2026-06-23",
    phoneNumber = "+12025550123",
    registrationNumber = "HRB 123456",
    vatNumber = "GB123456789",
    address = "221B Baker St\nLondon NW1",
    custom1 = "EMEA",
    custom2 = "Enterprise",
    custom3 = "12345-XYZ",
)

val contentRequestBody = ClickwrapTemplate(
    "YOUR_TEMPLATE_ID", endUserId, templatePlaceholders, "en"
)

ClicktermDialog.show(this, contentRequestBody, null,
    object : ClicktermDialog.OnAgreementResultListener {
        override fun onSuccess(clicktermSignature: String?) {
            // Handle success
        }
        override fun onError(message: String) {
            // Handle error
        }
    }
)

The custom1-custom10 fields are deprecated and limited to 10 values with generic keys. Upgrade to the latest SDK version to use the customPlaceholders map instead.

How it works

You configure placeholder tokens in the template editor (drag and drop from the sidebar)
When calling ClicktermDialog.show() or ClicktermDom.renderInline(), pass values via the templatePlaceholders parameter
ClickTerm substitutes those values into the template before rendering
The same values appear in the Clickwrap Event, Certificate of Acceptance, and end user record

Template editor showing placeholder tokens being inserted into the agreement

Rendered clickwrap modal showing placeholders replaced with live data

Product Guide: Placeholders

How to configure placeholder tokens in the dashboard editor.

Displaying a clickwrap

Show the clickwrap in dialog or inline mode.

Getting started

Integration guides

Web SDK

Android SDK

iOS SDK

React Native SDK

Resources

Template placeholders

Available placeholders

Usage

How it works

Product Guide: Placeholders

Displaying a clickwrap

​Available placeholders

​Usage

​How it works

​Related

Product Guide: Placeholders

Displaying a clickwrap

Available placeholders

Usage

How it works

Related