ClickTerm Docs — Clickwrap Consent Management

Latest SDK versions: Web 2.5.0 · Android 2.4.0 · iOS 1.3.0 · React Native 1.2.0 — View changelog

This guide walks you through displaying a clickwrap agreement in an iOS app and verifying the result on your backend.

Prerequisites

A ClickTerm account
A published template with an effective version (see Product Guide)
An integration with your App ID and App Key (from Integrations)
iOS 15.0+, Swift 5.9+, and Xcode 15.0+

Need to set up your credentials and template first? See Creating an app & template.

1. Add the SDK

Choose Swift Package Manager or add the XCFramework directly. Both options use the same prebuilt SDK from the ClickTerm CDN and do not require access to the SDK source repository.

Swift Package Manager
Manual XCFramework

Create a small local package with this Package.swift:

Package.swift

// swift-tools-version: 5.9
import PackageDescription

let package = Package(
    name: "ClicktermSDKBinary",
    platforms: [
        .iOS(.v15)
    ],
    products: [
        .library(
            name: "ClicktermSDK",
            targets: ["ClicktermSDK"]
        )
    ],
    targets: [
        .binaryTarget(
            name: "ClicktermSDK",
            url: "https://cdn.clickterm.com/sdk/ios/release/1.2.0/ClicktermSDK.xcframework.zip",
            checksum: "80caaf89e19da5beafa8d24f4376a505f6fc0d247dc5c35900e2a01fd5cfdafd"
        )
    ]
)

In Xcode, choose File → Add Package Dependencies… → Add Local…, select the package folder, and add the ClicktermSDK product to your app target.

Download ClicktermSDK 1.2.0

Prebuilt XCFramework for iOS devices and simulators.

Unzip the download, then:

Drag ClicktermSDK.xcframework into your Xcode project.
Select Copy items if needed and add it to your app target.
Under General → Frameworks, Libraries, and Embedded Content, select Embed & Sign.

For checksum verification and detailed setup, see iOS SDK installation.

2. Initialize the SDK

Initialize ClickTerm once when your app starts:

import ClicktermSDK

ClicktermClient.initialize(appId: "YOUR_CLICKTERM_APP_ID")

Get your App ID from the Integrations page in the ClickTerm Dashboard.

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.

Calling SDK methods before initialization throws ClicktermError.notInitialized.

3. Show the clickwrap

From a visible UIViewController, create the request and present the dialog:

let request = ClickwrapTemplateRequest(
    clickwrapTemplateId: "YOUR_TEMPLATE_ID",
    endUserId: "user-123",
    templatePlaceholders: [
        "fullName": AnyCodable("Alice Example")
    ],
    language: "en"
)

Task { @MainActor in
    do {
        let signature = try await ClicktermDialog.show(
            from: self,
            request: request
        )

        guard let signature else {
            // The user already acted on this agreement.
            return
        }

        // Send the Signature to your backend for verification.
        await sendToBackend(signature)
    } catch ClicktermError.userCancelled {
        // The user closed the dialog.
    } catch {
        print("Clickwrap error: \(error.localizedDescription)")
    }
}

The dialog only appears when a new user action is needed. Requests to display a clickwrap are not counted toward billing. See ClicktermDialog for all results and the accepted-content flow.

4. Verify on your backend

Send the Signature to your server, then verify it with your App ID and App Key:

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 — Consent is verified and a Certificate of Acceptance is generated.
DECLINED — The event is verified without generating a Certificate of Acceptance.

Requests to /clickwrap/verify are counted toward billing. Implement rate limiting or a Captcha check before this step to prevent abuse.

For the complete backend flow, see Verifying a Signature.

Next steps

iOS SDK reference

Explore the complete native iOS API.

Template placeholders

Add user-specific values to agreements.

Integration flow

Understand how the SDK and backend fit together.

Getting started

Integration guides

Web SDK

Android SDK

iOS SDK

React Native SDK

Resources

Quickstart — iOS SDK

Prerequisites

1. Add the SDK

Download ClicktermSDK 1.2.0

2. Initialize the SDK

3. Show the clickwrap

4. Verify on your backend

Next steps

iOS SDK reference

Template placeholders

Integration flow

​Prerequisites

​1. Add the SDK

Download ClicktermSDK 1.2.0

​2. Initialize the SDK

​3. Show the clickwrap

​4. Verify on your backend

​Next steps

iOS SDK reference

Template placeholders

Integration flow

Prerequisites

1. Add the SDK

2. Initialize the SDK

3. Show the clickwrap

4. Verify on your backend

Next steps