Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Ketch Consent API

Retrieve and update visitor consent state.

Ketch Consent API is one of 7 APIs that Ketch publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Consent. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 2 operations across 2 paths, and defines 4 schemas. It is described by OpenAPI 3.1.0, at version 3.0.0.

Requests are made against a single base URL, https://global.ketchcdn.com/web/v3.

2 operations 2 paths 4 schemas 2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.0.0
Base URL
https://global.ketchapi.com
Contact
License
Resource Areas
1

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 POST. Each is listed below with its method, path, parameters, and response codes.

Consent 2

Retrieve and update visitor consent state.

POST
/consent/{organizationCode}/get
Get the current consent state for a visitor
getConsent 1 param body → 200
POST
/consent/{organizationCode}/update
Set the consent state for a visitor
setConsent 1 param body → 204

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are SetConsentRequest (8 properties), GetConsentRequest (6 properties), Identity (2 properties), GetConsentResponse (2 properties). Each schema is shown below with its type and property counts.

GetConsentResponse
object
2 properties
SetConsentRequest
object
8 properties 6 required
GetConsentRequest
object
6 properties 6 required
Identity
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ketch-io-consent-api-openapi.yml Raw ↑

Other APIs Ketch publishes across the network.

Ketch API
Ketch Web SDK
Ketch Mobile SDKs
Ketch Configuration API
Ketch Preferences API
Ketch Rights API