ClickTerm Docs — Clickwrap Consent Management

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"}'

{ "clickwrapEventStatus": "ACCEPTED", "clickwrapEventId": "123e4567-e89b-12d3-a456-426614174000", "clickwrapTemplateId": "987e6543-e21b-45d3-b321-426614174999", "clickwrapTemplateVersion": 1, "clickwrapTemplateVersionMinor": 0, "endUserId": "user-123", "templatePlaceholders": "{\"email\":\"[email protected]\"}", "technicalMetadata": "{\"userAgent\":\"Mozilla/5.0...\",\"ip\":\"203.0.113.42\"}", "actionAt": "2026-03-23T14:30:00Z", "effectiveAt": "2026-03-23T14:00:00Z" }

Authorizations

X-APP-ID

string

header

required

Your application's App ID, sent as the X-APP-ID header. Must be accompanied by X-APP-KEY for authenticated endpoints.

X-APP-KEY

string

header

required

Your application's secret App Key (server-side only)

Body

application/json

clicktermSignature

string

required

The Signature returned by the SDK after user action

Response

Signature verified, event details returned

Response from the verify endpoint after successful Signature validation

clickwrapEventStatus

enum<string>

The verified status of the clickwrap event

Available options:

ACCEPTED,

DECLINED

clickwrapEventId

string<uuid>

Unique identifier for the created Clickwrap Event

clickwrapTemplateId

string<uuid>

The clickwrap template shown to the end user

clickwrapTemplateVersion

integer

Major version number of the template

clickwrapTemplateVersionMinor

integer

Minor version number of the template

endUserId

string

The end user identifier provided in the SDK call

templatePlaceholders

string | null

JSON-encoded placeholder values submitted during the session, or null if none were provided

technicalMetadata

string

JSON-encoded client metadata (IP address, user agent, device info)

actionAt

string<date-time>

When the end user performed the action (UTC, ISO-8601)

effectiveAt

string<date-time>

When the clickwrap template version became effective (UTC, ISO-8601)