consent-api

Check Consent

Returns the CURRENT status of the most recent decision for this principal + category, if any exists. identifier matches whatever was used to record consent for this principal -- an email (hosted consent page), a customer id (signed widget identity or the record API) or a device_id (embedded widget), since all are stored in the same principal_identifier field. category matches by NAME, case-insensitive, not by internal UUID -- a business's own backend code shouldn't need to hardcode OpenProof's category IDs.

allowed=False covers both an explicit rejection/withdrawal AND no record existing at all -- callers that need to distinguish "never asked" from "said no" should check status (null vs "rejected"/ "withdrawn"), not just allowed, since gating a real action on consent should default to false whenever there's any doubt.

get/v1/consent/check

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/check
  • Auth: none declared. Required headers: X-OpenProof-Api-Key

Query parameters

identifierstring required
categorystring required

Headers

X-OpenProof-Api-Keystring required

Response

Successful Response

unknown required

Changes

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