> For the complete documentation index, see [llms.txt](https://developers.didomi.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.didomi.io/api-and-platform/consents.md).

# Consents and Preferences

{% hint style="success" %}
The Consents API is subject to separate pricing from the Didomi Consent Management (CMP) and Preferences products. Contact your Custom Success Manager or Account Manager for more information
{% endhint %}

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

* [Terminology](#terminology)
* [Entities and endpoints](#entities-and-endpoints)

***

### Terminology

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

<table><thead><tr><th width="165">Term</th><th>Description</th></tr></thead><tbody><tr><td>User</td><td><p>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.</p><p>An end-user is associated with a set of Didomi user IDs:</p><ul><li><strong>user ID (UID)</strong> - 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</li><li><strong>organization user ID (OUID)</strong> - 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.</li></ul></td></tr><tr><td>Consents</td><td>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.</td></tr><tr><td>Preferences</td><td><p>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.</p><p>Additionally, preferences are always associated with a specific purpose. For example:</p><ul><li>The "cookies" purpose can be broken down into mulitple preference categories (e.g. marketing, analytics, essential, etc...)</li><li>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.)<br></li></ul></td></tr></tbody></table>

### Entities and endpoints

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

<table><thead><tr><th width="143">Entities</th><th>Description</th></tr></thead><tbody><tr><td><a href="/api-and-platform/consents/events.md">Events</a></td><td>Consents given by end-users</td></tr><tr><td><a href="/api-and-platform/consents/links.md">Links</a></td><td>Pre-authenticated URL that creates a consent event when it gets accessed from a browser</td></tr><tr><td><a href="/api-and-platform/consents/proofs.md">Proofs</a></td><td>Proofs of consent associated with consent events</td></tr><tr><td><a href="/api-and-platform/consents/secrets.md">Secrets</a></td><td>Secrets used for authenticating public requests</td></tr><tr><td><a href="/api-and-platform/consents/users.md">Users</a></td><td>JWT tokens allowing end-users to access and update their consent data</td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://developers.didomi.io/api-and-platform/consents.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.