Ketch

Ketch Consent API

Retrieve and update visitor consent state.

Documentation GitHub OpenAPI

Operations 2

POST /consent/{organizationCode}/get Get the current consent state for a visitor #

POST /consent/{organizationCode}/update Set the consent state for a visitor #

Specifications

⚙

OpenAPI

https://raw.githubusercontent.com/api-evangelist/ketch-io/refs/heads/main/openapi/ketch-io-consent-api-openapi.yml

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/ketch-io-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

openapi: 3.2.0
info:
  title: Ketch Web Configuration Consent API
  description: 'REST endpoints that power Ketch consent collection, consent retrieval and

    update, data subject rights, and preference center QR codes. Endpoint paths

    and behavior are derived from the open source Ketch Web API SDK at

    https://github.com/ketch-sdk/ketch-web-api which is the canonical client for

    the Ketch global edge endpoints served from https://global.ketchcdn.com/web/v3.

    '
  version: 3.0.0
  contact:
    name: Ketch
    url: https://docs.ketch.com/
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
- url: https://global.ketchcdn.com/web/v3
  description: Ketch global edge production API.
tags:
- name: Consent
  description: Retrieve and update visitor consent state.
paths:
  /consent/{organizationCode}/get:
    parameters:
    - $ref: '#/components/parameters/OrganizationCode'
    post:
      tags:
      - Consent
      summary: Get the current consent state for a visitor
      operationId: getConsent
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetConsentRequest'
      responses:
        '200':
          description: The current consent state per purpose.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetConsentResponse'
  /consent/{organizationCode}/update:
    parameters:
    - $ref: '#/components/parameters/OrganizationCode'
    post:
      tags:
      - Consent
      summary: Set the consent state for a visitor
      operationId: setConsent
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetConsentRequest'
      responses:
        '204':
          description: Consent recorded.
components:
  schemas:
    SetConsentRequest:
      type: object
      required:
      - organizationCode
      - propertyCode
      - environmentCode
      - jurisdictionCode
      - identities
      - purposes
      properties:
        organizationCode:
          type: string
        propertyCode:
          type: string
        environmentCode:
          type: string
        jurisdictionCode:
          type: string
        identities:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/Identity'
        purposes:
          type: object
          additionalProperties:
            type: object
            properties:
              allowed:
                type: boolean
              legalBasisCode:
                type: string
        vendors:
          type: array
          items:
            type: string
        collectedAt:
          type: string
          format: date-time
    GetConsentRequest:
      type: object
      required:
      - organizationCode
      - propertyCode
      - environmentCode
      - jurisdictionCode
      - identities
      - purposes
      properties:
        organizationCode:
          type: string
        propertyCode:
          type: string
        environmentCode:
          type: string
        jurisdictionCode:
          type: string
        identities:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/Identity'
        purposes:
          type: object
          additionalProperties:
            type: object
            properties:
              legalBasisCode:
                type: string
    GetConsentResponse:
      type: object
      properties:
        purposes:
          type: object
          additionalProperties:
            type: object
            properties:
              allowed:
                type: boolean
              legalBasisCode:
                type: string
        vendors:
          type: array
          items:
            type: string
    Identity:
      type: object
      properties:
        identitySpace:
          type: string
          description: The identity space code (e.g. ketch_id).
        identityValue:
          type: string
  parameters:
    OrganizationCode:
      name: organizationCode
      in: path
      required: true
      schema:
        type: string