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 application 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 application 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 on the OneTrust application, 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. We strongly recommend 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.

• The hostname in the URL will have privacyportal preceding the environment name, as shown in the following examples:

  Example URLs

  • https://privacyportal.onetrust.com/request/v1/consentreceipts

  • https://privacyportal-eu.onetrust.com/request/v1/consentreceipts

  • https://privacyportaluat.onetrust.com/request/v1/consentreceipts

  • https://privacyportaluateu.onetrust.com/request/v1/consentreceipts

  • https://privacyportaltrial.onetrust.com/request/v1/consentreceipts