Didomi - Developers documentation
  • Introduction
  • SDKs
    • Introduction
    • Web SDK
      • Getting started
      • Tags and vendors management
        • Tags management
          • Events & Variables
            • Deprecated
            • Custom events
          • Tag managers
            • Adobe Launch/DTM
            • Eulerian
            • Google Tag Manager
              • Configure the Didomi / GTM integration
              • Didomi's GTM template
            • Tealium
            • Other tag managers
        • Custom Didomi <script> tags
        • Third-party integrations
          • Google Ad Manager / AdSense
            • GDPR via Non-Personalized Ads
              • Share consent and load/refresh ads
              • Share consent without loading or refreshing ads
            • US states laws
          • Google Consent Mode V2
          • Kameleoon
          • Piano Analytics (AT Internet)
          • Prebid
            • GDPR via IAB TCF
            • US states laws
          • Salesforce DMP (Krux)
        • IAB frameworks
        • Programmatic API
      • Configuration
        • Bots (SEO & Performance tools)
        • Configuration by URL
        • Cookies and storage
        • Custom domains for events
        • Notice
          • Behavior
          • Interactions
          • Look and feel
        • Preferences
        • Theme
      • AB tests
      • Custom domain
        • Domain delegation
        • Reverse proxy
      • Share consents between domains
      • Share consents across devices
      • Pass user choices in query string
      • Serve Didomi assets from your domain
      • Reference
        • API
          • Deprecated
        • Events
      • Performance
      • Versions
    • Mobile and TV SDKs
      • Android and Android TV
        • Setup
        • Logging
        • Reference
          • API
            • Deprecated
          • Events
        • Versions
      • iOS and tvOS
        • Setup
        • Logging
        • App Tracking Transparency (iOS 14.5+)
        • Reference
          • API
            • Deprecated
          • Events
        • Versions
      • Unity
        • Setup
        • Reference
        • Versions
        • Troubleshooting
      • React Native
        • Setup
        • Reference
          • Deprecated
        • Versions
      • Flutter
        • Setup
        • Reference
        • Versions
      • Consent notice
        • Getting started
        • Customize the notice
        • Customize the preferences popup
        • Customize the theme & UI
        • Load notice by ID
      • Third-party SDKs
      • Share consents across devices
      • Share consent with WebViews
      • Google Consent Mode v2
      • FAQ
    • AMP SDK
      • Blocking Behaviors
        • Load immediately on page load
        • Load only after consent (positive or negative)
        • Load only after positive consent
      • Consent status for vendors
    • Help & Support
  • API
    • Introduction
      • Authentication
      • Errors
      • Pagination
      • Filters
      • Caching
      • Rate limiting
      • Quotas
      • Translations
    • Data Manager
      • Regulations
      • Configuration Tree
      • Purposes
        • Purposes & Vendors Numerical IDs
      • Preferences Library
      • User Rights
    • Widgets
      • Consent notices
        • Notices
        • Configurations
        • Multi-Regulation Configurations
          • Migration of Existing Notices and API Updates
        • Deployments
        • Tutorials
          • Create and publish a consent notice
          • Create and publish a multi-regulation consent notice
      • Privacy widgets
        • Create a widget
        • Retrieve widgets
        • Edit a widget
          • Content & Design
            • Themes & Shapes
            • Components
              • auth
              • dsar_form
              • footer
              • header
              • preference
              • preference_value
              • save
              • section
              • sections
            • Options
          • Purposes & preferences
          • Settings
        • Deploy a Widget
          • Use your own subdomain
          • Use your own domain
          • Implement an embeddable widget on your website
        • Authentication
          • Manage authentication providers
          • Authenticate your end-user
        • Archive a widget
        • Headless widgets
          • Public Methods
          • Custom elements
          • Custom events
          • Event listeners
        • Tutorial
          • Launch a Preference Center from a mobile app
    • Compliance Reports
      • Properties
      • Reports
      • CSV format reference
      • Websites
    • Consents and Preferences
      • Events
        • Generate IAB TCF consent string
      • Links
      • Proofs
      • Tokens
      • Secrets
      • Users
      • Tutorial
        • Collect and operate data
    • Privacy Requests
      • Requests
      • Notes
      • Links
      • Emails
  • Integrations
    • Introduction
      • Quotas
    • Generic integrations
      • Batch export
        • Destinations
          • AWS S3 Bucket (owned by Didomi)
          • GCP Storage Bucket
        • Exported data
          • Notices consents
        • Logs
      • Webhooks
      • Batch import
      • Analytics export
        • Destinations
          • AWS S3 Bucket (owned by Didomi)
          • GCP Storage Bucket
    • Third-party apps
      • CMP integrations
        • Didomi-mParticle integration for your CMP
        • Deploy Didomi’s SDK for your Adobe Commerce website
      • Preference Management Platform integrations
        • Actito
        • Adobe Campaign Classic
        • Adobe Experience Cloud
        • Adobe Marketo Engage
        • Adobe Source Connector
        • Braze
        • Dotdigital
        • Hubspot
        • Mailchimp
        • Microsoft Dynamics 365
        • Salesforce Marketing Cloud
        • Salesforce Sales & Service Cloud
        • Selligent
        • Brevo (ex Sendinblue)
    • Tutorials
      • Configure a HTTP webhook
      • Configure a batch export
      • Configure an analytics export
    • Emailing
      • Configurations
        • Actito Email
        • Actito SMS
        • Adobe Campaign Classic
        • Adobe Campaign Standard
      • Emails
        • Templates
        • Manage your templates
