Consent Manager endpoints

The endpoints a Consent Manager registered with the Data Protection Board calls to send you consent and withdrawals, and the notifications it receives. Paths are relative to https://console.dpconsent.com/consent/sdk/v1/consent-managers. Setting one up is in Accept consent from a Consent Manager.

Shared rules#

Endpoints#

GET /schema#

The JSON Schemas of the contract, version 1.0. Public; no key. Cached for an hour.

{
  "version": "1.0",
  "schemas": {
    "artefact": { "$id": "urn:piedap-consent:piedap-cm-artefact/1.0" },
    "withdrawal": { "$id": "urn:piedap-consent:piedap-cm-withdrawal/1.0" },
    "notification": { "$id": "urn:piedap-consent:piedap-cm-notification/1.0" }
  },
  "signature": {
    "headers": ["X-Piedap-Event", "X-Piedap-Timestamp", "X-Piedap-Signature"],
    "algorithm": "HMAC-SHA256",
    "signedContent": "<X-Piedap-Timestamp>.<raw body>",
    "format": "sha256=<lower-case hex>"
  }
}

Each schema is shown here with its $id only.

POST /consents#

Records consent the person gave through the Consent Manager, through the same sealed write path as any other consent.

Response

201 for a new record, 200 for a change to the person's record on that form:

{
  "schemaVersion": "piedap-cm-artefact/1.0",
  "artefactId": "art_01JB7Q4X2M9K",
  "consentId": "cns_4f1c2a9b7e3d4c55a1b2c3d4e5f60718",
  "status": "PARTIAL",
  "purposes": [
    { "purposeKey": "offers-by-sms", "granted": true },
    { "purposeKey": "offers-by-email", "granted": false }
  ],
  "collectedOn": "2026-11-20T10:15:00.000Z",
  "expiresOn": "2027-11-20T00:00:00.000Z",
  "withdrawnOn": null,
  "proofHash": "9be2c4…",
  "test": false
}

The record's source is CONSENT_MANAGER. Its seal carries consentManagerId and consentManagerArtefactId, so a later change to either breaks the chain. Your endpoints get consent.granted or consent.updated as usual, with source and consentManager in data.

An artefact never replaces a newer answer on the form, or an erasure made after givenAt. It does replace a withdrawal made before givenAt: that is fresh consent.

GET /consents/{artefactId}#

The current state of what one artefact gave, in the shape above, so the Consent Manager can show the person. A record erased since, or an artefact of another Consent Manager, answers 404 ARTEFACT_NOT_FOUND.

POST /withdrawals#

Withdraws, through the normal withdrawal path, consent given through this Consent Manager. Your endpoints get consent.withdrawn and your Data Processors get stop tasks.

{
  "schemaVersion": "piedap-cm-withdrawal/1.0",
  "withdrawn": [
    {
      "artefactId": "art_01JB7Q4X2M9K",
      "consentId": "cns_4f1c2a9b7e3d4c55a1b2c3d4e5f60718",
      "withdrawnOn": "2026-11-21T09:00:00.412Z"
    }
  ],
  "alreadyWithdrawn": 0
}

withdrawnOn is when the withdrawal reached you. Each call is written to the audit log.

Notifications#

When a person changes or withdraws consent given through a Consent Manager anywhere else, it is told. That covers your website, your server, the console, an erasure, and an artefact from another Consent Manager taking over the record. A change it sent itself is not sent back.

A notification is a POST to its Notification address, signed with its signing secret exactly as webhooks are signed. Verify it as in Verify webhook signatures.

{
  "schemaVersion": "piedap-cm-notification/1.0",
  "id": "5c1e9a40-7b2d-4f3e-9a61-0d8c2b4f7e15",
  "type": "artefact.withdrawn",
  "createdOn": "2026-11-21T09:00:00.512Z",
  "artefactId": "art_01JB7Q4X2M9K",
  "consentId": "cns_4f1c2a9b7e3d4c55a1b2c3d4e5f60718",
  "status": "WITHDRAWN",
  "purposes": [
    { "purposeKey": "offers-by-sms", "granted": false },
    { "purposeKey": "offers-by-email", "granted": false }
  ],
  "changedOn": "2026-11-21T09:00:00.512Z",
  "withdrawnOn": "2026-11-21T09:00:00.412Z",
  "expiresOn": "2027-11-20T00:00:00.000Z",
  "test": false
}

The body names the artefact and the record, never the person. Any 2xx answer counts as delivered. Others are retried after 1 minute, 5 minutes, 30 minutes, 2 hours, 6 hours and 12 hours. A suspended Consent Manager, or one without an address, gets none.

consent_manager.notification_failed#

The webhook your endpoints get when a notification still failed after the last retry, so you can tell the Consent Manager another way. Send failed notifications again in the console queues them again.

Codes#

Sources and design choices#

No national interface between Consent Managers and Data Fiduciaries had been published by 9 October 2026. This contract is the product's own design, built on what these sources say:

These are the product's own choices:

• the artefact id, the field names and the versions
• naming the notice by form, and the three identifier types
• signed notifications and their retries
• withdrawals accepted from a suspended Consent Manager
• fresh consent accepted after an earlier withdrawal

Data items are not repeated in the artefact: the notice it names itemises them (rule 3(b)(i)).