Skip to main content
Prerequisites: Your App ID + App Key for server-side calls, and at least one enabled template.
Use the consent status endpoint to check whether a specific end user has accepted, declined, or has no recorded interaction with your clickwrap templates. The response includes the status for all templates linked to your app — no template ID is needed.
You can view your templates in the ClickTerm UI or fetch them programmatically via the Get clickwrap templates endpoint.
GET https://api.clickterm.com/public-client/v1/clickwraps/{endUserId}/status

HttpResponse<String> response = Unirest.get(
    "https://api.clickterm.com/public-client/v1/clickwraps/" + endUserId + "/status")
  .header("X-APP-ID", "YOUR_APP_ID")
  .header("X-APP-KEY", "YOUR_APP_KEY")
  .asString();

​
Status values

StatusDescription
NO_DATANo recorded interaction with the clickwrap
PENDINGClickwrap presented but no action taken yet
UNVERIFIEDUser acted but the event hasn’t been verified by your server
ACCEPTEDUser accepted the terms (terminal — clickwrap not shown again until a new major version)
DECLINEDUser declined the terms
OVERDUEmustAcceptBy deadline passed with no interaction
The clickwrap is presented (or re-presented) when status is NO_DATA, PENDING, DECLINED, or OVERDUE.
This endpoint returns status only for the latest major version. See the API reference for the full response schema.

​
When to use this

  • Gate a flow — check if the user is compliant before allowing them to proceed
  • Build dashboards — show template tags, effective dates, and overdue states
  • Audit consent — answer “has this user accepted?” without triggering the clickwrap

Displaying a clickwrap

Present the agreement dialog to end users.

API reference

Full request/response schemas and field descriptions.