Usercentrics

Usercentrics Lifecycle API

The Lifecycle API from Usercentrics — 4 operation(s) for lifecycle.

GitHub OpenAPI

Operations 4

POST /configure Configure The SDK #
GET /is-ready Check Readiness #
POST /restore-user-session Restore User Session #
POST /reset Reset Consent State #

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-lifecycle-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-lifecycle-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-lifecycle-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Usercentrics App CMP SDK Lifecycle 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: Lifecycle
paths:
  /configure:
    post:
      tags:
      - Lifecycle
      summary: Configure The SDK
      description: Initialize the App CMP SDK with a Settings ID, runtime options, and ruleset.
      operationId: configureSdk
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                settingsId:
                  type: string
                ruleSetId:
                  type: string
                defaultLanguage:
                  type: string
                version:
                  type: string
                timeoutMillis:
                  type: integer
      responses:
        '200':
          description: SDK configured.
  /is-ready:
    get:
      tags:
      - Lifecycle
      summary: Check Readiness
      description: Returns once the SDK is fully initialized and ready to read or collect consent.
      operationId: isReady
      responses:
        '200':
          description: SDK ready.
  /restore-user-session:
    post:
      tags:
      - Lifecycle
      summary: Restore User Session
      description: Restore an existing consent session from a controller ID across devices.
      operationId: restoreUserSession
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                controllerId:
                  type: string
      responses:
        '200':
          description: Session restored.
  /reset:
    post:
      tags:
      - Lifecycle
      summary: Reset Consent State
      description: Clear all stored consent state for the current user.
      operationId: resetUser
      responses:
        '200':
          description: User reset.