Usercentrics

Usercentrics Controller API

The Controller API from Usercentrics — 1 operation(s) for controller.

GitHub OpenAPI

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-controller-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/

OpenAPI Specification

usercentrics-controller-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Usercentrics App CMP SDK CCPA Controller API
  description: 'Public method surface of the Usercentrics App CMP SDK across iOS, tvOS, Android, AndroidTV,

    Unity, Flutter, and React Native. The SDK is delivered as a client-side library; this OpenAPI

    document models the SDK call surface as logical HTTP operations so that lifecycle, capability,

    and Naftiko tooling can reason about it uniformly with other Usercentrics surfaces.


    Reference: https://docs.usercentrics.com/cmp_in_app_sdk/latest/api/api_documentation/

    '
  version: 1.0.0
  contact:
    name: Usercentrics Documentation
    url: https://docs.usercentrics.com/cmp_in_app_sdk/latest/
servers:
- url: sdk://usercentrics.app
  description: In-process App CMP SDK (logical URL).
tags:
- name: Controller
paths:
  /controller-id:
    get:
      tags:
      - Controller
      summary: Get Controller ID
      description: Return the Usercentrics controller ID identifying the current user's consent record.
      operationId: getControllerId
      responses:
        '200':
          description: Controller ID returned.