cURL

curl -X GET \
  -H "X-APP-ID: YOUR_APP_ID" \
  -H "X-APP-KEY: YOUR_APP_KEY" \
  "https://api.clickterm.com/public-client/v1/clickwraps/user-123/status"

[
  {
    "clickwrapTemplateId": "987e6543-e21b-45d3-b321-426614174999",
    "clickwrapTemplateName": "Terms of Service",
    "clickwrapEventId": "d3e7b2f2-6ce9-4e49-8de5-2f73451d9c7b",
    "clickwrapTemplateVersion": 2,
    "clickwrapTemplateVersionMinor": 0,
    "status": "ACCEPTED",
    "lastStatusUpdate": "2026-03-18T10:22:14Z",
    "tags": [
      "registration",
      "customer_only"
    ],
    "effectiveAt": "2026-03-15T14:00:00Z",
    "mustAcceptBy": null,
    "reAcceptanceRequired": true
  },
  {
    "clickwrapTemplateId": "456e7890-e21b-45d3-b321-426614174111",
    "clickwrapTemplateName": "Marketing Consent",
    "clickwrapEventId": "6a97e7d9-1b70-4d0a-944c-c9ce989a6a83",
    "clickwrapTemplateVersion": 1,
    "clickwrapTemplateVersionMinor": 0,
    "status": "DECLINED",
    "lastStatusUpdate": "2026-03-20T08:11:42Z",
    "tags": [
      "optional"
    ],
    "effectiveAt": "2026-03-10T12:00:00Z",
    "mustAcceptBy": null,
    "reAcceptanceRequired": false
  },
  {
    "clickwrapTemplateId": "123e4567-e89b-12d3-a456-426614174000",
    "clickwrapTemplateName": "Privacy Policy",
    "clickwrapEventId": null,
    "clickwrapTemplateVersion": 1,
    "clickwrapTemplateVersionMinor": 3,
    "status": "NO_DATA",
    "lastStatusUpdate": null,
    "tags": [],
    "effectiveAt": "2026-03-01T00:00:00Z",
    "mustAcceptBy": "2026-04-01T00:00:00Z",
    "reAcceptanceRequired": false
  }
]

Get consent status for end user

Returns an array of clickwrap template statuses for a specific end user, showing whether they have accepted, declined, or have pending actions for each template.

Use this to gate flows, build compliance dashboards, or audit consent without triggering the clickwrap dialog.

Authenticated — requires X-APP-ID and X-APP-KEY headers.

Status is returned only for the latest major version. Actions on older major versions result in NO_DATA with a null timestamp.

GET

clickwraps

{endUserId}

status

cURL

curl -X GET \
  -H "X-APP-ID: YOUR_APP_ID" \
  -H "X-APP-KEY: YOUR_APP_KEY" \
  "https://api.clickterm.com/public-client/v1/clickwraps/user-123/status"

[
  {
    "clickwrapTemplateId": "987e6543-e21b-45d3-b321-426614174999",
    "clickwrapTemplateName": "Terms of Service",
    "clickwrapEventId": "d3e7b2f2-6ce9-4e49-8de5-2f73451d9c7b",
    "clickwrapTemplateVersion": 2,
    "clickwrapTemplateVersionMinor": 0,
    "status": "ACCEPTED",
    "lastStatusUpdate": "2026-03-18T10:22:14Z",
    "tags": [
      "registration",
      "customer_only"
    ],
    "effectiveAt": "2026-03-15T14:00:00Z",
    "mustAcceptBy": null,
    "reAcceptanceRequired": true
  },
  {
    "clickwrapTemplateId": "456e7890-e21b-45d3-b321-426614174111",
    "clickwrapTemplateName": "Marketing Consent",
    "clickwrapEventId": "6a97e7d9-1b70-4d0a-944c-c9ce989a6a83",
    "clickwrapTemplateVersion": 1,
    "clickwrapTemplateVersionMinor": 0,
    "status": "DECLINED",
    "lastStatusUpdate": "2026-03-20T08:11:42Z",
    "tags": [
      "optional"
    ],
    "effectiveAt": "2026-03-10T12:00:00Z",
    "mustAcceptBy": null,
    "reAcceptanceRequired": false
  },
  {
    "clickwrapTemplateId": "123e4567-e89b-12d3-a456-426614174000",
    "clickwrapTemplateName": "Privacy Policy",
    "clickwrapEventId": null,
    "clickwrapTemplateVersion": 1,
    "clickwrapTemplateVersionMinor": 3,
    "status": "NO_DATA",
    "lastStatusUpdate": null,
    "tags": [],
    "effectiveAt": "2026-03-01T00:00:00Z",
    "mustAcceptBy": "2026-04-01T00:00:00Z",
    "reAcceptanceRequired": false
  }
]

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

clickwrapEventId

string<uuid> | null

Identifier of the related clickwrap event. Present when the status is UNVERIFIED, PENDING, ACCEPTED, or DECLINED. When the status is ACCEPTED, this value can be used directly with the certificate and agreement download endpoints. Null when the status is NO_DATA or OVERDUE.

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