| Module | Services | Data types | Constants |
|---|---|---|---|
| consent | Consent Jurisdiction |
For a recognised/successfully parsed consent, a value of TCF, CCPA, or AUS indicates which jurisdiction the consent is for. OTHER marks a consent that was not successfully parsed into one of these formats. - TCF is Europe’s [Transparency & Consent Framework](https://iabeurope.eu/transparency-consent-framework/). - CCPA is the [California Consumer Privacy Act](https://oag.ca.gov/privacy/ccpa), deprecated in the USA after 1st of May 2024 - USNAT is the [US-wide Consent Framework](https://www.iab.com/news/multi-state-privacy-agreement-mspa/). It replaced our implementation of the CCPA in the USA. - AUS is for australian consents, using a version of the CCPA.
TCF | 1 | |
CCPA | 2 | |
AUS | 3 | |
OTHER | 4 | |
USNAT | 5 |
| Key | Field | Type | Description | Requiredness | Default value |
|---|---|---|---|---|---|
| 1 | jurisdiction | Jurisdiction | The jurisdiction is a tag for the consent data: TCF, CCPA, USNAT, or AUS if the consent has been successfully parsed in one of those formats; or OTHER otherwise. | required | |
| 2 | consentData | string | If the jurisdiction is TCF, CCPA, USNAT, or AUS, consentData contains a successfully interpreted consent value the corresponding type (for TCF this is a base-64-encoded consent string; for USNAT, CCPA, and AUS it’s either the string "true" or "false" – where "true" means the user has given their consent (or not withdrawn their consent)). If the jurisdiction is OTHER, then consentData contains the unparsed consent data, in the format key1:value1,key2:value2,…. | required | |
| 3 | consentUUID | string | consentUUID is an identifier for the consent, for debugging. | optional | |
| 4 | cmpVersion | string | cmp version for debugging | optional |
A user’s recorded tracking consent. Because the consent data can come in different formats from different sources, the jurisdiction field determines the format of consentData.