ClickTerm Docs — Clickwrap Consent Management

The ClickTerm Web SDK uses Promises to communicate results. The show() and showAcceptedContent() methods return promises that resolve on success and reject on error.

Show result

When ClicktermDialog.show() resolves:

ClicktermDialog.show({
  endUserId: "user-123",
  clickwrapTemplateId: "YOUR_TEMPLATE_ID",
}).then((result) => {
  // result.clicktermSignature — the Signature to send to your backend
  console.log("Signature:", result.clicktermSignature);
}).catch((error) => {
  // SDK or network error
  console.error("Error:", error);
});

Possible outcomes

Outcome	What happens
User accepts	Promise resolves with a Signature — send it to your backend
User declines	Promise resolves with a Signature — verify it to record the decline
User already accepted	Promise resolves with `null` Signature — no dialog was shown
Error	Promise rejects with an error message

A null Signature means the user has already accepted the latest major version. No action is needed on your part.

Error handling

Errors are returned via the Promise .catch() handler:

ClicktermDialog.show({
  endUserId: "user-123",
  clickwrapTemplateId: "YOUR_TEMPLATE_ID",
}).catch((error) => {
  // Handle error — e.g., SDK not initialized, network issue, template not found
  console.error("Clickwrap error:", error);
});

Common error scenarios:

Error	Cause
SDK not initialized	`ClicktermClient.initialize()` was not called
Template not found	Template is disabled or has no effective version
Network error	Cannot reach the ClickTerm API

Using async/await

try {
  const result = await ClicktermDialog.show({
    endUserId: "user-123",
    clickwrapTemplateId: "YOUR_TEMPLATE_ID",
  });

  if (result.clicktermSignature) {
    // Send to backend for verification
    await verifySignature(result.clicktermSignature);
  } else {
    // User already accepted — no action needed
  }
} catch (error) {
  console.error("Clickwrap error:", error);
}

interface ClickwrapResult {
  signature: string | null;
}

try {
  const result: ClickwrapResult = await ClicktermDialog.show({
    endUserId: "user-123",
    clickwrapTemplateId: "YOUR_TEMPLATE_ID",
  });

  if (result.clicktermSignature) {
    await verifySignature(result.clicktermSignature);
  } else {
    // User already accepted — no action needed
  }
} catch (error: unknown) {
  console.error("Clickwrap error:", error);
}

Inline mode callbacks

Inline mode uses a different callback pattern. Instead of a single Promise from show(), you get:

onLoading / onReady / onError callbacks — lifecycle hooks around the initial render, added in Web SDK 2.5.0
onChange callback — fires every time the checkbox state changes (passed via options to renderInline())
finalize() Promise — resolves when the agreement is submitted to the backend

const handle = await ClicktermDom.renderInline('container', request, {
  onLoading: () => {
    // Rendering needs a backend round trip — show your own loader here
    consentSkeleton.hidden = false;
  },
  onReady: ({ outcome }) => {
    consentSkeleton.hidden = true;
    if (outcome === 'ALREADY_ACCEPTED') {
      submitButton.disabled = false;
    }
  },
  onError: (error) => {
    consentSkeleton.hidden = true;
    showRetryMessage(error.message);
  },
  onChange: (checked) => {
    // React to checkbox state changes
    submitButton.disabled = !checked;
  },
});

// Later, when the user submits your form:
const result = await handle.finalize();
if (result.status === 'ERROR') {
  console.error('Finalize failed:', result.error?.message);
}

onError is a notification for updating your UI. renderInline() still rejects on failure, so keep handling that rejection too. A callback that throws is caught and logged by the SDK rather than failing the render.

For full details, see the ClicktermDom API reference and inline lifecycle callbacks.

Getting started

Integration guides

Web SDK

Android SDK

iOS SDK

React Native SDK

Resources

Events & callbacks

Show result

Possible outcomes

Error handling

Using async/await

Inline mode callbacks

​Show result

​Possible outcomes

​Error handling

​Using async/await

​Inline mode callbacks

Show result

Possible outcomes

Error handling

Using async/await

Inline mode callbacks