Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.clickterm.com/llms.txt

Use this file to discover all available pages before exploring further.

The ClickTerm Public Client API lets you integrate legally-binding consent management into your application. Use it alongside the ClickTerm Web SDK or Android SDK.

​
Base URL

https://api.clickterm.com/public-client/v1

​
Authentication

All API endpoints require your App ID and App Key, passed as HTTP headers: 
X-APP-ID: your_app_id
X-APP-KEY: your_app_key
Get these credentials from the Integrations page in the ClickTerm Dashboard.
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.

​
Request format

  • Content type: application/json
  • All timestamps are in UTC, ISO-8601 format (e.g., 2026-03-23T14:30:00Z)
  • UUIDs are standard v4 format

​
Response format

Most responses return JSON, while some return a PDF file. Error responses include an HTTP status code and a message describing the issue.

​
Billing

  • Free requests: ClicktermDialog.show() (SDK) and GET endpoints are not billed
  • Billed requests: POST /clickwrap/verify — each verification counts toward your usage

​
Endpoints

MethodEndpointDescription
POST/clickwrap/verifyVerify a Signature and create a clickwrap event
GET/clickwrap-eventsList verified clickwrap events with filters and cursor pagination
GET/clickwrap-events/{id}/detailsGet event details
GET/clickwrap-events/{id}/certificateDownload Certificate of Acceptance (PDF)
GET/clickwrap-events/{id}/agreementDownload Clickwrap Agreement (PDF)
GET/clickwraps/{endUserId}/statusGet consent status for an end user
GET/clickwrap-templatesList enabled templates with effective versions