Docs

Quickstart

From zero to a recorded, proven consent, in five steps.

1. Sign into the console

Open the console and sign in. The first sign-in creates your organization automatically, with you as OWNER.

2. Create a site

In Sites & API keys → New site. Give it a name and a slug (lowercase, hyphens). Add a domain if you will use publishable keys (pk_) from the browser.

3. Create an API key

Same screen → New key. Choose secret (sk_, server) or publishable (pk_, browser, Origin-restricted) and the test or live environment. The full key is shown once — copy it.

4. Publish a purpose

In Purposes & statements → New purpose with a key (e.g. marketing_email) and a category. Edit the multi-locale legal text and publish it. All consent is recorded against a published version.

curl -X POST $API/v1/consent \
  -H "authorization: Bearer sk_test_…" \
  -H "content-type: application/json" \
  -H "idempotency-key: $(uuidgen)" \
  -d '{"subject":"email:you@example.com","purpose":"marketing_email","state":"GRANTED"}'

The response includes a receiptId. Read the state with GET /v1/subjects/email:you@example.com/consent and the purpose shows GRANTED. In the console, Consent vault → search email:you@example.com and open the timeline.

Want to try the API before wiring up a banner? Every /v1 endpoint is runnable straight from the API reference with your test key.
PreviousWhat Tripticonsent is