Powered by GitBook
On this page
  • Supported Regulations
  • Compliance API
  • Regulations available
  • Get available regulations and related information
  • Regulation schema
  1. API
  2. Data Manager

Regulations

Supported Regulations

The Didomi API and SDK currently provide consent notices for the regulations outlined in the following table:

Regulation
Regulation ID
Default Country/Region

General Data Protection Regulation (GDPR)

gdpr

AD, AT, BE, BG, CY, CZ, DE, DK, EE, ES, FI, FR, GB, GF, GG, GI, GP, GR, HR, HU, IE, IS, IT, JE, LI, LT, LU, LV, MC, MF, MQ, MT, NL, NO, PL, PT, RE, RO, SE, SI, SK, SM, VA, YT

California Privacy Rights Act (CPRA)

cpra

US_CA

Colorado Privacy Act (CPA)

cpa

US_CO

Connecticut Data Privacy Act (CTDPA)

ctdpa

US_CT

Virginia Consumer Data Protection Act (VCDPA)

vcdpa

US_VA

Regulation ID refers to the internal identifier or acronym utilized within the SDK configuration objects.

Default Country/Region column lists geo-location codes (based on ISO country/region standards) which are employed to automatically determine the display of a specific regulation based on the visitor's location.

For further information on using the API to handle multi-regulation notices and their associated configuration objects, please refer to the Multi-Regulation Configurations guide.

Compliance API

The Compliance API is designed to inform you about the various privacy regulations supported by Didomi.

It offers detailed insights into each privacy law, including its status, full name, and the legal frameworks it supports.

Additionally, the API provides information about the countries and regions where each regulation is applicable, making it a comprehensive resource for understanding global compliance requirements.

Regulations available

Regulation
ID

General Data Protection Regulation (GDPR)

gdpr

California Privacy Rights Act (CPRA)

cpra

Colorado Privacy Act (CPA)

cpa

Connecticut Data Privacy Act (CTDPA)

ctdpa

Virginia Consumer Data Protection Act (VCDPA)

vcdpa

Get available regulations and related information

To retrieve the regulations supported by Didomi, send a GET request on /compliance/v1/regulations?$search[releaseStatus]=stable.

Consents must only be collected for regulations that are supported.

GET https://api.didomi.io/compliance/v1/regulations?$search[releaseStatus]=stable

Response

{
    "data": [
				{
            "id": "gdpr",
            "archived": false,
	    "geos": [
		{
                    "country": {
                        "id": "FR",
                        "name": "France"
                    },
                    "region": {
                        "id": "*",
                        "name": "All"
                    }
                },
	        ...
	    ],
	    "name": "General Data Protection Regulation",
            "frameworks": [
                "iab"
            ],
            "platforms": [
                "amp",
                "app",
                "ctv",
                "web"
            ],
            "regulation_type": "optin",
            "release_status": "stable",
				},
        {
            "id": "cpa",
            "archived": false,
	    "geos": [
                {
                    "country": {
                        "id": "US",
                        "name": "United States"
                    },
                    "region": {
                        "id": "CO",
                        "name": "Colorado"
                    }
                }
            ],
            "name": "Colorado Privacy Act",
	    "release_status": "beta"
        },
	...
    ]
}

Regulation schema

The full schema of Regulations is as follows.


{
   /**
    * A unique identifier
    */      
    "id": "String",
    
   /**
    * Whether this regulation is archived or not
    */      
    "archived": Boolean,
    
   /**
    * Regulations geolocations that the regulation 
    * is associated with (jurisdiction)
    */      
    "geos": [
        {
            "country": {
            
               /**
                * Contains the 2-letter ISO 3166-1 
                * alpha-2 country codes
                */              
                "id": "String",
                
               /**
                * Country name
                */                  
                "name": "String"
            },
            "region": {
            
                /**
                 * Contains a code (up to three characters) 
                 * that represent the viewer's region. 
                 * The region is the first-level subdivision 
                 * (the broadest or least specific) 
                 * of the ISO 3166-2 code.
                 */              
                "id": "String",
                
                /**
                 * Region name that corresponds to the code
                 */                  
                "name": "String"
            }
        }
    ],
    
   /**
    * The name of the regulation
    */      
    "name": "String",
    
   /**
    * The frameworks supported by the regulation
    */      
    "frameworks": [],
    
   /**
    * The platforms supported by the regulation
    * Are supported: amp, app, ctv, web
    */      
    "platforms": [
        "String"
    ],
    
   /**
    * The regulation type associated with the group
    * Possible values: disclose, mixed, optin, optout
    */      
    "regulation_type": "String",
    
   /**
    * The release status of the regulation. 
    * Only regulations in a stable status 
    * are intended to be used in production.
    * Possible status: stable, release-candidate, beta, alpha
    */      
    "release_status": "String",
    
   /**
    * User rights linked to the regulation
    */      
    "user_rights": []
},
PreviousData ManagerNextConfiguration Tree

Last updated 1 year ago