Consenti Documentation
Consenti is an open-source, GDPR-compliant cookie consent and consent management platform. The UI widget (@consenti/ui) is the core — install it and you have a fully working consent banner with zero dependencies, no backend required. Consent is stored in a signed browser cookie. That's all most projects need.
The backend module (@consenti/api) is entirely optional. Add it if you need server-side consent records, audit logs, or the built-in admin dashboard. The UI widget also integrates with any custom REST API you already run — you don't have to use the Consenti backend at all.
Getting Started
Install Consenti and set up your first consent banner in under 5 minutes.
UI Widget
Complete reference for @consenti/ui — config, events, methods, themes, and framework adapters.
Backend API
Reference for @consenti/api — storage adapters, admin dashboard, RBAC, and REST endpoints.
Compliance
GDPR, CCPA, TCF v2.2, COPPA — how Consenti meets each regulation and what you need to configure.
Plugins
Extend the backend with BigQuery, Segment, Snowflake, webhooks, and community plugins.
Choose your setup
| Package | What it does | When you need it |
|---|---|---|
@consenti/ui | Browser widget — banner, modal, GTM, GPC, i18n, signed cookie storage | Always — this is the core package |
@consenti/api | Node.js backend — server-side consent records, admin dashboard, REST API | Optional — only if you need audit logs or the dashboard |
The UI widget can also POST consent to any existing API endpoint via the api.baseUrl config option — it is not tied to @consenti/api.
Prerequisites
- Browser: ES2020+ (Chrome 80+, Firefox 74+, Safari 13.1+) — for the UI widget
- npm 10 or later (or any npm-compatible package manager)
- TypeScript 5.8+ recommended (strict mode)
- Node.js 24 LTS or later — only required if using
@consenti/api