Didomi

Didomi keys API

Manage API keys

GitHub OpenAPI

Operations 6

GET /keys Retrieve a list of API keys
POST /keys Create a new API key
GET /keys/{id} Retrieve an API key
PUT /keys/{id} Update an API key
PATCH /keys/{id} Patch an API key
DELETE /keys/{id} Delete an API key

Documentation

📖
Documentation
https://developers.didomi.io/api-and-platform/introduction
📖
Authentication
https://developers.didomi.io/api-and-platform/introduction/authentication
📖
RateLimits
https://developers.didomi.io/api-and-platform/introduction/rate-limiting

Specifications

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

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/didomi/refs/heads/main/json-schema/didomi-consent-event-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/didomi/refs/heads/main/json-schema/didomi-consent-notice-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/didomi/refs/heads/main/json-schema/didomi-privacy-request-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/didomi/refs/heads/main/json-structure/didomi-consent-event-structure.json

Other Resources

🔗
ErrorCodes
https://developers.didomi.io/api-and-platform/introduction/errors
🔗
Pagination
https://developers.didomi.io/api-and-platform/introduction/pagination
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/didomi/refs/heads/main/examples/didomi-consent-event-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/didomi/refs/heads/main/examples/didomi-consent-notice-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/didomi/refs/heads/main/examples/didomi-privacy-request-example.json

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/didomi-keys-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 email required.

GitHub Google LinkedIn

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

OpenAPI Specification

didomi-keys-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Didomi consents/events Keys API
  description: 'A REST API to communicate with the Didomi platform (<a href="https://api.didomi.io/v1/">https://api.didomi.io/v1/</a>)


    This is the complete specification of the API. A complete guide to authenticating and using the API is available on our <a href="https://developers.didomi.io/" target="_blank">Developers Portal</a>.


    All HTTP calls to the API require a valid JWT token. The token must be provided in an **Authorization** header with the value "Bearer <token>".

    Click on the Authorize button in the header of this page to provide a token before testing requests from this documentation.


    '
  version: '1.0'
servers:
- url: https://api.didomi.io/v1
  description: Didomi Platform API
security:
- bearer: []
tags:
- name: keys
  description: Manage API keys
paths:
  /keys:
    get:
      parameters:
      - description: Number of results to return
        in: query
        name: $limit
        schema:
          type: integer
      - description: Number of results to skip
        in: query
        name: $skip
        schema:
          type: integer
      - description: Property to sort results
        in: query
        name: $sort
        style: deepObject
        schema:
          type: object
      - description: Query parameters to filter
        in: query
        name: filter
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/keys'
      responses:
        '200':
          description: A list of APIKey objects
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/keys'
      description: Returns a list of all API keys the user has access to
      summary: Retrieve a list of API keys
      tags:
      - keys
      security:
      - bearer: []
    post:
      parameters:
      - name: key
        in: body
        description: API key
        required: true
        schema:
          $ref: '#/components/schemas/keys-input-create'
      responses:
        '200':
          description: The created APIKey object
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: Unique ID of the API key
                  organization_id:
                    type: string
                    description: ID of the organization that owns the API key
                  created_at:
                    type: string
                    description: Creation date of the API key (ISO8601)
                  enabled:
                    type: boolean
                    description: Status of the API key. A disabled API key cannot be used for obtaining a token. Already issued tokens remain valid until their expiration.
                  secret:
                    type: string
                    description: Secret of the API key
      description: Create a new API key that can be used for authenticating HTTP requests to the Didomi API
      summary: Create a new API key
      tags:
      - keys
      security: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/keys'
  /keys/{id}:
    get:
      parameters:
      - name: id
        in: path
        description: The ID of the API key to retrieve
        required: true
        schema:
          type: string
      responses:
        '200':
          description: An APIKey object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/keys'
      description: Returns a single API key with the given ID
      summary: Retrieve an API key
      tags:
      - keys
      security:
      - bearer: []
    put:
      parameters:
      - name: id
        in: path
        description: The ID of the API key to update
        required: true
        schema:
          type: string
      - name: key
        in: body
        description: The new API key data
        required: true
        schema:
          $ref: '#/components/schemas/keys-input-update'
      responses:
        '200':
          description: The updated APIKey object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/keys'
      description: Update an existing API key
      summary: Update an API key
      tags:
      - keys
      security:
      - bearer: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/keys'
    patch:
      parameters:
      - name: id
        in: path
        description: The ID of the API key to patch
        required: true
        schema:
          type: string
      - name: key
        in: body
        description: The new API key data
        required: true
        schema:
          $ref: '#/components/schemas/keys-input-update'
      responses:
        '200':
          description: The patched APIKey object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/keys'
      description: Patch an existing API key
      summary: Patch an API key
      tags:
      - keys
      security:
      - bearer: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/keys'
    delete:
      parameters:
      - name: id
        in: path
        description: The ID of the API key to delete
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The deleted APIKey object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/keys'
      description: Delete an existing API key
      summary: Delete an API key
      tags:
      - keys
      security:
      - bearer: []
components:
  schemas:
    keys-input-create:
      type: object
      title: APIKeyInputCreate
      properties:
        organization_id:
          type: string
          description: ID of the organization that owns the API key
        name:
          type: string
          description: Unique name to identify this key like the app or team that will be using it, or what it will be used for
        description:
          type: string
          description: Description of the API key
        is_internal:
          type: boolean
          description: Marks an API key as internal. These keys are managed by Didomi. Internal keys are excluded from list results unless explicitly requested.
    keys:
      type: object
      title: APIKey
      description: An API key allows machine-to-machine authentication and authorization
      properties:
        id:
          type: string
          description: Unique ID of the API key
        name:
          type: string
          description: Name of the API key to help identify it. This could be the name of the app or team that will be using it, or a short description of what the key will be used for
        description:
          type: string
          description: Description of the API key
        organization_id:
          type: string
          description: ID of the organization that owns the API key
        created_at:
          type: string
          description: Creation date of the API key (ISO8601)
        enabled:
          type: boolean
          description: Status of the API key. A disabled API key cannot be used for obtaining a token. Already issued tokens remain valid until their expiration.
        is_internal:
          type: boolean
          description: Marks an API key as internal. These keys are managed by Didomi. Internal keys are excluded from list results unless explicitly requested.
    keys-input-update:
      type: object
      title: APIKeyInputUpdate
      properties:
        name:
          type: string
          description: Unique name to identify this key like the app or team that will be using it, or what it will be used for
        description:
          type: string
          description: Description of the API key
        enabled:
          type: boolean
          description: Status of the API key. A disabled API key cannot be used for obtaining a token. Already issued tokens remain valid until their expiration.
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http