consent-api

Record Consent

Record a decision the business collected through its own channel (a mobile app, a call centre, a paper form). It goes into the same tamper-evident chain as decisions made on the banner or the consent page. The business is vouching for it -- OpenProof records WHAT was reported and WHEN it was reported.

Send an Idempotency-Key header (any unique string, up to 100 characters) so a retry after a timeout cannot record the decision twice: the same key with the same request returns the original record (200); the same key with a different request is a 409.

post/v1/consent/record

Request

  • Base URL: https://api.openproof.io (the document declares no server; this is the origin it was published from)
  • URL: https://api.openproof.io/v1/consent/record
  • Auth: none declared. Required headers: X-OpenProof-Api-Key

Headers

Idempotency-Keystring nullable
X-OpenProof-Api-Keystring required

Request body

identifierstring required
categorystring required
statusstring required
sourcestring nullable
referencestring nullable
notice_versioninteger nullable
languagestring nullable
guardian_emailstring nullable

Response

Successful Response

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.