Usercentrics

Usercentrics Consent API

The Consent API from Usercentrics — 11 operation(s) for consent.

GitHub OpenAPI

Operations 11

GET /cmp-data Get CMP Data #
GET /consents Get Consents #
POST /consent/withdraw Withdraw Consent #
POST /consent/submit-custom Submit Custom Consent #
GET /consent/state Get Consent State #
GET /scripts/get Get Script #
POST /scripts/run Run Scripts #
POST /ui/accept-all Accept All Services #
POST /ui/deny-all Deny All Services #
POST /ui/update-services Update Service Consents #
GET /ui/services-base-info Get Services Base Info #

Documentation

📖
Documentation
https://docs.usercentrics.com/cmp_in_app_sdk/latest/
📖
APIReference
https://docs.usercentrics.com/cmp_in_app_sdk/latest/api/api_documentation/
📖
Documentation
https://docs.usercentrics.com/cmp_v3/latest/
📖
Documentation
https://www.cookiebot.com/en/developer/
📖
Documentation
https://www.cookiebot.com/en/help/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/usercentrics/refs/heads/main/openapi/usercentrics-consent-api-openapi.yml

Other Resources

🔗
SDKs
https://github.com/Usercentrics/flutter-sdk
🔗
SDKs
https://github.com/Usercentrics/react-native-sdk
🔗
SDKs
https://github.com/Usercentrics/ios-sample
🔗
SDKs
https://github.com/Usercentrics/android-sample
🔗
Support
https://support.cookiebot.com/hc/en-us/

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/usercentrics-consent-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

usercentrics-consent-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Usercentrics Consent API
  version: '1.0'
  description: 'Operations tagged Consent across 3 of this provider''s published API definitions: usercentrics-app-cmp-sdk-openapi.yml, usercentrics-cookiebot-cmp-openapi.yml, usercentrics-web-cmp-v3-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: sdk://usercentrics.app
  description: In-process App CMP SDK (logical URL).
- url: https://consent.cookiebot.com
  description: Cookiebot consent delivery CDN.
- url: https://app.usercentrics.eu
  description: Usercentrics CDN/control plane (EU).
tags:
- name: Consent
paths:
  /cmp-data:
    get:
      tags:
      - Consent
      summary: Get CMP Data
      description: Retrieve the active CMP configuration including service list, categories, and copy.
      operationId: getCmpData
      responses:
        '200':
          description: Active CMP configuration returned.
    servers:
    - url: sdk://usercentrics.app
      description: In-process App CMP SDK (logical URL).
  /consents:
    get:
      tags:
      - Consent
      summary: Get Consents
      description: Return the current per-service consent state stored on device.
      operationId: getConsents
      responses:
        '200':
          description: Per-service consent state returned.
    servers:
    - url: sdk://usercentrics.app
      description: In-process App CMP SDK (logical URL).
  /consent/withdraw:
    post:
      tags:
      - Consent
      summary: Withdraw Consent
      description: Withdraw all consent for the current user (Cookiebot.withdraw()).
      operationId: cookiebotWithdraw
      responses:
        '200':
          description: Consent withdrawn.
    servers:
    - url: https://consent.cookiebot.com
      description: Cookiebot consent delivery CDN.
  /consent/submit-custom:
    post:
      tags:
      - Consent
      summary: Submit Custom Consent
      description: Submit a custom consent decision (Cookiebot.submitCustomConsent).
      operationId: cookiebotSubmitCustomConsent
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                preferences:
                  type: boolean
                statistics:
                  type: boolean
                marketing:
                  type: boolean
      responses:
        '200':
          description: Custom consent submitted.
    servers:
    - url: https://consent.cookiebot.com
      description: Cookiebot consent delivery CDN.
  /consent/state:
    get:
      tags:
      - Consent
      summary: Get Consent State
      description: Read Cookiebot.consent (necessary, preferences, statistics, marketing) flags.
      operationId: cookiebotGetConsent
      responses:
        '200':
          description: Consent flags returned.
    servers:
    - url: https://consent.cookiebot.com
      description: Cookiebot consent delivery CDN.
  /scripts/get:
    get:
      tags:
      - Consent
      summary: Get Script
      description: Retrieve a script blocked by Cookiebot pending consent (Cookiebot.getScript).
      operationId: cookiebotGetScript
      responses:
        '200':
          description: Script retrieved.
    servers:
    - url: https://consent.cookiebot.com
      description: Cookiebot consent delivery CDN.
  /scripts/run:
    post:
      tags:
      - Consent
      summary: Run Scripts
      description: Execute scripts that have been gated on consent (Cookiebot.runScripts).
      operationId: cookiebotRunScripts
      responses:
        '200':
          description: Scripts executed.
    servers:
    - url: https://consent.cookiebot.com
      description: Cookiebot consent delivery CDN.
  /ui/accept-all:
    post:
      tags:
      - Consent
      summary: Accept All Services
      description: Grant consent for every configured service (UC_UI.acceptAllConsents).
      operationId: uiAcceptAll
      responses:
        '200':
          description: All consents granted.
    servers:
    - url: https://app.usercentrics.eu
      description: Usercentrics CDN/control plane (EU).
  /ui/deny-all:
    post:
      tags:
      - Consent
      summary: Deny All Services
      description: Deny consent for every configured service (UC_UI.denyAllConsents).
      operationId: uiDenyAll
      responses:
        '200':
          description: All consents denied.
    servers:
    - url: https://app.usercentrics.eu
      description: Usercentrics CDN/control plane (EU).
  /ui/update-services:
    post:
      tags:
      - Consent
      summary: Update Service Consents
      description: Update consent state for a specific list of services (UC_UI.updateServices).
      operationId: uiUpdateServices
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                services:
                  type: array
                  items:
                    type: object
                    properties:
                      id:
                        type: string
                      consent:
                        type: boolean
      responses:
        '200':
          description: Consent updated.
    servers:
    - url: https://app.usercentrics.eu
      description: Usercentrics CDN/control plane (EU).
  /ui/services-base-info:
    get:
      tags:
      - Consent
      summary: Get Services Base Info
      description: Return the configured services with current consent state.
      operationId: uiGetServicesBaseInfo
      responses:
        '200':
          description: Service list returned.
    servers:
    - url: https://app.usercentrics.eu
      description: Usercentrics CDN/control plane (EU).
x-refined-from:
- usercentrics-app-cmp-sdk-openapi.yml
- usercentrics-cookiebot-cmp-openapi.yml
- usercentrics-web-cmp-v3-openapi.yml