ClickTerm Docs — Clickwrap Consent Management

Prerequisites: A verified clickwrap event with status ACCEPTED, and your App ID + App Key for server-side calls.

After a clickwrap event is verified with status ACCEPTED, ClickTerm generates downloadable PDF documents and stores the accepted content. Use these endpoints to retrieve them for legal records, compliance audits, or customer portals.

Don’t have a clickwrapEventId? See GET /clickwrap-events in the API reference.

Certificate of Acceptance

A digitally signed PDF that proves a specific user accepted a specific clickwrap version at a specific time. Includes user ID, timestamp, IP address, browser/device information. Stored in immutable storage at the time of event verification and serves as admissible proof in legal and compliance contexts.

Endpoint

GET https://api.clickterm.com/public-client/v1/clickwrap-events/{clickwrapEventId}/certificate

Parameter	Required	Description
`clickwrapEventId`	Yes	The identifier for the Clickwrap Event from which you want to retrieve the Certificate of Acceptance

HttpResponse<InputStream> response = Unirest.get(
    "https://api.clickterm.com/public-client/v1/clickwrap-events/" + clickwrapEventId + "/certificate")
  .header("X-APP-ID", "YOUR_APP_ID")
  .header("X-APP-KEY", "YOUR_APP_KEY")
  .asBinary();
Files.copy(response.getBody(), Path.of("certificate.pdf"));

const response = await fetch(
  `https://api.clickterm.com/public-client/v1/clickwrap-events/${eventId}/certificate`,
  {
    headers: {
      "X-APP-ID": process.env.CLICKTERM_APP_ID,
      "X-APP-KEY": process.env.CLICKTERM_APP_KEY,
    },
  }
);
const pdfBuffer = await response.arrayBuffer();

response = requests.get(
    f"https://api.clickterm.com/public-client/v1/clickwrap-events/{event_id}/certificate",
    headers={
        "X-APP-ID": CLICKTERM_APP_ID,
        "X-APP-KEY": CLICKTERM_APP_KEY,
    },
)
with open("certificate.pdf", "wb") as f:
    f.write(response.content)

Returns application/pdf. See the certificate endpoint reference for the full request and response details.

Clickwrap Agreement

The complete agreement PDF — includes the fully rendered clickwrap content (with all placeholders resolved) plus the Certificate of Acceptance appended at the end.

This is the recommended document for record-keeping. It contains both the agreement content and the certificate in a single PDF.

Endpoint

GET https://api.clickterm.com/public-client/v1/clickwrap-events/{clickwrapEventId}/agreement

Parameter	Required	Description
`clickwrapEventId`	Yes	The identifier for the Clickwrap Event from which you want to retrieve the Clickwrap Agreement

HttpResponse<InputStream> response = Unirest.get(
    "https://api.clickterm.com/public-client/v1/clickwrap-events/" + clickwrapEventId + "/agreement")
  .header("X-APP-ID", "YOUR_APP_ID")
  .header("X-APP-KEY", "YOUR_APP_KEY")
  .asBinary();
Files.copy(response.getBody(), Path.of("agreement.pdf"));

const response = await fetch(
  `https://api.clickterm.com/public-client/v1/clickwrap-events/${eventId}/agreement`,
  {
    headers: {
      "X-APP-ID": process.env.CLICKTERM_APP_ID,
      "X-APP-KEY": process.env.CLICKTERM_APP_KEY,
    },
  }
);
const pdfBuffer = await response.arrayBuffer();

response = requests.get(
    f"https://api.clickterm.com/public-client/v1/clickwrap-events/{event_id}/agreement",
    headers={
        "X-APP-ID": CLICKTERM_APP_ID,
        "X-APP-KEY": CLICKTERM_APP_KEY,
    },
)
with open("agreement.pdf", "wb") as f:
    f.write(response.content)

Returns application/pdf. See the agreement endpoint reference for the full request and response details.

Both endpoints require a verified event with status ACCEPTED. Events with status DECLINED, PENDING, or UNVERIFIED will return an error.

Get clickwrap event details

Retrieve full metadata for a clickwrap event after it has been verified. Use it to audit the clickwrap lifecycle, cross-check template versions, or drive downstream workflows.

Endpoint

GET https://api.clickterm.com/public-client/v1/clickwrap-events/{clickwrapEventId}/details

Parameter	Required	Description
`clickwrapEventId`	Yes	The identifier for the Clickwrap Event you want to inspect

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

const response = await fetch(
  `https://api.clickterm.com/public-client/v1/clickwrap-events/${eventId}/details`,
  {
    headers: {
      "X-APP-ID": process.env.CLICKTERM_APP_ID,
      "X-APP-KEY": process.env.CLICKTERM_APP_KEY,
    },
  }
);
const details = await response.json();

response = requests.get(
    f"https://api.clickterm.com/public-client/v1/clickwrap-events/{event_id}/details",
    headers={
        "X-APP-ID": CLICKTERM_APP_ID,
        "X-APP-KEY": CLICKTERM_APP_KEY,
    },
)
details = response.json()

Response

Returns the event’s full metadata: status, event and template IDs, template version, placeholder values, technical metadata, and lifecycle timestamps (presentedAt, actionAt, effectiveAt). See the event details reference for the full response schema and field descriptions.

Verifying a Signature

How to verify consent and create the event.

Checking consent status

Query whether a user has accepted the latest version.

API reference — List events

Reference for the clickwrap events listing endpoint.

API reference — Certificate

Full request/response details for the certificate endpoint.

API reference — Agreement

Full request/response details for the agreement endpoint.

Getting started

Integration guides

Web SDK

Android SDK

iOS SDK

React Native SDK

Resources

Downloading certificates & agreements

Certificate of Acceptance

Endpoint

Clickwrap Agreement

Endpoint

Get clickwrap event details

Endpoint

Response

Verifying a Signature

Checking consent status

API reference — List events

API reference — Certificate

API reference — Agreement

​Certificate of Acceptance

​Endpoint

​Clickwrap Agreement

​Endpoint

​Get clickwrap event details

​Endpoint

​Response

​Related

Verifying a Signature

Checking consent status

API reference — List events

API reference — Certificate

API reference — Agreement

Certificate of Acceptance

Endpoint

Clickwrap Agreement

Endpoint

Get clickwrap event details

Endpoint

Response

Related