For the complete documentation index, see llms.txt. This page is also available as Markdown.

Consents and Preferences

In this article, we provide an overview of some key concepts that will assist your organization in utilizing the Didomi Consents API.


Terminology

Some key teminology and concepts your organization should be familiar with before working with the Consents API are:

Term
Description

User

An end-user for which Didomi stores consent information. Additional metadata can also be associated with a user to track organization-specific information and apply specific rules.

An end-user is associated with a set of Didomi user IDs:

  • user ID (UID) - a Didomi generated user ID (A random UUID for end-users encountered on websites and an IDFA/ADID for end-users from mobile apps). If the end-user does not exist, it will be automatically created

  • organization user ID (OUID) - a unique user ID assigned by your organization that is used to link a Didomi end-user to your internal systems as well as resolve cross-platform IDs. It can be an email address, a phone number, a CRM ID, etc.

Consents

Consents, as required by regulations like GDPR and CPRA, represent end-user authorizations for specific purposes and vendors, including cookie usage, marketing communications, etc... The Didomi platform ensures adaptation and compliance with diverse global legal requirements, safeguarding user data and privacy across different privacy laws.

Preferences

Didomi defines preferences as the more granular choices expressed by the end-user with respect to expressed consents. Preferences are used to add more details to consents and store more granular choices from end-users. They can be associated with specific channels and metadata.

Additionally, preferences are always associated with a specific purpose. For example:

  • The "cookies" purpose can be broken down into mulitple preference categories (e.g. marketing, analytics, essential, etc...)

  • The "marketing communications" purpose can be broken down into different types of communication preferences (e.g. newsletter, special offers, etc.) and channel preferences (e.g. email, text, etc.)

Entities and endpoints

The concepts presented above are represented, in the Didomi platform, with the following entities:

Entities
Description

Consents given by end-users

Pre-authenticated URL that creates a consent event when it gets accessed from a browser

Proofs of consent associated with consent events

Secrets used for authenticating public requests

JWT tokens allowing end-users to access and update their consent data

Last updated