Create Consent Receipts

Use this API to create consent receipts from a collection point. This API is used by all collection points and allows external applications to submit requests to store data subject consent transactions.

🗒

Things to Know

  • Each collection point must first be set up in the OneTrust Platform to generate a valid JWT, which must be present in the request payload. The JWT can be found on the Integrations tab of the Collection point details screen within the platform or can be retrieved by calling the Get Collection Point Token API.

  • Once the test parameter is set to true, reverting it to false is not possible. However, transitioning from test=false to test=true is supported. For more information on how to remove the test flag in the OneTrust Platform, see Managing Data Subject Records.

  • In most cases, further authorization is not required. However, additional information for setting up authenticated consent can be found here when needed.

  • Please avoid passing privacy notices for regular Custom API collection points. OneTrust strongly recommends using privacyNotices only for those enabled with dynamic configuration, as they allow you to gather information about all purposes.

  • When passing the purposes parameter, the version for PrivacyNotices will be used based on the consent date.

  • OneTrust recommends including no more than 10 purposes per consent receipt, with an absolute maximum of 20 purposes.

  • Please validate all inputs before sending data to a Custom API collection point. This API does not perform data type validation to ensure high performance and fast response times. However, invalid data will not be passed to the data subject.

Recipes
📥
Creating a Collection Point and Retrieving Consent
Open Recipe
🗃️
Consent Attachments: Upload, Attach, Download & Delete
Open Recipe
🖨️
Copy Existing Data Subject Profile to New Data Subject Profile
Open Recipe
🤝
Submit Consent Receipts & Retrieve Transactions
Open Recipe
🏃‍♂️
Real-Time Consent: Lightweight, Fast, and UI-Ready
Open Recipe
Language
URL