ClickTerm Docs — Clickwrap Consent Management

[ { "clickwrapTemplateId": "987e6543-e21b-45d3-b321-426614174999", "clickwrapTemplateName": "Terms of Service", "clickwrapTemplateVersion": 2, "clickwrapTemplateVersionMinor": 0, "status": "ACCEPTED", "lastStatusUpdate": "2026-03-18T10:22:14Z", "tags": [ "registration", "customer_only" ], "effectiveAt": "2026-03-15T14:00:00Z", "mustAcceptBy": null }, { "clickwrapTemplateId": "123e4567-e89b-12d3-a456-426614174000", "clickwrapTemplateName": "Privacy Policy", "clickwrapTemplateVersion": 1, "clickwrapTemplateVersionMinor": 3, "status": "NO_DATA", "lastStatusUpdate": null, "tags": [], "effectiveAt": "2026-03-01T00:00:00Z", "mustAcceptBy": "2026-04-01T00: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)

Path Parameters

endUserId

string

required

The end user identifier

Response

200 - application/json

Consent status retrieved

clickwrapTemplateId

string<uuid>

Unique identifier of the clickwrap template

clickwrapTemplateName

string

Display name of the clickwrap template

clickwrapTemplateVersion

integer

Major version of the template associated with this status

clickwrapTemplateVersionMinor

integer

Minor version of the template associated with this status

status

string

Current interaction status of the end user:

NO_DATA — No recorded interaction
PENDING — Clickwrap presented but user hasn't acted
UNVERIFIED — User acted but event not yet verified
ACCEPTED — Event verified, user accepted
DECLINED — Event verified, user declined
OVERDUE — The mustAcceptBy deadline passed with no interaction

lastStatusUpdate

string<date-time> | null

Most recent status change (UTC, ISO-8601), or null if no interaction recorded