Transactions
Withdraw Data Subject's Consent
Use this API to withdraw a data subject's consent for a specific Purpose. The data subject identifier must be included either in the identifier query or header parameter, preferably passed in the header.
🗒 Things to Know
- This API is not designed to be used in synchronous workflows. As an alternative, the Create Consent Receipts API can be called.
get/api/consentmanager/v1/transactions/withdraw/purpose/{purposeId}
Path parameters
purposeIdstring uuid required
Example:550e8400-e29b-41d4-a716-446655440000
Unique Identifier for Purpose.
Query parameters
identifierstring
Example:user@example.com
Data Subject Identifier (prefer the header parameter).
Headers
identifierstring
Example:user@example.com
Data Subject Identifier (prefer the header parameter).
Response
OK - Successfully withdrew consent
Example response
{
"Status": "Consent withdrawn successfully"
}