ClickTerm Docs — Clickwrap Consent Management

ClicktermClient is the entry point for the ClickTerm iOS SDK. Initialize it once before displaying a clickwrap.

Initialize

ClicktermClient.initialize(
    appId: String,
    environment: ClicktermEnvironment = .production
)

Parameter	Type	Required	Description
`appId`	`String`	Yes	Your App ID from the Integrations page
`environment`	`ClicktermEnvironment`	No	Uses `.production` by default

Call initialize() when your app starts:

import ClicktermSDK
import SwiftUI

@main
struct ExampleApp: App {
    init() {
        ClicktermClient.initialize(appId: "YOUR_CLICKTERM_APP_ID")
    }

    var body: some Scene {
        WindowGroup {
            ContentView()
        }
    }
}

The App ID cannot be empty. Calling other SDK methods before initialization throws ClicktermError.notInitialized.

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.

Shut down

ClicktermClient.shutdown()

shutdown() clears the current SDK configuration and loaded translations. Call it when signing out a user or replacing the active SDK configuration. Call initialize() again before the next SDK operation.

Lower-level requests

Most apps should use ClicktermDialog. These lower-level methods are available when you need to build your own presentation:

try await ClicktermClient.fetchTemplateContent(request)
try await ClicktermClient.fetchAcceptedTemplateContent(request)
try await ClicktermClient.fetchCustomizationSettings(
    clickwrapTemplateId: "YOUR_TEMPLATE_ID"
)
try await ClicktermClient.sendAgreement(event)

All request methods use Swift concurrency and can throw a ClicktermError.

Getting started

Integration guides

Web SDK

Android SDK

iOS SDK

React Native SDK

Resources

ClicktermClient

Initialize

Shut down

Lower-level requests

​Initialize

​Shut down

​Lower-level requests

Initialize

Shut down

Lower-level requests