Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Data Subjects V2

Delete Data Subjects

Use this API to delete data subjects. Deleting data subjects is a permanent action that should be exercised with caution.

🗒 Things to Know

  • Data subjects can be deleted using any of the following values at a time:
    • List of Identifiers
    • List of Data Subject Identifier GUIDs
    • Date range between fromCreatedDate and toCreatedDate (the timespan must be 24 hours or less).
    • Date range between fromInteractionDate and toInteractionDate (the timespan must be 24 hours or less).
  • When filtering by date range, created date and interaction date should be used separately. They should not be used at the same time.
  • Up to 999 data subject identifiers can be deleted per API call.
  • If a new data subject has to be deleted, it is recommended to wait at least 24 hours after its creation to ensure that all the data has been properly stored and synchronized before removal.
  • Requests will be processed asynchronously and can be monitored in the View Activity option in the Data Subject list view within the OneTrust Platform. If multiple calls are required, wait until each request processes before making another call.
  • By default, related data subject receipts and transactions will be removed from the database and will no longer appear in the OneTrust Platform UI after calling this API. However, the receipts and transactions can still be retrieved using the Get List of Receipts API. To maintain data subject receipts and transactions in the database and OneTrust Platform UI, set the retainReceiptsTransactions parameter to true.

👍

The Enable Data Subject Deletion setting must be enabled within Global Settings in the OneTrust application in order to use this API. For more information, see Deleting Data Subject Records.

delete/api/consent/v2/datasubjects

Request body

identifiersstring[]

The list of data subject identifiers for the data subjects.

dataSubjectGuidsstring[]

The list of GUIDS for the data subject identifiers.

fromCreatedDatestring date-time

The start of a date and time range for the data subject creation date.

toCreatedDatestring date-time

The end of a date and time range for the data subject creation date.

fromInteractionDatestring date-time

The start of a date and time range for the data subject interaction date.

toInteractionDatestring date-time

The end of a date and time range for the data subject interaction date.

retainReceiptsTransactionsboolean

This flag indicates whether receipts and transactions will be retained while deleting data subjects. When set to false, receipts and transactions are removed from the database and no longer appear in the OneTrust Platform UI. However, these receipts and transactions are not permanently deleted and can still be retrieved using the Get List of Receipts API.

removePIInfoboolean

This flag indicates whether to remove PII data element values from receipts and transactions. This parameter must be used in conjunction with the retainReceiptsTransactions parameter.

Example request

{
  "fromCreatedDate": "2022-02-01T12:33:40.000",
  "toCreatedDate": "2022-02-01T10:04:59.000",
  "fromInteractionDate": "2022-02-01T08:10:11.000",
  "toInteractionDate": "2022-02-02T08:10:11.000"
}

Response

Data Subjects deletion request processed successfully.

string required

Example response

"Deletion Request has been accepted"