Consent Docs
Open console

API reference

Every REST endpoint under /sdk/v1, every webhook event and every error code, for developers who call the API or receive its events.

For developers calling the REST API

Look up an endpoint, a webhook event or an error code here. This reference is for developers who call the REST API at https://console.dpconsent.com/consent/sdk/v1 or receive its webhooks. Every endpoint and every event follows one fixed layout. For the reasoning and the step-by-step tasks, read the Developer guide.

Start with#

  • Authentication for the two keys and the scopes.
  • Conventions for the base URL, the test flag and idempotency.
  • Errors for the error body and every error code.

Basics

  • AuthenticationHow a request carries a publishable or a secret key, which endpoints each key may call, the scopes a secret key holds and what a refused key returns.
  • ConventionsThe base URL, version, request and response shape, the test flag, idempotency keys, pagination and payload limits shared by every endpoint.
  • ErrorsThe two error body shapes, every HTTP status and every error code the API returns, what each one means, what to do about it and when to retry.
  • Rate limitsThe request budgets for each key and each address, the headers that report them and what the API returns when a limit is reached.

Endpoints

  • FormsThe endpoint that returns the published consent form for a visitor, with its parameters, response fields, examples and errors.
  • ConsentThe consent record object and the endpoints that record, read, change and withdraw one record, with parameters, examples and errors.
  • Consent checkThe endpoint that answers whether one person allows a purpose now, with parameters, the decision rule, responses, budgets and errors.
  • Email consentThe endpoints that start an email double opt-in and confirm it from the link, with parameters, examples, responses and errors.
  • PeopleThe endpoints that find, export, withdraw, erase and link everything held for one person, with parameters, examples, responses and errors.
  • Rights requestsThe endpoint that links a rights request to your identifier for the person, and the fields of the hosted request form and status page.
  • ActivityThe endpoint that reports a person's use of your service and restarts the inactivity erasure clock, with parameters, an example and errors.
  • Hosted page linksThe endpoints that issue a link to a person's consent portal and a one-click unsubscribe link, with parameters, examples and errors.
  • Runtime filesThe endpoints that serve the browser runtime, its manifest, exact builds and the installable SDK packages, and the calls the runtime makes itself.

Evidence and logs

  • ReceiptsThe endpoints that issue a signed consent receipt, publish the signing keys and check a receipt, with fields, examples and the offline check.
  • Audit logThe endpoint that pulls the project's audit log with a cursor, and every field of an audit entry, for SIEM collectors.

Campaigns, processors and Consent Managers

  • Notice campaignsThe endpoint that hands a notice campaign's links to your sender, and the hosted notice page each link opens, with responses, errors and limits.
  • Processor tasksThe endpoints that list stop and erase tasks for your Data Processors and record what each processor reported, with parameters, outcomes and codes.
  • Consent ManagersThe versioned contract a registered Consent Manager implements to send consent and withdrawals, review an artefact and receive signed notifications.

Webhook events

  • Webhook formatThe envelope every webhook delivery shares, its headers, how the signature is computed and checked, the retry schedule and the list of event types.
  • Consent eventsThe webhook events sent when a consent record is created, changed, withdrawn or expires, and when an import ends, with payload fields and examples.
  • People eventsThe webhook events sent when a person is erased, is about to be erased for inactivity, or makes or confirms a rights request, with payloads.
  • Other eventsThe webhook events for forms, region rules, anchors, scans, breaches, legal holds, usage and overdue processor tasks, with examples.
  • Law and project eventsThe webhook events for a changed DPDP rule set, a published privacy policy and a project that is closing or deleted, with examples.
  • Campaign eventsThe webhook events a notice campaign sends when a batch of links is ready, when a person withdraws on a link and when a day of answers is anchored.

↑↓ to move, Enter to open