` and `
`HTML tags. These can be sanitized depending on your formatting needs.","tags":["Purposes"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"parameters":[{"name":"isInternalOrg","in":"query","description":"Specifies if the Purpose is for internal organization use","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PurposeCreateDto"}}}},"responses":{"200":{"description":"OK - Successfully created purpose","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PurposeDetailsDto"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"string"}}}},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentPreferences-UniversalConsentPreferenceManag_OAUTH2":["CONSENT"]}]}},"/api/consentmanager/v1/purposes/{purposeGuid}":{"post":{"operationId":"createNewPurposeVersionUsingPOST","summary":"Create New Purpose Version","description":"Use this API to create a new version of an existing Purpose that is currently in **Active** status. A new version of the Purpose will be created in **Draft** status while the **Active** version of the Purpose will remain unchanged.\n\n> ๐ Things to Know\n> \n> - Once the Purpose is in **Draft** status, the [Update Purpose](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/editpurposeusingput) API can be used to edit the Purpose. Changes will only be visible once the new version of the Purpose is published.\n> - This API returns Purpose descriptions inside `` and `
`HTML tags. These can be sanitized depending on your formatting needs.","tags":["Purposes"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"parameters":[{"name":"purposeGuid","in":"path","description":"Unique identifier of the Purpose.","required":true,"schema":{"type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"}}],"responses":{"200":{"description":"OK - Successfully created new purpose version.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PurposeDetailsDto"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"string"}}}},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentPreferences-UniversalConsentPreferenceManag_OAUTH2":["CONSENT"]}]}},"/api/consentmanager/v1/purposes/{purposeId}":{"put":{"operationId":"editPurposeUsingPUT","summary":"Update Purpose","description":"Use this API to update an existing Purpose. Before calling this API, ensure that the Purpose is in **Draft** status. If the Purpose is in **Active** status, use the [Create New Purpose Version](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/createnewpurposeversionusingpost) API to create a new version of the Purpose.\n\n> ๐ Things to Know\n> \n> - This API returns Purpose descriptions inside `` and `
`HTML tags. These can be sanitized depending on your formatting needs.","tags":["Purposes"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"parameters":[{"name":"purposeId","in":"path","description":"The unique identifier of the Purpose to be edited","required":true,"schema":{"type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"}},{"name":"isInternalOrg","in":"query","description":"Specifies if the Purpose is for internal organization use","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_EditPurposeDto"}}}},"responses":{"200":{"description":"OK - Successfully updated purpose","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PurposeDetailsDto"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"string"}}}},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentPreferences-UniversalConsentPreferenceManag_OAUTH2":["CONSENT"]}]}},"/api/consentmanager/v1/purposes/{purposeId}/datasubjects":{"get":{"operationId":"getDataSubjectsForPurposesUsingGET","summary":"Get List of Data Subjects by Purpose","description":"Use this API to retrieve a list of data subjects by Purpose. The response will include details for each data subject such as the last transaction date, the transaction status for that Purpose, and Purpose Preferences they have interacted with.\n\n> ๐ Things to Know\n> \n> - This API can be used as an alternative to the [Get List of Data Subjects](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/getdatasubjectprofileusingget) API when data subject records for a specific Purpose are required.\n> - This API returns Purpose descriptions inside `` and `
`HTML tags. These can be sanitized depending on your formatting needs.","tags":["Purposes"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"parameters":[{"name":"purposeId","in":"path","description":"Unique identifier of the Purpose for which to retrieve data subjects","required":true,"schema":{"type":"string","format":"uuid"},"example":"550e8400-e29b-41d4-a716-446655440000"},{"name":"lastTransactionDate","in":"query","description":"Filter data subjects by last transaction date (ISO 8601 format: yyyy-MM-dd'T'HH:mm:ss)","required":false,"schema":{"type":"string","format":"date-time"},"example":"2025-10-15T14:30:00"},{"name":"transactionStatus","in":"query","description":"Filter data subjects by transaction status","required":false,"schema":{"type":"string","example":"ACTIVE","enum":["ACTIVE","WITHDRAWN","EXPIRED"]}},{"name":"includeCustomPreferences","in":"query","description":"Include custom preference options in the response","required":false,"schema":{"type":"boolean","default":false},"example":true}],"responses":{"200":{"description":"OK - Successfully retrieved data subjects for purpose","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PageDataSubjectForPurposeInformation"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"string"}}}},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentPreferences-UniversalConsentPreferenceManag_OAUTH2":["CONSENT","CONSENT_READ"]}]}},"/api/consentmanager/v1/purposes/{purposeId}/publish":{"put":{"operationId":"publishPurposeUsingPUT","summary":"Publish Purpose","description":"Use this API to publish a Purpose. Before calling this API, ensure that the Purpose is in **Draft** status. The Purpose will be published with version **1** and **Active** status.\n\n> ๐ Things to Know\n> \n> - The [Update Purpose](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/editpurposeusingput) API can be used to edit an existing Purpose before publishing.\n> - Once the Purpose is published, the previous version of the Purpose will be set to **Retired** status.\n> - This API returns Purpose descriptions inside `` and `
`HTML tags. These can be sanitized depending on your formatting needs.","tags":["Purposes"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"parameters":[{"name":"purposeId","in":"path","description":"Unique identifier of the Purpose.","required":true,"schema":{"type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"}},{"name":"version","in":"query","description":"The Purpose's version.","required":true,"schema":{"type":"integer","example":1,"minimum":1}}],"responses":{"200":{"description":"OK - Successfully published purpose.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PurposeDetailsDto"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"string"}}}},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentPreferences-UniversalConsentPreferenceManag_OAUTH2":["CONSENT"]}]}},"/api/consentmanager/v1/purposes/{purposeId}/retire":{"put":{"operationId":"setRetirementUsingPUT","summary":"Retire Purpose","description":"Use this API to set the retirement date for a specific Purpose. \n\n> ๐ Things to Know\n> \n> - If the `date` query parameter is left empty, the date will be set to one day in the future by default.\n> - Data subjects who gave consent to the specified Purpose will be automatically updated after Purpose expiration. A summary of details about this transaction will appear on the Purposes and Receipts tabs of the Data Subject details screen in the OneTrust application for each profile associated to the Purpose. For more information, see [Managing Data Subjects](https://my-onetrust-com.surrey.idm.oclc.org/s/article/UUID-3d2d8d5e-e9d7-ac43-4ee1-818a4c4e8932) and [Viewing Consent Receipts & Transactions](https://my-onetrust-com.surrey.idm.oclc.org/s/article/UUID-17b03e29-c3b5-c5dc-a172-b2a180f9a826).\n> - This API returns Purpose descriptions inside `` and `
`HTML tags. These can be sanitized depending on your formatting needs.","tags":["Purposes"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"parameters":[{"name":"purposeId","in":"path","description":"Unique identifier of the Purpose.","required":true,"schema":{"type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"}},{"name":"date","in":"query","description":"Date when a Purpose will expire (YYYY-MM-DD).","required":false,"schema":{"type":"string","format":"date","example":"2024-12-31"}}],"responses":{"200":{"description":"OK - Successfully set retirement date for purpose.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PagePurposeDetailsDto"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"string"}}}},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentPreferences-UniversalConsentPreferenceManag_OAUTH2":["CONSENT"]}]}},"/api/consentmanager/v1/receipt-list":{"get":{"operationId":"getReceiptListUsingGET","summary":"Get List of Receipts by Data Subject","description":"> โ๏ธ End of Support Notification\n> \n> As of September 1, 2024, these APIs are now deprecated. Any customers leveraging these APIs are encouraged to migrate to the [Receipts V2 API](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/getreceiptlistdetailsusingpost). For more information, see [OneTrust API Sunsetting & Deprecation Guidelines](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/onetrust-api-sunsetting-deprecation-guidelines).\n\nUse this API to retrieve a list of consent receipts for a given data subject.","tags":["Receipts"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"parameters":[{"name":"identifier","in":"header","description":"Data Subject Identifier filter.","required":true,"schema":{"type":"string","example":"user@example.com"}}],"responses":{"200":{"description":"OK - Successfully retrieved receipts.","content":{"application/json":{"examples":{"SuccessResponse":{"summary":"Example receipt list response","description":"Sample response containing a list of receipts","value":{"receipts":["Receipt Name","Last Modified Date"]}}}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentPreferences-UniversalConsentPreferenceManag_OAUTH2":["CONSENT","CONSENT_READ"]}]}},"/api/consentmanager/v1/receipts":{"get":{"operationId":"getReceiptListDetailsUsingGET","summary":"Get List of Receipt Details by Data Subject","description":"> โ๏ธ End of Support Notification\n> \n> As of September 1, 2024, these APIs are now deprecated. Any customers leveraging these APIs are encouraged to migrate to the [Receipts V2 API](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/getreceiptlistdetailsusingpost). For more information, see [OneTrust API Sunsetting & Deprecation Guidelines](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/onetrust-api-sunsetting-deprecation-guidelines).\n\nUse this API to retrieve a list of consent receipts for a given data subject along with details such as the associated Purposes, Purpose Preferences, and attributes. The response will also include relevant information about the latest Collection Point interactions and the current status of consent.","tags":["Receipts"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"parameters":[{"name":"identifier","in":"header","description":"Data Subject Identifier filter.","required":true,"schema":{"type":"string","example":"user@example.com"}},{"name":"includeNotgiven","in":"query","description":"If true, the response will include Non Given transactions.","required":false,"schema":{"type":"boolean","default":false}},{"name":"page","in":"query","description":"Results page you want to retrieve (0-based).","schema":{"type":"integer","example":0,"default":0,"minimum":0}},{"name":"size","in":"query","description":"Number of records per page (1-50)","schema":{"type":"integer","example":20,"default":50,"maximum":50,"minimum":1}}],"responses":{"200":{"description":"OK - Successfully retrieved receipt details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_ReceiptInformationDetailSliceDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentPreferences-UniversalConsentPreferenceManag_OAUTH2":["CONSENT","CONSENT_READ"]}]}},"/api/consentmanager/v1/receipts/{id}":{"get":{"operationId":"findReceiptUsingGET","summary":"Get Receipt","description":"> โ๏ธ End of Support Notification\n> \n> As of September 1, 2024, these APIs are now deprecated. Any customers leveraging these APIs are encouraged to migrate to the [Receipts V2 API](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/getreceiptlistdetailsusingpost). For more information, see [OneTrust API Sunsetting & Deprecation Guidelines](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/onetrust-api-sunsetting-deprecation-guidelines).\n\nUse this API to retrieve a single receipt by its unique identifier. The response will return information such as the receipt interaction date along with details of the Purposes that the data subject has interacted with, and their corresponding statuses.","tags":["Receipts"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"parameters":[{"name":"id","in":"path","description":"The unique identifier of the receipt.","required":true,"schema":{"type":"string","format":"uuid","example":"97a87bf2-d84d-428d-9e3a-703f33ff8f6a"}},{"name":"includeNotgiven","in":"query","description":"If true, the response will include Non Given transactions.","required":false,"schema":{"type":"boolean","default":false}},{"name":"includeConsentStrings","in":"query","description":"If true, the response will include consent strings.","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK - Successfully retrieved receipt.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_ReceiptInformationDetailDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentPreferences-UniversalConsentPreferenceManag_OAUTH2":["CONSENT","CONSENT_READ"]}]}},"/api/consentmanager/v1/scheduled-jobs/merge-request":{"get":{"operationId":"getPagedMergeRequestUsingGET","summary":"Get List of Scheduled Exports","description":"Use this API to retrieve a list of all scheduled exports of duplicate data subjects. The response will include the merge request ID along with the associated merge request name, export frequency, and export status.","tags":["Deduplicate Data Subjects"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"parameters":[{"name":"page","in":"query","description":"Page number (0-based)","required":true,"schema":{"type":"integer","example":0,"default":0,"minimum":0}},{"name":"size","in":"query","description":"Number of records per page","required":true,"schema":{"type":"integer","example":20,"maximum":100}}],"responses":{"200":{"description":"OK - Successfully retrieved list of scheduled exports","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PageMergeDSRequestDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentPreferences-UniversalConsentPreferenceManag_OAUTH2":["CONSENT"]}]},"post":{"operationId":"scheduleMergeRequestUsingPOST","summary":"Create Scheduled Export of Duplicate Data Subjects","description":"Use this API to create a scheduled export of duplicate data subjects.\n\n> ๐ Things to Know\n> \n> - Once the scheduled export is created, you can retrieve the file using the [Generate Export of Duplicate Data Subjects](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/exportduplicatedatasubject) API.","tags":["Deduplicate Data Subjects"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_MergeDSRequestDto"}}}},"responses":{"200":{"description":"OK - Successfully created scheduled export","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentPreferences-UniversalConsentPreferenceManag_OAUTH2":["CONSENT"]}]}},"/api/consentmanager/v1/scheduled-jobs/merge-request/{mergeRequestGuid}":{"get":{"operationId":"getMergeRequestUsingGET","summary":"Get Scheduled Export","description":"Use this API to retrieve details of a specific scheduled export of duplicate data subjects. The response will include the associated merge request name, export frequency, and export status.","tags":["Deduplicate Data Subjects"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"parameters":[{"name":"mergeRequestGuid","in":"path","description":"Unique identifier of the merge request.","required":true,"schema":{"type":"string","format":"uuid","example":"3fc32e2f-d229-4914-b73c-0e2488bd790e"}}],"responses":{"200":{"description":"OK - Successfully retrieved scheduled export","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_MergeDSRequestDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentPreferences-UniversalConsentPreferenceManag_OAUTH2":["CONSENT"]}]},"delete":{"operationId":"deleteMergeRequestUsingDELETE","summary":"Delete Scheduled Export","description":"Use this API to delete a scheduled export of duplicate data subjects.","tags":["Deduplicate Data Subjects"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"parameters":[{"name":"mergeRequestGuid","in":"path","description":"Unique identifier of the merge request to delete.","required":true,"schema":{"type":"string","format":"uuid","example":"3fc32e2f-d229-4914-b73c-0e2488bd790e"}}],"responses":{"200":{"description":"OK - Successfully deleted scheduled export."},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentPreferences-UniversalConsentPreferenceManag_OAUTH2":["CONSENT"]}]}},"/api/consentmanager/v1/transactions/withdraw/fordatasubject":{"put":{"operationId":"withdrawTransactionBehalfOfDatasubjectUsingPUT","summary":"Withdraw Consent on Behalf of a Data Subject","description":"Use this API to withdraw consent on behalf of a data subject for a specific Purpose. The data subject identifier must be included either in the `identifier` query or header parameter, preferably passed in the header.","tags":["Transactions"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"parameters":[{"name":"identifier","in":"query","description":"Data Subject Identifier (prefer the header parameter).","required":false,"schema":{"type":"string","example":"user@example.com"},"deprecated":true},{"name":"identifier","in":"header","description":"Data Subject Identifier (prefer the header parameter).","required":false,"schema":{"type":"string","example":"user@example.com"}},{"name":"withdrawnBy","in":"query","description":"User withdrawing consent on behalf of data subject.","required":true,"schema":{"type":"string","example":"admin@example.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_WithdrawOnBehalfOfRequest"}}}},"responses":{"200":{"description":"OK - Successfully withdrew consent on behalf of data subject","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_TransactionWithdrawResult"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"deprecated":true,"security":[{"ConsentPreferences-UniversalConsentPreferenceManag_OAUTH2":["CONSENT"]}]}},"/api/consentmanager/v1/transactions/withdraw/purpose/{purposeId}":{"get":{"operationId":"withdrawTransactionByPurposeAndIdentifierUsingGET","summary":"Withdraw Data Subject's Consent","description":"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.\n\n> ๐ Things to Know\n> \n> - This API is not designed to be used in synchronous workflows. As an alternative, the [Create Consent Receipts ](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/createconsentreceiptusingpost) API can be called.","tags":["Transactions"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"parameters":[{"name":"identifier","in":"query","description":"Data Subject Identifier (prefer the header parameter).","required":false,"schema":{"type":"string","example":"user@example.com"},"deprecated":true},{"name":"identifier","in":"header","description":"Data Subject Identifier (prefer the header parameter).","required":false,"schema":{"type":"string","example":"user@example.com"}},{"name":"purposeId","in":"path","description":"Unique Identifier for Purpose.","required":true,"schema":{"type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"}}],"responses":{"200":{"description":"OK - Successfully withdrew consent","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_TransactionWithdrawResult"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"deprecated":true,"security":[{"ConsentPreferences-UniversalConsentPreferenceManag_OAUTH2":["CONSENT","CONSENT_READ"]}]}},"/api/consentmanager/v2/collectionpoints":{"get":{"operationId":"getCollectionPointsUsingGET_1","summary":"Get List of Collection Points","description":"Use this API to retrieve a list of all Collection Points or retrieve a single Collection Point using the `id` query parameter. By default, the response will return details of all versions of a Collection Point with the Active version listed first, but can be filtered using the `status` query parameter.","tags":["Collection Points V2"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"parameters":[{"name":"organizationId","in":"query","description":"Filter collection points by organization ID. Only returns collection points that belong to the specified organization or its hierarchy.","required":false,"schema":{"type":"string","format":"uuid"},"example":"f47ac10b-58cc-4372-a567-0e02b2c3d47"},{"name":"page","in":"query","description":"The page number of the results (0-based).","schema":{"type":"integer","example":0,"default":0,"minimum":0}},{"name":"size","in":"query","description":"The number of results per page.","schema":{"type":"integer","example":20,"default":20,"maximum":100,"minimum":1}},{"name":"id","in":"query","description":"Unique identifier of a specific Collection Point to retrieve.","schema":{"type":"string","format":"uuid","example":"987b1f51-a538-122e-afc4-6b383c28eeb3"}},{"name":"status","in":"query","description":"Filter Collection Points by status.","schema":{"type":"string","example":"ACTIVE","enum":["DRAFT","ACTIVE","RETIRED","INACTIVE"]}},{"name":"version","in":"query","description":"Filter by specific version of the Collection Point.","schema":{"type":"integer","example":1,"minimum":1}},{"name":"sort","in":"query","description":"Sorting criteria in the format: property,(asc|desc). Default sort order is descending. Multiple sort criteria are supported.","schema":{"type":"string","example":"createdDate,desc","default":"createdDate,desc","enum":["id,asc","id,desc","name,asc","name,desc","status,asc","status,desc","version,asc","version,desc","createdDate,asc","createdDate,desc","lastModifiedDate,asc","lastModifiedDate,desc","activationDate,asc","activationDate,desc","collectionPointType,asc","collectionPointType,desc"]}}],"responses":{"200":{"description":"OK - List of Collection Points retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PageCollectionPointDtoV2_DetailV2"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentPreferences-UniversalConsentPreferenceManag_OAUTH2":["CONSENT","CONSENT_READ"]}]}},"/api/consentmanager/v2/collectionpoints/{collectionPointGuid}/version":{"post":{"operationId":"createVersionUsingPOST","summary":"Create New Collection Point Version","description":"Use this API to create a new version of an existing Collection Point that is currently in **Active** status. A new version of the Collection Point will be created in **Draft** status while the Active version of the Collection Point will remain unchanged.\n\n> ๐ Things to Know\n> \n> - Once the Collection Point is in **Draft** status, the Update Existing Collection Point API can be used to edit the Collection Point. Changes will only be visible once the new version of the Collection Point is published.","tags":["Collection Points V2"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"parameters":[{"name":"collectionPointGuid","in":"path","description":"The unique identifier of the Collection Point to create a new version for","required":true,"schema":{"type":"string","format":"uuid"},"example":"123e4567-e89b-12d3-a456-426614174000"}],"responses":{"200":{"description":"Successfully created a new version of the Collection Point","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_CollectionPointDtoV2"},"examples":{"CollectionPointDtoV2":{"description":"CollectionPointDtoV2","value":{"id":"123e4567-e89b-12d3-a456-426614174000","name":"Marketing Consent Form","version":2,"status":"DRAFT"}}}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentPreferences-UniversalConsentPreferenceManag_OAUTH2":["CONSENT"]}]}},"/api/consentmanager/v2/datasubjects":{"get":{"operationId":"getDataSubjectsUsingGET","summary":"Get List of Data Subjects","description":"Use this API to retrieve a list of all data subjects. The response will include details for each data subject such as the associated data elements, data subject ID, and data subject identifier. By default, the response will return data subject details sorted in descending order of last modified date.\n\n> ๐ Things to Know\n> \n> - This API is not designed to be used in synchronous workflows. As an alternative, the [Gets preferences for a Data Subject](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/getpreferencesusingget) API can be called.\n\n> ๐ง \n> \n> Please note that the FTC Do Not Call List is updated once daily and not updated in real time. As such, there may be a possibility that a consumer's preferences may have changed and they may have opted out of receiving communication before the Do Not Call list gets refreshed. OneTrust is merely conveying information received from the FTC and is not responsible for compiling the lists.","tags":["Data Subjects V2"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"parameters":[{"name":"page","in":"query","description":"Page number (0-based).","schema":{"type":"integer","example":0,"default":0,"minimum":0}},{"name":"size","in":"query","description":"Number of records per page (1-50).","schema":{"type":"integer","example":20,"default":20,"maximum":2000,"minimum":1}},{"name":"updatedSince","in":"query","description":"Filter Data Subject records that were last updated on or after the specified date. Formats accepted: yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss.","schema":{"type":"string","format":"date-time","example":"2023-01-01T00:00:00"}},{"name":"updatedUntil","in":"query","description":"Filter Data Subject records that were last updated on or before the specified date. Must be used with updatedSince. Formats accepted: yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss.","schema":{"type":"string","format":"date-time","example":"2023-12-31T23:59:59"}},{"name":"identifier","in":"header","description":"Filter by data subject identifier (prefer using the header parameter).","schema":{"type":"string","example":"user@example.com"}},{"name":"id","in":"query","description":"Filter by data subject ID (UUID).","schema":{"type":"string","format":"uuid","example":"a9adf402-adcd-45be-b981-a56a5c0739ec"}},{"name":"dataElementName","in":"header","description":"Filter by data element name (must be used with dataElementValue).","schema":{"type":"string","example":"Email"}},{"name":"dataElementValue","in":"header","description":"Filter by data element value (must be used with dataElementName).","schema":{"type":"string","example":"user@example.com"}},{"name":"language","in":"query","description":"Filter by language code (e.g., 'en', 'fr').","schema":{"type":"string","example":"en"}},{"name":"properties","in":"query","description":"Specify optional properties to control the response. Multiple values can be comma-separated.\n\n- `ignoreCount`: Skip the total record count calculation (improves performance)\n- `linkTokens`: Include link tokens in the response\n- `ignoreDefaultSort`: Disable default sorting by last modified date","schema":{"type":"string","example":"ignoreCount,linkTokens"}},{"name":"includeDataSubjectsWithOutPurposeTransactions","in":"query","description":"Include data subjects without purpose transactions (true/false).","schema":{"type":"boolean","default":false}},{"name":"isDNCInclude","in":"query","description":"Include Do Not Call list information (true/false).","schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK - List of data subjects retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_DataSubjectSliceDtoV2"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentPreferences-UniversalConsentPreferenceManag_OAUTH2":["CONSENT","CONSENT_READ"]}]}},"/api/consentmanager/v2/datasubjects/profiles":{"delete":{"operationId":"deleteDataSubjectProfilesUsingDELETE","summary":"Delete Purposes from Data Subject","description":"Use this API to delete up to 100 purposes from one data subject or to delete one purpose from up to 100 data subjects.\n\n> ๐ Things to Know\n> \n> - By default, related data subject transactions will be removed from the database and will no longer appear in the OneTrust Platform UI after calling this API. However, the transactions can still be retrieved using the [Get List of Receipts API](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/getreceiptlistdetailsusingpost). To maintain data subject transactions in the database and OneTrust Platform UI, set the `retainTransactions` parameter to `true`.","tags":["Data Subjects V2"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_DeletePurposeFromDataSubject"}}}},"responses":{"200":{"description":"OK - Successfully processed deletion of purposes from data subjects.","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentPreferences-UniversalConsentPreferenceManag_OAUTH2":["CONSENT","CONSENT_READ"]}]}},"/api/consentmanager/v2/datasubjects/search":{"post":{"operationId":"searchDataSubjectsPostUsingPOST","summary":"Search Data Subjects","description":"Use this API to search for data subjects based on various criteria. The response will include details for each matching data subject such as the associated data elements, data subject ID, and data subject identifier.\n\n> ๐ Things to Know\n> \n> - This API supports complex search criteria including filtering by data elements, purposes, and consent status.\n> - For large result sets, use pagination to retrieve data in manageable chunks.\n> - The response can be customized using the properties parameter to include or exclude certain data.\n\n> ๐ง \n> \n> Please note that the FTC Do Not Call List is updated once daily and not updated in real time. As such, there may be a possibility that a consumer's preferences may have changed and they may have opted out of receiving communication before the Do Not Call list gets refreshed. OneTrust is merely conveying information received from the FTC and is not responsible for compiling the lists.","tags":["Data Subjects V2"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"parameters":[{"name":"page","in":"query","description":"Page number (0-based).","schema":{"type":"integer","example":0,"default":0,"minimum":0}},{"name":"size","in":"query","description":"Number of records per page (1-2000).","schema":{"type":"integer","example":1000,"default":1000,"maximum":2000,"minimum":1}},{"name":"isDNCInclude","in":"query","description":"Include Do Not Call list information (true/false).","schema":{"type":"boolean"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_DataSubjectSearchDto"},"examples":{"Search by Email":{"summary":"Find data subjects by email","description":"Search by Email","value":{"dataElements":[{"name":"Email","value":"user@example.com"}]}},"Search by Purpose":{"summary":"Find data subjects who consented to a specific purpose","description":"Search by Purpose","value":{"purposeGuid":"550e8400-e29b-41d4-a716-446655440000","consentStatus":"GRANTED"}}}}}},"responses":{"200":{"description":"OK - Search results returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_DataSubjectSliceDtoV2"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentPreferences-UniversalConsentPreferenceManag_OAUTH2":["CONSENT","CONSENT_READ"]}]}},"/api/consentmanager/v2/linkedidentitygroups":{"get":{"operationId":"getLinkedIdentityGroupsUsingGET","summary":"Get List of Data Subject Groups","description":"Use this API to retrieve a list of all Data Subject Groups. The response will include the Data Subject Group ID, number of data subjects, and details of the primary data subjects in the group.","tags":["Data Subject Groups"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"parameters":[{"name":"primaryDataSubjectIdentifier","in":"header","description":"In order to retrieve a list of Linked Identity Groups whose primary identifier is equal to the primaryDataSubjectIdentifier header value","required":false,"schema":{"type":"string","example":"user@example.com"}},{"name":"primaryDataSubjectIdentifierType","in":"header","description":"In order to retrieve a list of Linked Identity Groups whose primary identifier type is equal to the primaryDataSubjectIdentifierType header value","required":false,"schema":{"type":"string","example":"Email"}},{"name":"requestContinuation","in":"header","description":"Token for pagination","required":false,"schema":{"type":"string"},"example":"eyJpZCI6IjEyMzQ1Njc4OTAiLCJ0aW1lc3RhbXAiOjE2MDAwMDAwMDB9"},{"name":"displayOrganizations","in":"query","description":"Include organization information for Data Subject Groups","required":false,"schema":{"type":"boolean","example":false}},{"name":"page","in":"query","description":"Results page you want to retrieve (0..N).","schema":{"type":"integer","example":0,"default":0,"minimum":0}},{"name":"size","in":"query","description":"Number of records per page.","schema":{"type":"integer","example":20,"default":20,"maximum":100,"minimum":1}},{"name":"sort","in":"query","description":"Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","schema":{"type":"string","example":"createdDate,desc","enum":["lastModifiedDate,asc","lastModifiedDate,desc","lastUpdatedDate,asc","lastUpdatedDate,desc","expiryDate,asc","expiryDate,desc","addedDate,asc","addedDate,desc","createdDate,asc","createdDate,desc"]}}],"responses":{"200":{"description":"OK - Successfully retrieved Data Subject Groups.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PageLinkedIdentityGroupDto_Page"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentPreferences-UniversalConsentPreferenceManag_OAUTH2":["CONSENT","CONSENT_READ"]}]},"post":{"operationId":"createLinkedIdentityGroupUsingPOST","summary":"Create Data Subject Group","description":"Use this API to create a new Data Subject Group.\n\n> ๐ Things to Know\n> \n> - Data Subject Groups must contain at least one primary data subject identifier and two data subjects.","tags":["Data Subject Groups"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_LinkedIdentityGroupRequest_Detailed"}}}},"responses":{"200":{"description":"OK - Successfully created Data Subject Group.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_LinkedIdentityGroupDto_Detailed"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_LinkedIdentityGroupDto_Detailed"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentPreferences-UniversalConsentPreferenceManag_OAUTH2":["CONSENT"]}]}},"/api/consentmanager/v2/linkedidentitygroups/{linkedIdentityGroupId}":{"get":{"operationId":"getLinkedIdentityGroupUsingGET","summary":"Get Data Subject Group","description":"Use this API to retrieve a single Data Subject Group by its unique identifier along with details such as the Data Subject Group ID and the list of data subjects within its group.","tags":["Data Subject Groups"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"parameters":[{"name":"linkedIdentityGroupId","in":"path","description":"Unique identifier identifying a Data Subject Group.","required":true,"schema":{"type":"string","format":"uuid","example":"3d8c79aa-5a14-48a4-b88d-f023913ec2ca"}},{"name":"displayOrganizations","in":"query","description":"Include organization information in the response.","required":false,"schema":{"type":"boolean","example":false}}],"responses":{"200":{"description":"OK - Successfully retrieved Data Subject Group.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_LinkedIdentityGroupDto_Detailed"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentPreferences-UniversalConsentPreferenceManag_OAUTH2":["CONSENT","CONSENT_READ"]}]},"put":{"operationId":"updateLinkedIdentityGroupUsingPUT","summary":"Update Data Subject Group","description":"Use this API to update an existing Data Subject Group.\n\n> ๐ Things to Know\n> \n> - Data Subject Groups must contain at least one primary data subject identifier and two data subjects.\n> - To update the Data Subject Group name, use the `groupName` parameter and enter a new name different from the one already in use.","tags":["Data Subject Groups"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"parameters":[{"name":"linkedIdentityGroupId","in":"path","description":"Unique identifier identifying a Data Subject Group.","required":true,"schema":{"type":"string","format":"uuid","example":"3d8c79aa-5a14-48a4-b88d-f023913ec2ca"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_LinkedIdentityGroupRequest_Detailed"}}}},"responses":{"200":{"description":"OK - Successfully updated Data Subject Group.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_LinkedIdentityGroupDto_Detailed"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentPreferences-UniversalConsentPreferenceManag_OAUTH2":["CONSENT"]}]},"delete":{"operationId":"deleteUsingDELETE","summary":"Delete Data Subject Group","description":"Use this API to delete an existing Data Subject Group.","tags":["Data Subject Groups"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"parameters":[{"name":"linkedIdentityGroupId","in":"path","description":"Unique identifier identifying a Data Subject Group","required":true,"schema":{"type":"string","format":"uuid","example":"3d8c79aa-5a14-48a4-b88d-f023913ec2ca"}}],"responses":{"200":{"description":"OK - Successfully deleted Data Subject Group"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentPreferences-UniversalConsentPreferenceManag_OAUTH2":["CONSENT"]}]}},"/api/consentmanager/v2/preferencecenterpage/{preferencecenterpageid}/schema":{"get":{"operationId":"getPreferenceCenterPageSchemaUsingGET","summary":"Get Preference Center Page Schema","description":"Use this API to retrieve the schema for a specific page within a Multi Page Preference Center. The response will include the structure of the specified page within the Preference Center, including the sections, Purposes, and Data Elements.","tags":["Preference Centers V2"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"parameters":[{"name":"preferencecenterpageid","in":"path","description":"Unique identifier of the Preference Center Page.","required":true,"schema":{"type":"string","format":"uuid","example":"156129da-7441-498d-a0eb-a89da357d741"}},{"name":"state","in":"query","description":"The state of the Preference Center.","required":false,"schema":{"type":"string","example":"PUBLISHED","default":"PUBLISHED","enum":["PUBLISHED","DRAFT"]}}],"responses":{"200":{"description":"OK - Successfully retrieved preference center page schema.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PreferenceCenterPageDto_PagePublicAPI"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentPreferences-UniversalConsentPreferenceManag_OAUTH2":["CONSENT","CONSENT_READ"]}]}},"/api/consentmanager/v2/preferencecenters":{"get":{"operationId":"getPreferenceCentersUsingGET","summary":"Get List of Preference Centers","description":"Use this API to retrieve a list of all Preference Centers. The response will include details for each Preference Center along with the corresponding Preference Center ID, created date, and published date.","tags":["Preference Centers V2"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"parameters":[{"name":"page","in":"query","description":"Results page you want to retrieve (0-based).","schema":{"type":"integer","example":0,"default":0,"minimum":0}},{"name":"size","in":"query","description":"Number of records per page.","schema":{"type":"integer","example":20,"default":20,"maximum":100,"minimum":1}},{"name":"sort","in":"query","description":"Sorting criteria in the format: property,(asc|desc). Default sort order is descending by ID. Multiple sort criteria are supported.","schema":{"type":"string","example":"createdDate,desc","enum":["name,asc","name,desc","createdDate,asc","createdDate,desc","lastModifiedDate,asc","lastModifiedDate,desc","status,asc","status,desc","version,asc","version,desc"]}},{"name":"dataElementGuid","in":"query","description":"Filter preference centers by data element GUID.","required":false,"schema":{"type":"string","format":"uuid","example":"133323f3-cf99-4b9d-a103-040bd6643d3f"}}],"responses":{"200":{"description":"OK - Successfully retrieved list of preference centers.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PagePreferenceCenterSummaryDtoV2"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentPreferences-UniversalConsentPreferenceManag_OAUTH2":["CONSENT","CONSENT_READ"]}]}},"/api/consentmanager/v2/preferencecenters/{preferencecenterid}":{"get":{"operationId":"getRootSchemaUsingGET","summary":"Get Preference Center Root Schema","description":"Use this API to retrieve the root schema for a Multi Page Preference Center. The response will include the root structure of the Preference Center, including the settings, languages, and configured pages.","tags":["Preference Centers V2"],"parameters":[{"name":"preferencecenterid","in":"path","description":"Unique identifier of the Preference Center.","required":true,"schema":{"type":"string","format":"uuid","example":"156129da-7441-498d-a0eb-a89da357d741"}},{"name":"state","in":"query","description":"The state of the Preference Center.","required":false,"schema":{"type":"string","default":"PUBLISHED","enum":["PUBLISHED","DRAFT"]}}],"responses":{"200":{"description":"OK - Successfully retrieved preference center root schema.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_AdvancedPreferenceCenterDto_RootPublicAPI"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentPreferences-UniversalConsentPreferenceManag_OAUTH2":["CONSENT","CONSENT_READ"]}]}},"/api/consentmanager/v2/purposes":{"get":{"operationId":"getGroupedPurposesV2","summary":"Get List of Purpose Versions","description":"Use this API to retrieve a list of Purpose versions. The response will include details for each Purpose version along with the corresponding Purpose ID, created date, and published date.\n\n> ๐ Things to Know\n> \n> - This API returns Purpose descriptions inside `` and `
`HTML tags. These can be sanitized depending on your formatting needs.","tags":["Purposes V2"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"parameters":[{"name":"latestVersion","in":"query","description":"In order to retrieve only the latest version of each Purpose this property should be set to true.","required":false,"schema":{"type":"boolean","example":false,"default":false}},{"name":"includeRetired","in":"query","description":"In order to include retired versions for each Purpose this property should be set to true.","required":false,"schema":{"type":"boolean","default":false}},{"name":"organization","in":"query","description":"Organization ID to filter purposes by.","required":false,"schema":{"type":"string","format":"uuid"},"example":"1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed"},{"name":"includeCustomPreferences","in":"query","description":"In order to retrieve custom preferences for each version of Purposes this property should be set to true.","required":false,"schema":{"type":"boolean","default":false}},{"name":"includeTopics","in":"query","description":"In order to retrieve topics for each version of Purposes this property should be set to true.","required":false,"schema":{"type":"boolean","default":false}},{"name":"fromLastModifiedDate","in":"query","description":"Filter purposes modified after this date (format: yyyy-MM-dd'T'HH:mm:ss).","required":false,"schema":{"type":"string","format":"date-time","example":"2023-01-01T00:00:00"}},{"name":"toLastModifiedDate","in":"query","description":"Filter purposes modified before this date (format: yyyy-MM-dd'T'HH:mm:ss).","required":false,"schema":{"type":"string","format":"date-time","example":"2023-12-31T23:59:59"}},{"name":"page","in":"query","description":"Results page you want to retrieve (0-based).","schema":{"type":"integer","example":0,"default":0,"minimum":0}},{"name":"size","in":"query","description":"Number of records per page.","schema":{"type":"integer","example":20,"default":20,"maximum":100,"minimum":1}},{"name":"sort","in":"query","description":"Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","schema":{"type":"string","example":"lastModifiedDate,asc","enum":["guid,asc","guid,desc","name,asc","name,desc","description,asc","description,desc","version,asc","version,desc","purposeStatus,asc","purposeStatus,desc","purposeType,asc","purposeType,desc","consentLifeSpan,asc","consentLifeSpan,desc","implicitConsentLifeSpan,asc","implicitConsentLifeSpan,desc","createdDate,asc","createdDate,desc","lastModifiedDate,asc","lastModifiedDate,desc","createdBy,asc","createdBy,desc","lastModifiedBy,asc","lastModifiedBy,desc","publishedDate,asc","publishedDate,desc","retireOnDate,asc","retireOnDate,desc","publishedBy,asc","publishedBy,desc","externalReference,asc","externalReference,desc","defaultConsentStatus,asc","defaultConsentStatus,desc"]}}],"responses":{"200":{"description":"OK - Successfully retrieved purpose versions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PagePurposeVersionsGroupedByGuid_Simple"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentPreferences-UniversalConsentPreferenceManag_OAUTH2":["CONSENT","CONSENT_READ"]}]}},"/api/consentmanager/v2/purposes/{purposeId}":{"get":{"operationId":"getPurposeDetailUsingGET","summary":"Get Purpose","description":"Use this API to retrieve a single Purpose by its unique identifier along with the associated attributes, Purpose Preferences, and created date.\n\n> ๐ Things to Know\n> \n> - This API returns Purpose descriptions inside `` and `
`HTML tags. These can be sanitized depending on your formatting needs.","tags":["Purposes V2"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"parameters":[{"name":"purposeId","in":"path","description":"Unique identifier of the Purpose","required":true,"schema":{"type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"}},{"name":"status","in":"query","description":"The status of the Purpose to be retrieved (ACTIVE or DRAFT). By default, ACTIVE is returned.","required":false,"schema":{"type":"string","default":"ACTIVE","enum":["ACTIVE","DRAFT"]}},{"name":"version","in":"query","description":"Version number of the Purpose to be retrieved","required":false,"schema":{"type":"integer","example":2,"minimum":1}}],"responses":{"200":{"description":"OK - Successfully retrieved purpose","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PurposeDetailDtoV2_Detail"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentPreferences-UniversalConsentPreferenceManag_OAUTH2":["CONSENT","CONSENT_READ"]}]}},"/api/consent/v2/consent-groups":{"get":{"operationId":"getConsentGroupListUsingGET","summary":"Get List of Consent Groups","description":"Use this API to retrieve a list of all Consent Groups along with details such as the Consent Group ID, associated Purpose Rules, and the list of data subjects and/or Consent Groups within its hierarchal structure.","tags":["Consent Groups"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"parameters":[{"name":"name","in":"query","description":"Name of the Consent Group","required":false,"schema":{"type":"string"},"example":"Marketing"}],"responses":{"200":{"description":"Successfully retrieved list of Consent Groups.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentAPI_PageConsentGroupListDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentAPI_OAUTH2":["CONSENT","CONSENT_READ"]}]},"post":{"operationId":"createConsentGroupUsingPOST","summary":"Create Consent Group","description":"Use this API to create a new Consent Group by providing a name, description, and optional external name.\n\n> ๐ Things to Know\n> \n> - If an external name is not defined, one will be generated automatically.","tags":["Consent Groups"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentAPI_ConsentGroupRequest"}}}},"responses":{"201":{"description":"Consent Group created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentAPI_ConsentGroupDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentAPI_OAUTH2":["CONSENT"]}]}},"/api/consent/v2/consent-groups/settings":{"get":{"operationId":"getConsentGroupSettingsUsingGET","summary":"Get Priority Scores for Purpose Statuses","description":"Use this API to retrieve the Priority Scores for each Purpose Status.\n\n> ๐ Things to Know\n> \n> - All Purpose Statuses are given a Priority Score. A Purpose Status with a lower Priority Score will be given precedence over a Purpose Status with a higher Priority Score.\n> - Each Purpose in a Consent Group has its own Purpose Rule which is comprised of an Enforced Status and Effective Status.\n> - The Enforced Status is the Purpose Status that you want to apply for a particular Purpose.\n> - The Effective Status is calculated using the Priority Scores across the entire Consent Group hierarchy for each Purpose.\n\n> ๐ \n> \n> For more information, see [Using Consent Groups to Alter a Data Subject's Consent Status](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/docs/using-consent-groups-to-alter-a-data-subjects-consent-status).","tags":["Consent Groups"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"responses":{"200":{"description":"Successfully retrieved Consent Group settings.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentAPI_ConsentGroupSettingsDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentAPI_OAUTH2":["CONSENT","CONSENT_READ"]}]},"put":{"operationId":"updateConsentGroupSettingsUsingPUT","summary":"Update Priority Scores for Purpose Statuses","description":"Use this API to update the current Priority Score values for the Purpose Statuses. Priority Scores across the entire Consent Group hierarchy are used to calculate the Effective Status of a Purpose.\n\n> ๐ Things to Know\n> \n> - All Purpose Statuses are given a Priority Score. A Purpose Status with a lower Priority Score will be given precedence over a Purpose Status with a higher Priority Score. Any new Purpose Statuses will automatically be given a higher priority score by default.\n> - When calculating the Effective Status of any Purpose in a Consent Group:\n> - If there is no Parent Consent Group, the Effective Status becomes the same as the Enforced Status.\n> - If there is a Parent Consent Group, the Effective Status would be calculated by comparing the Priority Score of the Enforced Status of the Purpose at that hierarchy level with the Priority Score of the Effective Status of the Purpose in the Parent level and applying the status associated with the lower Priority Score.\n\n> ๐ \n> \n> For more information, see [Using Consent Groups to Alter a Data Subject's Consent Status](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/docs/using-consent-groups-to-alter-a-data-subjects-consent-status).","tags":["Consent Groups"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentAPI_ConsentGroupSettingsDto"}}}},"responses":{"200":{"description":"Successfully updated Consent Group settings.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentAPI_ConsentGroupSettingsDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentAPI_OAUTH2":["CONSENT"]}]}},"/api/consent/v2/consent-groups/{consentGroupGuid}":{"get":{"operationId":"getConsentGroupUsingGET","summary":"Get Consent Group","description":"Use this API to retrieve a single Consent Group by its unique identifier along with details such as the Consent Group ID, associated Purpose Rules, and the list of data subjects and/or Consent Groups within its hierarchal structure.","tags":["Consent Groups"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"parameters":[{"name":"consentGroupGuid","in":"path","description":"The UUID of the Consent Group. `consentGroupGuid` can be retrieved using the [Get a paged view for consent groups API](/onetrust/reference/getconsentgrouplistusingget)","required":true,"schema":{"type":"string","format":"uuid","example":"823e4567-e89b-12d3-a456-fa6614171652"}}],"responses":{"200":{"description":"Successfully retrieved Consent Group.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentAPI_ConsentGroupDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentAPI_OAUTH2":["CONSENT","CONSENT_READ"]}]}},"/api/consent/v2/consent-groups/{consentGroupGuid}/consent-groups":{"post":{"operationId":"addConsentGroupsToConsentGroupUsingPOST","summary":"Add Consent Groups to Parent Consent Group","description":"Use this API to add Consent Groups as children of the specified Parent Consent Group.\n\n> ๐ Things to Know\n> \n> - A Consent Group can only be added as a child to one Parent Consent Group.\n> - A Parent Consent Group can either have Consent Groups as children or data subjects as children within a given level in the hierarchy, not both. If Consent Groups are added as children to the Parent Consent Group, data subjects cannot be added to the Parent Consent Group at that given level.\n> - Consent Groups can support a hierarchical structure of up to 4 levels. However, once data subjects are added as children to a Parent Consent Group, no additional Consent Groups can be added to that hierarchical structure.","tags":["Consent Groups"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"parameters":[{"name":"consentGroupGuid","in":"path","description":"The UUID of the Consent Group. `consentGroupGuid` can be retrieved using the [Get a paged view for consent groups](/onetrust/reference/getconsentgrouplistusingget) API.","required":true,"schema":{"type":"string","format":"uuid","example":"1a6c1e65-aa4f-4d79-ac62-7fe905616f71"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentAPI_ConsentGroupConsentGroupsRequest"}}}},"responses":{"201":{"description":"Consent Groups added successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentAPI_ConsentGroupDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentAPI_OAUTH2":["CONSENT"]}]},"delete":{"operationId":"unlinkConsentGroupUsingDELETE","summary":"Remove Consent Groups from Parent Consent Group","description":"Use this API to remove Consent Groups as children of the specified Parent Consent Group.\n\n> ๐ Things to Know\n> \n> - Multiple Consent Groups can be removed within the same API call by specifying the list of child Consent Group IDs.","tags":["Consent Groups"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"parameters":[{"name":"consentGroupGuid","in":"path","description":"The UUID of the parent Consent Group. The `consentGroupGuid` can be obtained using the [Get a Paged View for Consent Group](/onetrust/reference/getconsentgrouplistusingget) API","required":true,"schema":{"type":"string","format":"uuid","example":"1a6c1e65-aa4f-4d79-ac62-7fe905616f71"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentAPI_ConsentGroupConsentGroupsRequest"}}}},"responses":{"204":{"description":"Consent Groups removed successfully."},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentAPI_OAUTH2":["CONSENT"]}]}},"/api/consent/v2/consent-groups/{consentGroupGuid}/data-subjects":{"post":{"operationId":"addDataSubjectsToConsentGroupUsingPOST","summary":"Add Data Subjects to Parent Consent Group","description":"Use this API to add data subjects as children of the specified Parent Consent Group.\n\n> ๐ Things to Know\n> \n> - A Parent Consent Group can either have Consent Groups as children or data subjects as children within a given level in the hierarchy, not both. If data subjects are added as children to the Parent Consent Group, Consent Groups cannot be added to the Parent Consent Group at that given level or any level below in the hierarchical structure.","tags":["Consent Groups"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"parameters":[{"name":"consentGroupGuid","in":"path","description":"The UUID of the Consent Group. `consentGroupGuid` can be retrieved using the [Get a paged view for consent groups API](/onetrust/reference/getconsentgrouplistusingget)","required":true,"schema":{"type":"string","format":"uuid","example":"1a6c1e65-aa4f-4d79-ac62-7fe905616f71"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentAPI_ConsentGroupDataSubjectsRequest"}}}},"responses":{"201":{"description":"Data Subjects added to Consent Group successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentAPI_ConsentGroupDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentAPI_OAUTH2":["CONSENT"]}]}},"/api/consent/v2/consent-groups/{consentGroupGuid}/data-subjects/{dataSubjectGuid}":{"delete":{"operationId":"deleteDataSubjectsToConsentGroupUsingDELETE","summary":"Remove Data Subject from Parent Consent Group","description":"Use this API to remove a single data subject as a child of the specified Parent Consent Group.\n\n> ๐ Things to Know\n> \n> - Only one data subject can be removed per API call.","tags":["Consent Groups"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"parameters":[{"name":"consentGroupGuid","in":"path","description":"The UUID of the Consent Group. `consentGroupGuid` can be retrieved using the [Get a paged view for consent groups API](/onetrust/reference/getconsentgrouplistusingget)","required":true,"schema":{"type":"string","format":"uuid","example":"1a6c1e65-aa4f-4d79-ac62-7fe905616f71"}},{"name":"dataSubjectGuid","in":"path","description":"The UUID of the Data Subject to be deleted from Consent Group. `dataSubjectGuid` can be retrieved using [Get a paged list of Data Subjects](/onetrust/reference/getdatasubjectsusingget)","required":true,"schema":{"type":"string","format":"uuid","example":"fa3e4567-e89b-12d3-a456-426614176901"}}],"responses":{"204":{"description":"Data Subject removed successfully."},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentAPI_OAUTH2":["CONSENT"]}]}},"/api/consent/v2/consent-groups/{consentGroupGuid}/purpose-rules":{"put":{"operationId":"updatePurposeRulesToConsentGroupUsingPUT","summary":"Update Consent Group Purpose Rule","description":"Use this API to update existing Purpose Rules within a Consent Group.","tags":["Consent Groups"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"parameters":[{"name":"consentGroupGuid","in":"path","description":"The UUID of the Consent Group. `consentGroupGuid` can be retrieved using the [Get a paged view for consent groups API](/onetrust/reference/getconsentgrouplistusingget)","required":true,"schema":{"type":"string","format":"uuid","example":"853e4567-e89b-12d3-a456-fa6614174000"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentAPI_ConsentGroupPurposeRulesRequest"}}}},"responses":{"200":{"description":"Purpose Rules updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentAPI_ConsentGroupDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentAPI_OAUTH2":["CONSENT"]}]},"post":{"operationId":"addPurposeRulesToConsentGroupUsingPOST","summary":"Add Purpose Rules to Consent Group","description":"Use this API to add Purpose Rules to a Consent Group. These rules will dictate which Purposes will be overridden with the defined Enforced Status for data subjects within the given Consent Group.\n\n> ๐ Things to Know\n> \n> - Each Purpose in a Consent Group has its own Purpose Rule which is comprised of an Enforced Status and Effective Status.\n> - The Enforced Status is the Purpose Status that you want to apply for a particular Purpose.\n> - The Effective Status is calculated using the Priority Scores across the entire Consent Group hierarchy for each Purpose.","tags":["Consent Groups"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"parameters":[{"name":"consentGroupGuid","in":"path","description":"The UUID of the Consent Group. `consentGroupGuid` can be retrieved using the [Get a paged view for consent groups API](/onetrust/reference/getconsentgrouplistusingget) to add Purpose Rules","required":true,"schema":{"type":"string","format":"uuid","example":"1a6c1e65-aa4f-4d79-ac62-7fe905616f71"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentAPI_ConsentGroupPurposeRulesRequest"}}}},"responses":{"201":{"description":"Purpose Rules added successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentAPI_ConsentGroupDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentAPI_OAUTH2":["CONSENT"]}]}},"/api/consent/v2/consent-groups/{consentGroupGuid}/purpose-rules/{purposeGuid}":{"delete":{"operationId":"deleteConsentGroupPurposeRuleUsingDELETE","summary":"Remove Purpose Rule from Consent Group","description":"Use this API to remove existing Purpose Rules from a Consent Group.","tags":["Consent Groups"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"parameters":[{"name":"consentGroupGuid","in":"path","description":"The UUID of the Consent Group. `consentGroupGuid` can be retrieved using the [Get a paged view for consent groups API](/onetrust/reference/getconsentgrouplistusingget)","required":true,"schema":{"type":"string","format":"uuid","example":"1a6c1e65-aa4f-4d79-ac62-7fe905616f71"}},{"name":"purposeGuid","in":"path","description":"The UUID of the Purpose to be removed from Consent Group Purpose Rules. `purposeId` can be retrieved using the [Get paged list of Purposes](/onetrust/reference/getpurposesusingget)","required":true,"schema":{"type":"string","format":"uuid","example":"f23e4567-e89b-12d3-a456-426614171101"}}],"responses":{"204":{"description":"Purpose Rule removed successfully."},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentAPI_OAUTH2":["CONSENT"]}]}},"/api/consent/v2/datasubject-purposes/{purposeGuid}":{"delete":{"operationId":"deletePurposeFromDataSubjectUsingDELETE","summary":"Delete Purpose from Data Subjects","description":"Use this API for large scale deletion of a specific purpose from all data subjects.\n\n> ๐ Things to Know\n> \n> - A data subject exclusion list is required to provide the specific data subjects from which the purpose should not be deleted. The **Consent DS Exclusion** import template within Global Settings in the OneTrust Platform can be used to create the data subject exclusion list and can be imported via Bulk Import in the application or via API.\n> - Once the data subject exclusion list has been successfully imported, either an `importID` or `jobGuid` parameter value must be specified in the request body.\n> - Data subject exclusion lists are valid during the next 30 days after submission.\n> - To override the data subject exclusion list requirement, set the `deletePurposeFromAllDataSubjects` parameter value to `true`. By default, this parameter is set to `false`.\n> - By default, related data subject transactions will be removed from the database and will no longer appear in the OneTrust Platform UI after calling this API. However, the transactions can still be retrieved using the [Get List of Receipts API](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/getreceiptlistdetailsusingpost). To maintain data subject transactions in the database and OneTrust Platform UI, set the `retainTransactions` parameter to `true`.","tags":["Data Subjects V2"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"parameters":[{"name":"purposeGuid","in":"path","description":"UUID of the Purpose to be deleted","required":true,"schema":{"type":"string","format":"uuid","example":"fb1e4567-e89b-12d3-a456-426614174015"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentAPI_DeleteDataSubjectByPurposeRequest"}}}},"responses":{"202":{"description":"Purpose deletion from Data Subjects request processed successfully.","content":{"application/json":{"schema":{"type":"string","example":"DataSubject Profile Delete Request has been accepted"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentAPI_OAUTH2":["CONSENT"]}]}},"/api/consent/v2/datasubjects":{"delete":{"operationId":"DeleteDataSubjectProfileUsingDELETE","summary":"Delete Data Subjects","description":"Use this API to delete data subjects. Deleting data subjects is a permanent action that should be exercised with caution.\n\n> ๐ Things to Know\n> \n> - Data subjects can be deleted using any of the following values at a time:\n> - List of Identifiers\n> - List of Data Subject Identifier GUIDs\n> - Date range between `fromCreatedDate` and `toCreatedDate` (the timespan must be 24 hours or less).\n> - Date range between `fromInteractionDate` and `toInteractionDate` (the timespan must be 24 hours or less).\n> - When filtering by date range, created date and interaction date should be used separately. They should not be used at the same time.\n> - Up to 999 data subject identifiers can be deleted per API call.\n> - 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.\n> - 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.\n> - 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](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/getreceiptlistdetailsusingpost). To maintain data subject receipts and transactions in the database and OneTrust Platform UI, set the `retainReceiptsTransactions` parameter to `true`.\n\n> ๐ \n> \n> 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](https://my-onetrust-com.surrey.idm.oclc.org/s/article/UUID-73ac74f6-edc7-3344-e86e-e810660154e9?topicId=0TO1Q000000ItSSWA0).","tags":["Data Subjects V2"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentAPI_DataSubjectDeleteRequestV2"}}}},"responses":{"200":{"description":"Data Subjects deletion request processed successfully.","content":{"application/json":{"schema":{"type":"string","example":"Deletion Request has been accepted"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentAPI_OAUTH2":["CONSENT"]}]}},"/api/consent/v2/receipts":{"post":{"operationId":"getReceiptListDetailsUsingPOST","summary":"Get List of Receipts","description":"Use this API to retrieve a list of all receipts. Depending on the query or header parameter values passed in the request, the response will return specific details about receipts, including relevant information about collection point interactions, purposes, and the associated purpose preferences and attributes.\n\n> ๐ Things to Know\n> \n> - The timespan between the `fromDate` and `toDate` values must be 24 hours or less.\n> - By default, this API retrieves receipts created within the last 90 days. To retrieve receipts stored for more than 90 days, the `includeArchived` parameter must be used.\n> - When retrieving historic receipts, set `includeArchived=true` and provide either the `receiptId` in the request parameters or the `identifier` in the request headers. Optional parameters such as `includeDataElements`, `includeConsentStrings`, `sort`, `page`, and `nextMarker` can also be used.\n> - If `includeArchived=true` is set and additional parameters such as `fromDate or `toDate` are included, this API will instead search only receipts stored within the last 90 days.\n> - If the number of records exceeds a single page:\n> - The response returns a `requestContinuation` value, which must be included in the next request body to continue pagination.\n> - When retrieving archived receipts, `nextMarker` must also be included in subsequent request bodies to paginate through results.\n> - Purpose descriptions in the API response are returned inside `` and `
` HTML tags. These tags can be sanitized based on your formatting needs.","tags":["Receipts V2"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"parameters":[{"name":"identifier","in":"header","description":"Data Subject Identifier filter. `identifier` can be obtained using the [Get list of datasubjects](/onetrust/reference/getdatasubjectsusingget) endpoint.","required":false,"schema":{"type":"string","example":"8f5f3a5b-4b32-40d3-9c43-69c5ec91f4af"}},{"name":"dataElementName","in":"header","description":"Filter receipts by data element name. Note that this request header must be used in conjunction with dataElementValue.","required":false,"schema":{"type":"string","example":"FirstName"}},{"name":"dataElementValue","in":"header","description":"Filter receipts by data element value. Note that this request header must be used in conjunction with dataElementName.","required":false,"schema":{"type":"string","example":"Alice"}},{"name":"collectionPointGuid","in":"query","description":"UUID of the Collection Point.","required":false,"schema":{"type":"string","format":"uuid","example":"3d9a67f4-d9f2-4f07-8d21-89cf6712e878"}},{"name":"receiptId","in":"query","description":"UUID of the receipt.","required":false,"schema":{"type":"string","format":"uuid","example":"d2c29f4d-fbd9-44d3-9a37-54d85c8aebc7"}},{"name":"purposeGuid","in":"query","description":"UUID of the Purpose. `purposeGuid` can be obtained using the [Get A Paged List Of Purposes](/onetrust/reference/getgroupedpurposesusingget) endpoint.","required":false,"schema":{"type":"string","format":"uuid","example":"b7d17fc8-889f-472e-8c74-f1169821e7e7"}},{"name":"organizationId","in":"query","description":"UUID of the Organization. `organizationId` can be obtained using the [Retrieve Organization Structure](/onetrust/reference/organizationtreestructureusingget) endpoint.","required":false,"schema":{"type":"string","format":"uuid","example":"0b3b36a0-2a63-4f8b-a7e3-37b31fbfcd72"}},{"name":"fromDate","in":"query","description":"Date from which to return records. Formats accepted are yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss.","required":false,"schema":{"type":"string","format":"date-time","example":"2022-07-25T14:00:10"}},{"name":"toDate","in":"query","description":"To date to return records. Formats accepted are yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss.","required":false,"schema":{"type":"string","format":"date-time","example":"2022-07-26T13:20:45"}},{"name":"includeDataElements","in":"query","description":"When set to true will include data subject data elements on the receipt payload.","required":false,"schema":{"type":"boolean","example":true,"default":false}},{"name":"includeArchived","in":"query","description":"This parameter will fetch up to 1000 historical receipts per API call that are not yet stored in the Azure Cosmos DB or those that have reached their time-to-live (TTL) expiration of 90 days.","required":false,"schema":{"type":"boolean","example":true,"default":false}},{"name":"isAnonymous","in":"query","description":"The `isAnonymous` parameter will be ignored. Anonymous receipts can only be returned by using the `identifier` or `receiptId` parameter.","required":false,"schema":{"type":"boolean"},"deprecated":true},{"name":"includeConsentStrings","in":"query","description":"This parameter will return consent strings stored in receipts. Note that it must be used in conjunction with an identifier or receiptId filter.","required":false,"schema":{"type":"boolean","default":false}},{"name":"page","in":"query","description":"Results page to be retrieved (0..N).","schema":{"type":"integer","format":"int32","default":0,"minimum":0},"example":1},{"name":"size","in":"query","description":"Number of records per page (1..50).","schema":{"type":"integer","format":"int32","default":20,"maximum":50,"minimum":1},"example":20},{"name":"sort","in":"query","description":"Sorting criteria in the format: property,direction (where direction is asc or desc). Supported properties: consentCreationDate, interactionDate, id.","schema":{"type":"string","example":"consentCreationDate,asc","default":"consentCreationDate,desc","enum":["consentCreationDate,asc","consentCreationDate,desc"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentAPI_ContinuationToken"}}}},"responses":{"200":{"description":"Successfully retrieved list of receipts.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentAPI_ReceiptInformationDetailSliceDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"string"}}}},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentAPI_OAUTH2":["CONSENT"]}]}},"/api/consent/v2/transactions":{"post":{"operationId":"getTransactionsUsingPOST","summary":"Get List of Transactions","description":"Use this API to retrieve a list of all consent transactions. The response will include information about each transaction, the corresponding consent date, and details of the Purposes and the associated Purpose Preferences that the data subject has interacted with.\n\n> ๐ Things to Know\n> \n> - The timespan for the `fromDate` and `toDate` values must be 24 hours or less.\n> - The `collectionPointAttributes` parameter will be returned as `null` when left blank during normal ingestion (API collection point, webform) and as `{} ` when left blank during bulk import.\n","tags":["Transactions V2"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"parameters":[{"name":"fromDate","in":"query","description":"Retrieve transactions recorded after the specified date. Formats accepted: YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","format":"date-time"},"example":"2024-07-01T12:30:00"},{"name":"toDate","in":"query","description":"Retrieve transactions recorded up to the specified date. Formats accepted: YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","format":"date-time"},"example":"2025-07-02T10:15:40"},{"name":"collectionPointGuid","in":"query","description":"UUID of the Collection Point","required":false,"schema":{"type":"string","format":"uuid"},"example":"f312dd9b-58b4-4f34-b5ff-10b9b464bc4f"},{"name":"page","in":"query","description":"Results page to be retrieved (0..N).","schema":{"type":"integer","format":"int32","default":0,"minimum":0},"example":0},{"name":"size","in":"query","description":"Number of records per page (1..50).","schema":{"type":"integer","format":"int32","default":20,"maximum":50,"minimum":1},"example":20},{"name":"sort","in":"query","description":"Sorting criteria in the format: property,direction (where direction is asc or desc). Supported properties: **consentCreationDate**.","schema":{"type":"string","example":"consentCreationDate,desc","default":"consentCreationDate,desc","enum":["consentCreationDate,asc","consentCreationDate,desc"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentAPI_ContinuationToken"}}}},"responses":{"200":{"description":"Successfully retrieved list of transactions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentAPI_TransactionSliceDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"string"}}}},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentAPI_OAUTH2":["CONSENT","CONSENT_READ"]}]}},"/rest/api/consent/v1/deletion-certificates":{"get":{"operationId":"getListOfDeletionCertificates","summary":"Get List of Deletion Certificates","description":"Use this API to retrieve a paginated list of deletion certificates. Each result contains information about a data subject or receipts deletion certificate. Supports continuation tokens for pagination.","tags":["Deletion Certificates"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"parameters":[{"name":"requestContinuation","in":"header","description":"The token used to paginate a response if the number of records is more than a page.","required":false,"schema":{"type":"string"},"example":"{\\\"compositeToken\\\": \\\"jmxpAKZxe9nZkAoAAAAAAA==\\\"}"},{"name":"identifier","in":"header","description":"The unique identifier for a data subject.","required":true,"schema":{"type":"string"},"example":"example@otprivacy.com"},{"name":"page","in":"query","description":"The page number of the results.","schema":{"type":"integer","default":0,"minimum":0},"example":0},{"name":"size","in":"query","description":"The number of results per page.","schema":{"type":"integer","default":20,"maximum":50,"minimum":1},"example":20}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentAPI_DeletionCertificateSliceDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"string"}}}},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentAPI_OAUTH2":["CONSENT","CONSENT_READ"]}]}},"/rest/api/consent/v1/receipts/cross-device":{"delete":{"operationId":"CrossDeviceConsentUsingDELETE","summary":"Delete Cross Device Consents and Receipts","description":"Use this API to delete cross device consents and the related receipts. This API is designed for users with a CRO license. However, users with both UCPM and CRO licenses, can use the [Delete Data Subjects](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/deletedatasubjectprofileusingdelete) API to delete CRO data subject identifiers.\n\n> ๐ Things to Know\n> \n> - A maximum of 1000 data subject identifiers can be deleted per request. \n> - Requests will be processed asynchronously.","tags":["Consent Rate Optimization"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentAPI_CrossDeviceConsentDeleteRequest"}}}},"responses":{"200":{"description":"Request to delete cross-device consent receipts was accepted.","content":{"application/json":{"schema":{"type":"string","example":"Request accepted"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentAPI_OAUTH2":["COOKIE"]}]}},"/rest/api/consent/v4/data-subjects":{"delete":{"operationId":"deleteDataSubjectUsingTTL","summary":"Delete Data Subject ","description":"Initiates a TTL-based deletion process for a data subject","tags":["data-subject-controller-v-4"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentAPI_DataSubjectDeleteRequestV4"}}}},"responses":{"200":{"description":"Deletion Request using TTL has been accepted","content":{"*/*":{"schema":{"type":"string"}}}},"400":{"description":"Missing retainReceipts flag in the request","content":{"*/*":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Unable to find a datasubject with given identifier","content":{"*/*":{"schema":{"type":"string"}}}},"422":{"description":"Missing identifier(or)additionalidentifier in the request","content":{"*/*":{"schema":{"type":"string"}}}},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentAPI_OAUTH2":["CONSENT"]}]}},"/rest/api/consent/v4/data-subjects/profiles":{"delete":{"operationId":"deletePurposeFromDataSubjectsUsingTTL","summary":"Delete Purposes from Data Subjects","description":"Initiates TTL-based deletion of specific purposes from data subjects","tags":["data-subject-controller-v-4"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentAPI_DeletePurposeFromDataSubjectV4"}}}},"responses":{"200":{"description":"Accepted request to delete purposes from DataSubjects using TTL","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized access","content":{"application/json":{"schema":{"type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Unable to find a datasubject with given identifier","content":{"application/json":{"schema":{"type":"string"}}}},"422":{"description":"Missing identifier(or)additionalidentifier OR missing purposes in the request","content":{"application/json":{"schema":{"type":"string"}}}},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentAPI_OAUTH2":["CONSENT"]}]}},"/rest/api/consent/v4/datasubjects":{"get":{"operationId":"getDataSubjectsV4","summary":"Get List of Data Subjects","description":"Use this API to retrieve a list of data subjects that were last updated between the specified date range. The response will include basic details, such as each data subjectโs identifier, created date, data elements, and last updated date.\n\n> ๐ Things to Know\n> \n> - The maximum date range that can be returned is 7 days.","tags":["Data Subjects V4"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"parameters":[{"name":"fromDate","in":"query","description":"The start of a date and time range used to filter results.","required":true,"schema":{"type":"string","format":"date-time"},"example":"2024-01-01T00:00:00"},{"name":"toDate","in":"query","description":"The end of a date and time range used to filter results.","required":true,"schema":{"type":"string","format":"date-time"},"example":"2024-01-07T23:59:59"},{"name":"isDNCInclude","in":"query","description":"Indicates whether to include data subject in the response if the data subject is in the DNC list.","required":false,"schema":{"type":"boolean","default":false},"example":true},{"name":"requestContinuation","in":"header","description":"The token used to paginate a response if the number of records is more than a page.","required":false,"schema":{"type":"string"},"example":"{\\\"compositeToken\\\": \\\"jmxpAKZxe9nZkAoAAAAAAA==\\\"}"},{"name":"page","in":"query","description":"The page number of the results.","schema":{"type":"integer","default":0,"minimum":0},"example":1},{"name":"size","in":"query","description":"The number of results per page.","schema":{"type":"integer","default":20,"maximum":50,"minimum":1},"example":20},{"name":"sort","in":"query","description":"The sort criteria that dictates the order of the results.","schema":{"type":"string","default":"lastModifiedDate,desc","enum":["lastModifiedDate,asc","lastModifiedDate,desc","createdDate,asc","createdDate,desc"]},"example":"lastModifiedDate,desc"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentAPI_DataSubjectResponseSliceDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"string"}}}},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentAPI_OAUTH2":["CONSENT","CONSENT_READ"]}]}},"/rest/api/consent/v4/datasubjects/basic-details":{"get":{"operationId":"getDataSubjectBasicDetailsV4","summary":"Get Data Subject","description":"Use this API to retrieve a data subjectโs basic details. The response will include details such as the data subjectโs created date, last transaction date, and data elements.","tags":["Data Subjects V4"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"parameters":[{"name":"identifier","in":"header","description":"The data subject identifier of the data subject.","required":true,"schema":{"type":"string"},"example":"example@otprivacy.com"},{"name":"isDNCInclude","in":"query","description":"Indicates whether to include data subject in the response if the data subject is in the DNC list.","required":false,"schema":{"type":"boolean","default":false},"example":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentAPI_DataSubjectResponseDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"string"}}}},"404":{"description":"Data Subject Not Found","content":{"application/json":{"schema":{"type":"string"}}}},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentAPI_OAUTH2":["CONSENT","CONSENT_READ"]}]}},"/rest/api/consent/v4/datasubjects/details":{"get":{"operationId":"getDataSubjectDetailsV4","summary":"Get Data Subject Details","description":"Use this API to retrieve complete details for a specific data subject. The response will include all of the data subjectโs basic details, purpose details, and email link tokens.","tags":["Data Subjects V4"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"parameters":[{"name":"identifier","in":"header","description":"The data subject identifier of the data subject.","required":true,"schema":{"type":"string"},"example":"example@otprivacy.com"},{"name":"includeConsentGroups","in":"query","description":"This flag indicates whether data subject group information is included in the response.","required":false,"schema":{"type":"boolean"},"example":true},{"name":"includeAttachments","in":"query","description":"This flag indicates whether attachment information is included in the response.","required":false,"schema":{"type":"boolean"},"example":true},{"name":"includeNotices","in":"query","description":"This flag indicates whether collection point notice information is included in the response.","required":false,"schema":{"type":"boolean"},"example":true},{"name":"includeConsentStrings","in":"query","description":"This flag indicates whether consent string information is included in the response.","required":false,"schema":{"type":"boolean","default":false},"example":true},{"name":"isDNCInclude","in":"query","description":"Indicates whether to include data subject in the response if the data subject is in the DNC list.","required":false,"schema":{"type":"boolean","default":false},"example":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentAPI_DataSubjectInformationResponseDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"string"}}}},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentAPI_OAUTH2":["CONSENT","CONSENT_READ"]}]}},"/rest/api/consent/v4/datasubjects/ds-profiles":{"get":{"operationId":"getAllProfilesByDataSubjectV4","summary":"Get List of All Purpose Details by Data Subject","description":"Use this API to retrieve a data subjectโs purpose details for all purposes. The response will include all purposes that the data subject interacted with along with details such as status, last transaction date, consent date, and purpose preferences.","tags":["Data Subjects V4"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"parameters":[{"name":"identifier","in":"header","description":"The unique identifier for a data subject.","required":true,"schema":{"type":"string"},"example":"example@otprivacy.com"},{"name":"requestContinuation","in":"header","description":"The token used to paginate a response if the number of records is more than a page.","required":false,"schema":{"type":"string"},"example":"{\\\"compositeToken\\\": \\\"jmxpAKZxe9nZkAoAAAAAAA==\\\"}"},{"name":"page","in":"query","description":"The page number of the results.","schema":{"type":"integer","default":0,"minimum":0},"example":1},{"name":"size","in":"query","description":"The number of results per page.","schema":{"type":"integer","default":20,"maximum":50,"minimum":1},"example":20},{"name":"sort","in":"query","description":"The sort criteria that dictates the order of the results.","schema":{"type":"string","default":"lastUpdatedDate,desc","enum":["lastUpdatedDate,asc","lastUpdatedDate,desc"]},"example":"lastUpdatedDate,desc"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentAPI_DataSubjectProfileResponseSliceDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"string"}}}},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentAPI_OAUTH2":["CONSENT","CONSENT_READ"]}]}},"/rest/api/consent/v4/datasubjects/linktokens":{"get":{"operationId":"getEmailLinkTokenByDataSubjectV4","summary":"Get Data Subject Token","description":"Use this API to retrieve the link token for a specific data subject.","tags":["Magic Link Tokens V4"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"parameters":[{"name":"identifier","in":"header","description":"The data subject identifier of the data subject.","required":true,"schema":{"type":"string"},"example":"example@otprivacy.com"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentAPI_EmailLinkTokenResponseDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"string"}}}},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentAPI_OAUTH2":["CONSENT"]}]}},"/rest/api/consent/v4/datasubjects/profiles":{"get":{"operationId":"getDataSubjectProfilesV4","summary":"Get List of All Purpose Details for All Data Subjects","description":"Use this API to retrieve a list of all purpose details last updated between a specified date range for all data subjects.\n\n> ๐ Things to Know\n> \n> - The maximum date range that can be returned is 7 days. ","tags":["Data Subjects V4"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"parameters":[{"name":"collectionPointId","in":"query","description":"The unique identifier of the collection point.","required":false,"schema":{"type":"string","format":"uuid"},"example":"25d9ccac-db88-4d34-849c-3d602a629961"},{"name":"purposeId","in":"query","description":"The unique identifier of the purpose.","required":false,"schema":{"type":"string","format":"uuid"},"example":"25d9ccac-db88-4d34-849c-3d602a629961"},{"name":"status","in":"query","description":"The status of the purpose for the data subject.","required":false,"schema":{"type":"string","enum":["EXPIRED","WITHDRAWN","NO_CONSENT","PENDING","ACTIVE","OPT_OUT","ALWAYS_ACTIVE","HARD_OPT_OUT","EXTEND","CHANGE_PREFERENCES","NOT_OPT_OUT","OPT_IN","IMPLICIT"]},"example":"ACTIVE"},{"name":"updatedSince","in":"query","description":"The start of a date and time range used to filter results.","required":true,"schema":{"type":"string","format":"date-time"},"example":"2024-01-01T00:00:00"},{"name":"updatedUntil","in":"query","description":"The end of a date and time range used to filter results.","required":true,"schema":{"type":"string","format":"date-time"},"example":"2024-01-07T23:59:59"},{"name":"requestContinuation","in":"header","description":"The token used to paginate a response if the number of records is more than a page.","required":false,"schema":{"type":"string"},"example":"{\\\"compositeToken\\\": \\\"jmxpAKZxe9nZkAoAAAAAAA==\\\"}"},{"name":"page","in":"query","description":"The page number of the results.","schema":{"type":"integer","default":0,"minimum":0},"example":1},{"name":"size","in":"query","description":"The number of results per page.","schema":{"type":"integer","default":20,"maximum":50,"minimum":1},"example":20},{"name":"sort","in":"query","description":"The sort criteria that dictates the order of the results.","schema":{"type":"string","default":"lastUpdatedDate,desc","enum":["lastUpdatedDate,asc","lastUpdatedDate,desc"]},"example":"lastUpdatedDate,desc"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentAPI_DataSubjectProfileResponseSliceDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"string"}}}},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentAPI_OAUTH2":["CONSENT","CONSENT_READ"]}]}},"/rest/api/consent/v4/datasubjects/profiles/unordered":{"get":{"operationId":"getDataSubjectProfilesUnorderedV4","summary":"Get Optimized List of All Purpose Details for All Data Subjects","description":"Use this optimized for high-performance API to retrieve an unsorted list of purpose details last updated between the specified date range for all data subjects.\n\n> ๐ Things to Know\n>\n> - The maximum date range that can be returned is 7 days. \n> - Results are not returned in a specific order and may appear random. \n> - Supports bookmarking for consistent pagination. \n> - Optimized for high-performance bulk retrieval where sorting is not required. \n> - Has more flexible rate limits compared to the standard [Get List of All Purpose Details for All Data Subjects](/onetrust/reference/getdatasubjectprofilesv4) API.","tags":["Data Subjects V4"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"parameters":[{"name":"collectionPointId","in":"query","description":"The unique identifier for a Collection Point.","required":false,"schema":{"type":"string","format":"uuid"},"example":"8f5f3a5b-4b32-40d3-9c43-69c5ec91f4af"},{"name":"purposeId","in":"query","description":"The unique identifier for a Purpose.","required":false,"schema":{"type":"string","format":"uuid"},"example":"25d9ccac-db88-4d34-849c-3d602a629961"},{"name":"status","in":"query","description":"The status of the Purpose for the data subject.","required":false,"schema":{"type":"string","enum":["EXPIRED","WITHDRAWN","NO_CONSENT","PENDING","ACTIVE","OPT_OUT","ALWAYS_ACTIVE","HARD_OPT_OUT","EXTEND","CHANGE_PREFERENCES","NOT_OPT_OUT","OPT_IN","IMPLICIT"]},"example":"ACTIVE"},{"name":"updatedSince","in":"query","description":"The start of a date and time range used to filter results.","required":true,"schema":{"type":"string","format":"date-time"},"example":"2024-01-01T00:00:00"},{"name":"updatedUntil","in":"query","description":"The end of a date and time range used to filter results.","required":true,"schema":{"type":"string","format":"date-time"},"example":"2024-01-07T23:59:59"},{"name":"requestContinuation","in":"header","description":"The token used to paginate a response if the number of records is more than a page.","required":false,"schema":{"type":"string"},"example":"{\\\"compositeToken\\\": \\\"jmxpAKZxe9nZkAoAAAAAAA==\\\"}"},{"name":"page","in":"query","description":"The page number of the results.","schema":{"type":"integer","default":0,"minimum":0},"example":1},{"name":"size","in":"query","description":"The number of results per page.","schema":{"type":"integer","default":20,"maximum":50,"minimum":1},"example":20}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentAPI_DataSubjectProfileResponseSliceDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"string"}}}},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentAPI_OAUTH2":["CONSENT","CONSENT_READ"]}]}},"/rest/api/consent/v4/datasubjects/profiles/{purposeGuid}":{"get":{"operationId":"getDataSubjectProfileV4","summary":"Get Purpose Details by Data Subject","description":"Use this API to retrieve a data subjectโs purpose details for a specific purpose. The response will include details such as the last transaction date, consent date, and purpose preferences.","tags":["Data Subjects V4"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"parameters":[{"name":"identifier","in":"header","description":"The data subject identifier of the data subject.","required":true,"schema":{"type":"string"},"example":"example@otprivacy.com"},{"name":"purposeGuid","in":"path","description":"The unique identifier of the purpose.","required":true,"schema":{"type":"string","format":"uuid"},"example":"25d9ccac-db88-4d34-849c-3d602a629961"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentAPI_DataSubjectProfileResponseDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"string"}}}},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentAPI_OAUTH2":["CONSENT","CONSENT_READ"]}]}},"/rest/api/consent/v4/datasubjects/unordered":{"get":{"operationId":"getDataSubjectsUnorderedV4","summary":"Get Optimized List of Data Subjects","description":"Use this optimized for high-performance API to retrieve a list of unsorted data subjects that were last updated between the specified date range. The response includes key details such as each data subjectโs identifier, created date, data elements, and last updated date.\n\n> ๐ Things to Know\n>\n> - The maximum date range that can be returned is 7 days. \n> - Results are not returned in a specific order and may appear random. \n> - Supports bookmarking for consistent pagination. \n> - Optimized for high-performance bulk retrieval where sorting is not required. \n> - Has more flexible rate limits compared to the standard [Get List of Data Subjects](/onetrust/reference/getdatasubjectsv4) API.","tags":["Data Subjects V4"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"parameters":[{"name":"fromDate","in":"query","description":"The start of a date and time range used to filter results.","required":true,"schema":{"type":"string","format":"date-time"},"example":"2024-01-01T00:00:00"},{"name":"toDate","in":"query","description":"The end of a date and time range used to filter results.","required":true,"schema":{"type":"string","format":"date-time"},"example":"2024-01-07T23:59:59"},{"name":"requestContinuation","in":"header","description":"The token used to paginate a response if the number of records is more than a page.","required":false,"schema":{"type":"string"},"example":"{\\\"compositeToken\\\": \\\"jmxpAKZxe9nZkAoAAAAAAA==\\\"}"},{"name":"page","in":"query","description":"The page number of the results.","schema":{"type":"integer","default":0,"minimum":0},"example":1},{"name":"size","in":"query","description":"The number of results per page.","schema":{"type":"integer","default":20,"maximum":50,"minimum":1},"example":20}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentAPI_DataSubjectResponseSliceDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"string"}}}},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentAPI_OAUTH2":["CONSENT","CONSENT_READ"]}]}},"/rest/api/consent/v4/groups":{"get":{"operationId":"getDataSubjectGroupsListV4","summary":"Get List of Data Subject Groups","description":"Use this API to retrieve a list of Data Subject Groups.","tags":["Data Subject Groups V4"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"parameters":[{"name":"requestContinuation","in":"header","description":"The token used to paginate a response if the number of records is more than a page.","required":false,"schema":{"type":"string"},"example":"{\\\"compositeToken\\\": \\\"jmxpAKZxe9nZkAoAAAAAAA==\\\"}"},{"name":"groupName","in":"header","description":"The name of the Data Subject Group.","required":false,"schema":{"type":"string"},"example":"Marketing Data Subject Group"},{"name":"page","in":"query","description":"The page number of the results.","schema":{"type":"integer","default":0,"minimum":0},"example":1},{"name":"size","in":"query","description":"The number of results per page.","schema":{"type":"integer","default":20,"maximum":50,"minimum":1},"example":20},{"name":"sort","in":"query","description":"The sort criteria that dictates the order of the results.","schema":{"type":"string","default":"createdDate,desc","enum":["createdDate,asc","createdDate,desc"]},"example":"createdDate,desc"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentAPI_LinkedIdentityGroupPageItemSliceDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"string"}}}},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentAPI_OAUTH2":["CONSENT"]}]}},"/rest/api/consent/v4/jobs":{"post":{"operationId":"createJobUsingPOST","summary":"Create Job","description":"Use this API to create a new schedule job for data subject bulk actions.","tags":["Jobs"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentAPI_JobCreateRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentAPI_JobResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"string"}}}},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentAPI_OAUTH2":["CONSENT"]}]}},"/rest/api/consent/v4/linkedidentitygroups":{"get":{"operationId":"getLinkedIdentityGroupsByDataSubjectV4","summary":"Get List of Data Subject Group Associations by Data Subject","description":"Use this API to retrieve details about a data subject's associations with Data Subject Groups.\n\n> ๐ Things to Know\n> \n> - If the `linkedIdentityGroupId` parameter is passed, the response will include details for the data subject's association with the specified Data Subject Group. If not passed, the response will include details for the data subject's associations with all Data Subject Groups in which the data subject is a member.","tags":["Data Subject Groups V4"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"parameters":[{"name":"identifier","in":"header","description":"The data subject identifier of the data subject.","required":true,"schema":{"type":"string"},"example":"example@otprivacy.com"},{"name":"linkedIdentityGroupId","in":"query","description":"The unique identifier of the data subject group.","required":false,"schema":{"type":"string","format":"uuid"},"example":"25d9ccac-db88-4d34-849c-3d602a629961"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ConsentAPI_LinkedIdentityGroupDto"}}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"string"}}}},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentAPI_OAUTH2":["CONSENT"]}]},"post":{"operationId":"createDataSubjectGroupV4","summary":"Create Data Subject Group","description":"Use this API to create a new Data Subject Group.\n\n> ๐ Things to Know\n>\n> - Data Subject Groups must contain at least one primary data subject identifier and two data subjects.","tags":["Data Subject Groups V4"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentAPI_LinkedIdentityGroupRequestDto"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentAPI_LinkedIdentityGroupResponseDto"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"string"}}}},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentAPI_OAUTH2":["CONSENT"]}]}},"/rest/api/consent/v4/linkedidentitygroups/{dataSubjectGroupId}":{"put":{"operationId":"updateDataSubjectGroupV4","summary":"Update Data Subject Group","description":"Use this API to update an existing Data Subject Group.\n\n> ๐ Things to Know\n>\n> - Data Subject Groups must contain at least one primary data subject identifier and two data subjects.\n> - To update the Data Subject Group name, use the `groupName` parameter and enter a new name different from the one already in use.","tags":["Data Subject Groups V4"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"parameters":[{"name":"dataSubjectGroupId","in":"path","description":"The unique identifier for the Data Subject Group to be updated.","required":true,"schema":{"type":"string","format":"uuid"},"example":"25d9ccac-db88-4d34-849c-3d602a629961"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentAPI_LinkedIdentityGroupRequestDto"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentAPI_LinkedIdentityGroupResponseDto"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"string"}}}},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentAPI_OAUTH2":["CONSENT"]}]}},"/rest/api/consent/v4/linkedidentitygroups/{dataSubjectGroupId}/members":{"get":{"operationId":"getLinkedIdentityGroupMembersV4","summary":"Get List of Data Subject Group Members","description":"Use this API to retrieve a list of all members of a data subject group.","tags":["Data Subject Groups V4"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"parameters":[{"name":"dataSubjectGroupId","in":"path","description":"The unique identifier for a Data Subject Group.","required":true,"schema":{"type":"string","format":"uuid"},"example":"25d9ccac-db88-4d34-849c-3d602a629961"},{"name":"requestContinuation","in":"header","description":"The token used to paginate a response if the number of records is more than a page.","required":false,"schema":{"type":"string"},"example":"{\\\"compositeToken\\\": \\\"jmxpAKZxe9nZkAoAAAAAAA==\\\"}"},{"name":"page","in":"query","description":"The page number of the results.","schema":{"type":"integer","default":0,"minimum":0},"example":0},{"name":"size","in":"query","description":"The number of results per page.","schema":{"type":"integer","default":20,"maximum":50,"minimum":1},"example":20},{"name":"sort","in":"query","description":"The sort criteria that dictates the order of the results.","schema":{"type":"string","enum":["addedDate,asc","addedDate,desc"]},"example":"addedDate,desc"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentAPI_LinkedIdentityGroupDtoSliceDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"string"}}}},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentAPI_OAUTH2":["CONSENT"]}]}},"/rest/api/consent/v4/linktokens":{"get":{"operationId":"getEmailLinkTokensListV4","summary":"Get List of Data Subject Tokens","description":"Use this API to retrieve a list of link tokens created between a specified date range for all data subjects.\n\n> ๐ Things to Know\n> \n> - The maximum date range that can be returned is 7 days.","tags":["Magic Link Tokens V4"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"parameters":[{"name":"fromDate","in":"query","description":"The start of a date and time range used to filter results.","required":true,"schema":{"type":"string","format":"date-time"},"example":"2024-01-01T00:00:00"},{"name":"toDate","in":"query","description":"The end of a date and time range used to filter results.","required":true,"schema":{"type":"string","format":"date-time"},"example":"2024-01-07T23:59:59"},{"name":"requestContinuation","in":"header","description":"The token used to paginate a response if the number of records is more than a page.","required":false,"schema":{"type":"string"},"example":"{\\\"compositeToken\\\": \\\"jmxpAKZxe9nZkAoAAAAAAA==\\\"}"},{"name":"page","in":"query","description":"The page number of the results.","schema":{"type":"integer","default":0,"minimum":0},"example":0},{"name":"size","in":"query","description":"The number of results per page.","schema":{"type":"integer","default":20,"maximum":50,"minimum":1},"example":20},{"name":"sort","in":"query","description":"The sort criteria that dictates the order of the results.","schema":{"type":"string","default":"expiryDate,asc","enum":["expiryDate,asc","expiryDate,desc"]},"example":"expiryDate,desc"}],"responses":{"200":{"description":"OK\n\nList of Email Link Tokens retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentAPI_EmailLinkTokenSliceDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"string"}}}},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"ConsentAPI_OAUTH2":["CONSENT"]}]}},"/rest/api/preferences/v1/attachments":{"post":{"operationId":"uploadConsentAttachments","summary":"Upload Consent Attachment","description":"Use this API to upload and store files which contain written consent of data subjects' transactions.\n\n> ๐ Things to Know\n> \n> - The size of uploaded files must be less than 4MB.\n> \n> - The following file formats are allowed: .pdf, .jpeg, .jpg, and .png.\n> \n> - The `RefID` parameter returned within the response body can be used to attach file references to incoming data subject consents using the [Create Consent Receipts](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/createconsentreceiptusingpost) API.\n> \n> - File references can be attached to a given data subject or data subject purpose by using the `attachments` or `PurposeAttachments` parameters in the [Create Consent Receipts](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/createconsentreceiptusingpost) API respectively.","tags":["Consent Attachments"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"description":"The file to upload. Supported formats: .pdf, .jpeg, .jpg, .png. Max size: 4MB.","type":"string","format":"binary"}},"required":["file"]}}}},"responses":{"200":{"description":"File uploaded successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DSPreferneceCache_UploadDataDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"DSPreferneceCache_OAUTH2":["CONSENT"]}]}},"/rest/api/preferences/v1/attachments/{attachmentId}":{"get":{"operationId":"downloadGivenConsentAttachments","summary":"Download Consent Attachment","description":"Use this API to download a specific file reference attached to a given data subject. The file will be downloaded in .zip format.\n\n > ๐ Things to Know\n > \n > - The `attachmentId` parameter value corresponds to the `RefId` parameter value returned after uploading a file using the [Upload Consent Attachment](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/uploadconsentattachments) API.","tags":["Consent Attachments"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"parameters":[{"name":"attachmentId","in":"path","description":"Unique `refId` UUID of the file to be downloaded.","required":true,"schema":{"type":"string","format":"uuid"},"example":"550e8400-e29b-41d4-a716-446655440000"},{"name":"identifier","in":"header","description":"The identifier of the data subject.","required":true,"schema":{"type":"string"},"example":"user@example.com"}],"responses":{"200":{"description":"ZIP file containing the requested attachment.","content":{"application/zip":{"schema":{"description":"Binary content of the ZIP file containing the requested attachment.","type":"string","format":"binary"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"DSPreferneceCache_OAUTH2":["CONSENT","CONSENT_READ"]}]}},"/rest/api/preferences/v1/attachments-reference/{attachmentId}":{"delete":{"operationId":"removeGivenConsentAttachmentRefs","summary":"Remove Consent Attachment","description":"Use this API to remove a specific file reference attached to a given data subject.\n\n> ๐ Things to Know\n> \n> - The `attachmentId` parameter value corresponds to the `RefId` parameter value returned after uploading a file using the [Upload Attachments](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/uploadconsentattachments) API.","tags":["Consent Attachments"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"parameters":[{"name":"attachmentId","in":"path","description":"Unique referenceId `refId` UUID of the file which has to removed from Data Subject.","required":true,"schema":{"type":"string","format":"uuid"},"example":"550e8400-e29b-41d4-a716-446655440000"},{"name":"identifier","in":"header","description":"The identifier of the data subject.","required":true,"schema":{"type":"string"},"example":"user@example.com"}],"responses":{"202":{"description":"Attachment reference deletion request accepted for processing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DSPreferneceCache_ConsentAttachmentReferencesResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"DSPreferneceCache_OAUTH2":["CONSENT"]}]}},"/rest/api/preferences/v1/datasubjects/{identifier}/attachment-references":{"delete":{"operationId":"removeAllConsentAttachmentRefs","summary":"Remove All Consent Attachments","description":"Use this API to remove all file references attached to a given data subject.","tags":["Consent Attachments"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"parameters":[{"name":"identifier","in":"path","description":"The identifier of the data subject.","required":true,"schema":{"type":"string"},"example":"user@example.com"}],"responses":{"202":{"description":"All attachment references deletion request accepted for processing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DSPreferneceCache_ConsentAttachmentReferencesResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"DSPreferneceCache_OAUTH2":["CONSENT"]}]}},"/rest/api/preferences/v1/datasubjects/{identifier}/attachments":{"get":{"operationId":"downloadConsentAttachments","summary":"Download All Consent Attachments","description":"Use this API to retrieve all available file references attached to a given data subject. The files will be downloaded in .zip format.","tags":["Consent Attachments"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"parameters":[{"name":"identifier","in":"path","description":"The identifier of the data subject.","required":true,"schema":{"type":"string"},"example":"user@example.com"}],"responses":{"200":{"description":"ZIP file containing all attachments.","content":{"application/zip":{"schema":{"description":"Binary content of the ZIP file containing all the data subject's attachments.","type":"string","format":"binary"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"DSPreferneceCache_OAUTH2":["CONSENT","CONSENT_READ"]}]}},"/rest/api/preferences/v3/datasubject-profiles":{"get":{"operationId":"getV3DatasubjectProfilesUsingPOST","summary":"Get List of Data Subjects","description":"> โ๏ธ Migration Recommendation\n> \n> Please, do not adopt this API if you have not already done so. Continue to use the [Get List of Data Subjects](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/getdatasubjectprofileusingget) V1 API or request access to have Data Subjects V4 APIs enabled.\n\nUse this API to retrieve a list of all data subjects. Depending on the query or header parameter values passed in the request, the response will return specific details about data subjects, including relevant information about the latest Collection Point update.\n\n> ๐ Things to Know\n> \n> - This API can also be used to retrieve the magic link token as `linkToken` in the response.\n> \n> - The `identifier` header parameter can be used to return information for a single data subject.\n> \n> - This API is designed to remain available during maintenance periods.\n>\n> - This API is not designed to be used in workflows.","tags":["Data Subjects V3"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"parameters":[{"name":"updatedSince","in":"query","description":"The start of a date and time range used to filter data subject records/results that were last updated after the specified timestamp. The accepted format is yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss.","required":false,"schema":{"type":"string","format":"date-time"},"example":"2023-01-01T00:00:00Z"},{"name":"updatedUntil","in":"query","description":"The end of a date and time range used to filter data subject records/results that were last updated before the specified timestamp. The accepted format is yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss.","required":false,"schema":{"type":"string","format":"date-time"},"example":"2023-12-31T23:59:59Z"},{"name":"collectionPointGuid","in":"query","description":"UUID of the Collection Point.","required":false,"schema":{"type":"string","format":"uuid"},"example":"550e8400-e29b-41d4-a716-446655440000"},{"name":"purposeGuid","in":"query","description":"UUID of the Purpose. `purposeGuid` can be obtained using the [Get A Paged List Of Purposes](/onetrust/reference/getgroupedpurposesusingget) endpoint.","required":false,"schema":{"type":"string","format":"uuid"},"example":"550e8400-e29b-41d4-a716-446655440001"},{"name":"identifier","in":"header","description":"Filter by data subject identifier.","required":false,"schema":{"type":"string"},"example":"user@example.com"},{"name":"dataElementName","in":"header","description":"Name of the data element to filter by.","required":false,"schema":{"type":"string"},"example":"firstName"},{"name":"dataElementValue","in":"header","description":"Value of the data element to filter by.","required":false,"schema":{"type":"string"},"example":"John"},{"name":"requestContinuation","in":"header","description":"RequestContinuation token which should be used to navigate to the next page.","required":false,"schema":{"type":"string"},"example":"eyJwYWdlTnVtYmVyIjoxLCJwYWdlU2l6ZSI6MTB9"},{"name":"page","in":"query","description":"Page number for pagination (zero-indexed).","schema":{"type":"integer","default":0,"minimum":0},"example":0},{"name":"size","in":"query","description":"Number of records per page up to 2000 records per page. If a value above 2000 is used, only the first 2000 records will be returned.","schema":{"type":"integer","default":20,"maximum":100,"minimum":1},"example":20},{"name":"sort","in":"query","description":"Sorting criteria in the format: property,direction (where direction is asc or desc). Supported properties: lastUpdatedDate, createdDate.","schema":{"type":"string","default":"lastUpdatedDate,desc","enum":["lastUpdatedDate,asc","lastUpdatedDate,desc"]},"example":"lastUpdatedDate,desc"}],"responses":{"200":{"description":"List of data subjects retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DSPreferneceCache_DataSubjectProfilesSliceDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"DSPreferneceCache_OAUTH2":["CONSENT","CONSENT_READ"]}]}},"/rest/api/preferences/v3/datasubjects/profile":{"get":{"operationId":"getV3DatasubjectsProfileUsingGet","summary":"Get Data Subject","description":"> โ๏ธ Migration Recommendation\n> \n> Please, do not adopt this API if you have not already done so. Continue to use the [Get List of Data Subjects](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/getdatasubjectprofileusingget) V1 API or request access to have Data Subjects V4 APIs enabled.\n\nUse this API to retrieve a single data subject using the `identifer` header parameter.\n\n> ๐ Things to Know\n> \n> - This API can also be used to retrieve the magic link token as `linkToken` in the response.\n> - This API will remain available during maintenance periods.\n> - This API is not designed to be used in workflows.","tags":["Data Subjects V3"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"},"parameters":[{"name":"identifier","in":"header","description":"Data subject to return details for.","required":true,"schema":{"type":"string"},"example":"johndoe@onetrust.com"},{"name":"includeInstantLinkToken","in":"query","description":"Includes the data subject's instant link token in the response that is used to login to the preference center.","required":false,"schema":{"type":"boolean"},"example":false},{"name":"isDNCInclude","in":"query","description":"Includes whether the data subject's phone numbers are on the FTC Do Not Call registry or not.","required":false,"schema":{"type":"boolean"},"example":false}],"responses":{"200":{"description":"Data subject details retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DSPreferneceCache_DataSubjectProfileDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"DSPreferneceCache_OAUTH2":["CONSENT","CONSENT_READ"]}]}}},"components":{"schemas":{"ConsentPreferences-UniversalConsentPreferenceManag_LinkedIdentityGroupRequest_Detailed":{"type":"object","properties":{"identifiers":{"description":"A list of all the Data Subject identifiers to be added to the group; must be at least 2","type":"array","items":{"type":"string"},"example":["example@otprivacy.com","example@onetrust.com"],"maxItems":2147483647,"minItems":2},"primaryIdentifier":{"description":"List of all primary Data Subject identifiers of the group; must be contained in the identifiers list","type":"array","items":{"type":"string"},"example":["example@otprivacy.com"],"maxItems":2147483647,"minItems":1},"groupName":{"description":"Name of the Linked Identity Group","type":"string","example":"Customer Support Group"}}},"ConsentPreferences-UniversalConsentPreferenceManag_DataSubjectEntry_Detailed":{"properties":{"id":{"description":"Unique identifier of the Data Subject","type":"string","format":"uuid","example":"c43a9190-ffd6-4be3-aeff-95b46d0fa59f"},"identifier":{"description":"The identifier value of the Data Subject","type":"string","example":"example@otprivacy.com"},"identifierType":{"description":"The type of identifier used for the Data Subject (e.g., Email, Phone, CustomID)","type":"string","example":"Email"},"isPrimary":{"description":"Boolean flag that denotes if the Data Subject is the primary of the group","type":"boolean","example":false},"canBePrimary":{"description":"Boolean flag that denotes if the Data Subject is allowed to be the group primary","type":"boolean","example":false},"addedDate":{"description":"The date that the Data Subject was added to the group","type":"string","format":"date-time","example":"2020-05-30T12:23:42.145Z"},"numberOfLinkedGroups":{"description":"The number of Other Linked Groups the Data Subject is a member of","type":"integer","format":"int64","example":2},"magicLinkToken":{"description":"Authentication token used for magic link functionality","type":"string","example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."},"magicLinkTokenEncoded":{"description":"URL-encoded version of the magic link token for direct use in URLs","type":"string","example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."},"organizations":{"description":"Set of organization UUIDs associated with this Data Subject","type":"array","items":{"type":"string","format":"uuid","description":"Set of organization UUIDs associated with this Data Subject"},"example":["550e8400-e29b-41d4-a716-446655440000"],"uniqueItems":true}},"required":["identifier","identifierType"]},"ConsentPreferences-UniversalConsentPreferenceManag_LinkedIdentityGroupDto_Detailed":{"type":"object","properties":{"id":{"description":"Globally unique identifier of a Linked Identity Group","type":"string","format":"uuid","example":"b0a6b5da-4ea2-4a9f-a25a-fb3e212efc30"},"createdDate":{"description":"Creation date of a Linked Identity Group","type":"string","format":"date-time","example":"2020-05-30T10:52:30.974Z"},"primaryDataSubject":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_DataSubjectEntry_Detailed"},"primaryDataSubjects":{"description":"List of primary Data Subjects in the Linked Identity Group","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_DataSubjectEntry_Detailed"}},"dataSubjects":{"description":"A list of all the linked Data Subjects in the group","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_DataSubjectEntry_Detailed"}},"groupName":{"description":"The name of the linked identity group","type":"string","example":"Customer Group A"}}},"ConsentPreferences-UniversalConsentPreferenceManag_WithdrawOnBehalfOfRequest":{"type":"object","properties":{"Notes":{"description":"Additional notes to be recorded as part of withdrawal","type":"string","example":"Withdrawing consent as per data subject request"},"PurposeId":{"description":"Unique identifier of the purpose for which consent is being withdrawn","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"Origin":{"description":"Source or origin of the withdrawal request (e.g., IMPORT, API, SDK, ONETRUST, PREFERENCE_CENTER)","type":"string","example":"API"}},"required":["PurposeId"]},"ConsentPreferences-UniversalConsentPreferenceManag_TransactionWithdrawResult":{"type":"object","properties":{"Status":{"description":"Message representing the consent withdrawal status","type":"string","example":"Consent withdrawn successfully"}}},"ConsentPreferences-UniversalConsentPreferenceManag_AssociatedAttributeValueInformation":{"properties":{"id":{"description":"Unique identifier for the attribute option","type":"string","format":"uuid","example":"a34ccec7-1ec0-4d65-9075-bdd0d923f1d1"},"value":{"description":"Attribute value","type":"string","example":"Text Value"},"valueKey":{"description":"Translation key used for localizing the value","type":"string","example":"attribute.option.valueKey"},"colorCode":{"description":"Color code associated with the option. Used for score-based attributes.","type":"string","example":"red"}},"required":["value"]},"ConsentPreferences-UniversalConsentPreferenceManag_AttributeValueInformation":{"properties":{"id":{"description":"Unique identifier for the attribute option","type":"string","format":"uuid","example":"a34ccec7-1ec0-4d65-9075-bdd0d923f1d1"},"value":{"description":"Attribute value","type":"string","example":"Text Value"},"valueKey":{"description":"Translation key used for localizing the value","type":"string","example":"attribute.option.valueKey"},"colorCode":{"description":"Color code associated with the option. Used for score-based attributes.","type":"string","example":"red"},"optionSelectionValue":{"description":"Selection score value linked to the option. Used for score-based or numerical-based attributes.","type":"string","example":"\"3.5\""},"displayLabel":{"description":"Display name for the option, used for external attributes managed by other systems","type":"string","example":"United State | San Francisco"},"associatedAttributeValueInformation":{"description":"Associated attribute option information","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_AssociatedAttributeValueInformation"}},"disabled":{"description":"Indicates whether this attribute option is currently disabled.","type":"boolean","example":false,"default":false}},"example":"a2229953-b4b5-4042-8cb9-b78038cc4c46","required":["value"]},"ConsentPreferences-UniversalConsentPreferenceManag_EditPurposeDto":{"type":"object","properties":{"Organizations":{"description":"A list of External Organization Ids.","type":"array","items":{"type":"string"},"example":["Organization Id-1","Organization Id-2"]},"Name":{"description":"Name of the Purpose","type":"string","example":"Marketing Communications"},"Description":{"description":"Detailed description of the Purpose's intended use","type":"string","example":"Collect customer emails for marketing purposes"},"ConsentLifeSpan":{"description":"The lifespan of consents recorded against this purpose in seconds","type":"integer","format":"int64","example":7889238},"DefaultLanguage":{"description":"The default language for the Purpose in BCP 47 format","type":"string","example":"en-us"},"Type":{"description":"Type of the Purpose","type":"string","example":"STANDARD","enum":["STANDARD","COOKIE","IAB","MOBILE","NOTIFICATION_OPT_OUT"]},"ParentPurposeId":{"description":"Unique identifier of the parent purpose","type":"string","format":"uuid","example":"ba54eb25-90f0-4633-ab12-c7bf5afdd856"},"attributeValues":{"description":"Map of attribute values associated with the purpose","type":"object","additionalProperties":{"type":"array","description":"Map of attribute values associated with the purpose","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_AttributeValueInformation"}}},"EnableGeolocation":{"description":"Flag to enable geolocation tracking for this purpose","type":"boolean","example":false},"CustomPreferenceIds":{"description":"List of custom preference IDs associated with the purpose","type":"array","items":{"type":"string","format":"uuid","description":"List of custom preference IDs associated with the purpose"},"example":["f2229953-b4b5-4042-8cb9-b78038cc4c46","bc4836e2-c117-461b-a7a2-2b268c037a97"]},"ImplicitConsentLifeSpan":{"description":"Lifespan for implicit consents in seconds","type":"integer","format":"int64","example":31536000},"ImplicitConsentConfirmDesc":{"description":"Description shown when confirming implicit consent","type":"string","example":"By continuing, you agree to our terms and conditions"},"HardOptOutDisplayFormat":{"description":"The format in which the purpose displays in a Trust Center when the consent status is Hard opt-out. Hard opt-out purposes can either be displayed but locked, or hidden.","type":"string","example":"HIDE","enum":["HIDE","LOCK"]},"PurposeCategory":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_AttributeValueInformation"},"LastMajorVersion":{"description":"Version number of the last major update","type":"integer","format":"int64","example":2},"VersionNotes":{"description":"Release notes for the current version","type":"string","example":"Updated purpose description and consent lifespan"},"IsMajorVersion":{"description":"Indicates if this is a major version update","type":"boolean","example":false},"HardOptOutMessage":{"description":"The message to display with the purpose when the consent status is Hard opt-out. This message only displays when hardOptOutDisplayFormat is set to LOCK.","type":"string","example":"This purpose is required and cannot be opted out"},"Status":{"description":"The current status of the Purpose","type":"string","example":"ACTIVE","enum":["DRAFT","ACTIVE","RETIRED"]},"Languages":{"description":"List of language-specific details for the Purpose","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PurposeLanguageDto"}},"TopicIds":{"description":"List of unique identifiers for Topics associated with this Purpose","type":"array","items":{"type":"string","format":"uuid"},"example":["712a1f61-a548-432f-afc4-5a383c28eeb2","987b1f51-a538-122e-afc4-6b383c28eeb3"]},"Version":{"description":"Version number of the Purpose being updated","type":"integer","format":"int64","example":2,"minimum":1},"ExpiryDateType":{"description":"Date field considered for Purpose lifespan/expiry","type":"string","example":"LAST_TRANSACTION_DATE","enum":["LAST_TRANSACTION_DATE","CONSENT_DATE"]}},"required":["ConsentLifeSpan","Description","Name","Status","Version"]},"ConsentPreferences-UniversalConsentPreferenceManag_PurposeLanguageDto":{"properties":{"Name":{"description":"The Purpose name","type":"string","example":"Marketing Communications"},"Description":{"description":"The Purpose description","type":"string","example":"Collect customer emails for marketing purposes"},"Description of Implicit Purpose Confirmation checkbox":{"description":"The Implicit Purpose Confirmation checkbox description","type":"string","example":"I can confirm"},"Language":{"description":"The Purpose content language code","type":"string","example":"en-us"},"Default":{"description":"Whether this language is the default one for the Purpose","type":"boolean","example":true},"HardOptOutMessage":{"description":"The message to display with the purpose when the consent status is Hard opt-out. This message only displays when hardOptOutDisplayFormat is set to LOCK.","type":"string","example":"This purpose is required and cannot be opted out"}},"required":["Description","Name"]},"ConsentPreferences-UniversalConsentPreferenceManag_CustomPreferenceOptionDto":{"properties":{"Id":{"description":"Unique Identifier identifying an Option","type":"string","format":"uuid","example":"ca0fc41b-b28a-4335-804c-44d1f0f782ed"},"Label":{"description":"The Option label","type":"string","example":"Weekly"},"Order":{"description":"The order of the option, Starts from 0","type":"integer","format":"int32","example":1},"IsDefault":{"description":"Whether the Option is default option or not","type":"boolean","example":true},"CanDelete":{"description":"Whether the Option can be deleted or not","type":"boolean","example":true},"Disabled":{"description":"Whether Custom Preference is disabled or not","type":"boolean","example":false}}},"ConsentPreferences-UniversalConsentPreferenceManag_PurposeCustomPreferenceDto":{"properties":{"Id":{"description":"Unique identifier for the Custom Preference","type":"string","format":"uuid","example":"194e0d3b-0ba8-4bc7-b046-e3ae42b2bd25"},"Name":{"description":"The display name of the Custom Preference","type":"string","example":"Email Frequency","maxLength":255,"minLength":1},"Description":{"description":"Detailed description explaining the purpose and usage of this Custom Preference","type":"string","example":"Options for different frequencies to receive emails","maxLength":1000},"SelectionType":{"description":"Defines how options can be selected in this Custom Preference","type":"string","example":"SINGLE_CHOICE","enum":["SINGLE_CHOICE","MULTI_CHOICE","SINGLE_CHOICE","MULTI_CHOICE"]},"DisplayAs":{"description":"Specifies how the preference options should be displayed in the UI","type":"string","example":"BUTTONs","enum":["BUTTONS","CHECKBOXES","BUTTONs","CHECKBOXES","DROPDOWN","RADIO_BUTTONS"]},"CreatedDate":{"description":"Timestamp when the Custom Preference was created","type":"string","format":"date-time","example":"2023-01-15T10:52:30.974Z"},"UpdatedDate":{"description":"Timestamp when the Custom Preference was last updated","type":"string","format":"date-time","example":"2023-01-15T10:55:30.974Z"},"NumberOfOptions":{"description":"Total number of available options for this Custom Preference","type":"integer","format":"int64","example":4,"minimum":0},"Required":{"description":"Indicates whether a response is mandatory for this Custom Preference","type":"boolean","example":false,"default":false},"NumberOfLanguages":{"description":"Number of languages this Custom Preference has been translated into","type":"integer","format":"int64","example":3,"minimum":0},"DefaultLanguage":{"description":"The default language code for this Custom Preference (BCP 47 format)","type":"string","example":"en-us","pattern":"^[a-z]{2}(-[A-Z]{2})?$"},"Disabled":{"description":"Indicates if this Custom Preference is currently disabled","type":"boolean","example":false,"default":false},"Options":{"description":"List of available options for this Custom Preference","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_CustomPreferenceOptionDto"}},"Languages":{"description":"List of language configurations for this Custom Preference","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_CustomPreferenceLanguageDto"}},"Organizations":{"description":"List of Organization IDs that have access to this Custom Preference","type":"array","items":{"type":"string","format":"uuid","example":"712a1f61-a548-432f-afc4-5a383c28eeb2"}},"TotalLinkedActivePurposes":{"description":"Count of active purposes that reference this Custom Preference","type":"integer","format":"int64","example":5,"minimum":0},"PurposeCustomPreferenceId":{"description":"Unique identifier of the Purpose and Custom Preference relation","type":"string","format":"uuid","example":"c4a57a38-3774-45ad-9fa4-dbc545542232"}},"required":["DisplayAs","Id","Name","SelectionType"]},"ConsentPreferences-UniversalConsentPreferenceManag_PurposeDetailsDto":{"properties":{"Id":{"description":"Globally unique identifier of the Purpose","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"Label":{"description":"Name of the Purpose","type":"string","example":"Marketing Communications"},"Description":{"description":"Detailed description of the Purpose's intended use","type":"string","example":"Collect customer emails for marketing purposes"},"Status":{"description":"Status of the Purpose","type":"string","example":"ACTIVE","enum":["DRAFT","ACTIVE","RETIRED"]},"Version":{"description":"Current version of the Purpose","type":"integer","format":"int64","example":2},"RetireOnDate":{"description":"Date when the purpose will be retired","type":"string","format":"date-time","example":"2025-12-31T23:59:59Z"},"ParentPurposeId":{"description":"Unique identifier of the parent purpose","type":"string","format":"uuid","example":"ba54eb25-90f0-4633-ab12-c7bf5afdd856"},"ExternalReference":{"description":"External reference identifier for the purpose","type":"string","example":"EXT-REF-12345"},"PurposeType":{"description":"Type of the purpose","type":"string","example":"STANDARD","enum":["STANDARD","COOKIE","IAB","MOBILE","NOTIFICATION_OPT_OUT"]},"ConsentLifeSpan":{"description":"Lifespan of the consent in seconds","type":"integer","format":"int64","example":7776000},"ImplicitConsentLifeSpan":{"description":"Lifespan for implicit consents in seconds","type":"integer","format":"int64","example":31536000},"ImplicitConsentConfirmDesc":{"description":"Description shown when confirming implicit consent","type":"string","example":"By continuing, you agree to our terms and conditions"},"PurposeCategory":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_AttributeValueInformation"},"Languages":{"description":"List of languages supported by the purpose","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PurposeLanguageDto"}},"Topics":{"description":"List of topics associated with the purpose","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PurposeTopicDto"}},"CustomPreferences":{"description":"List of custom preferences associated with the purpose","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PurposeCustomPreferenceDto"}},"ExpiryDateType":{"description":"Date field considered for purpose lifespan/expiry","type":"string","example":"LAST_TRANSACTION_DATE","enum":["LAST_TRANSACTION_DATE","CONSENT_DATE"]},"attributeValues":{"description":"Map of attribute values associated with the purpose","type":"object","additionalProperties":{"type":"array","description":"Map of attribute values associated with the purpose","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_AttributeValueInformation"}}},"IsMajorVersion":{"type":"boolean"},"HardOptOutDisplayFormat":{"description":"The format in which the purpose displays in a Trust Center when the consent status is Hard opt-out. Hard opt-out purposes can either be displayed but locked, or hidden.","type":"string","example":"HIDE","enum":["HIDE","LOCK"]},"attributes":{"description":"Additional attributes attached to the purpose","type":"object","additionalProperties":{"type":"array","description":"Additional attributes attached to the purpose","items":{"type":"string","description":"Additional attributes attached to the purpose"}}},"EnableGeolocation":{"description":"Flag to enable geolocation tracking for this purpose","type":"boolean","example":false},"LastMajorVersion":{"description":"Last major version number of the purpose","type":"integer","format":"int64","example":2},"VersionNotes":{"description":"Notes about the current version of the purpose","type":"string","example":"Updated to include new data retention policies"},"HardOptOutMessage":{"description":"The message to display with the purpose when the consent status is Hard opt-out. This message only displays when hardOptOutDisplayFormat is set to LOCK.","type":"string","example":"This purpose is required and cannot be opted out"}}},"ConsentPreferences-UniversalConsentPreferenceManag_PurposeTopicDto":{"properties":{"Id":{"description":"The unique identifier of the Purpose and Topic relation","type":"string","format":"uuid","example":"497c4383-2c61-4906-aed0-660e3fd03ef0"},"Name":{"description":"The Topic name","type":"string","example":"Car Marketing"},"IntegrationKey":{"description":"The Topic integration key (combination of Purpose and Topic names)","type":"string","example":"Marketing-Communications_Car-Marketing"},"CanDelete":{"description":"Whether this Topic can be deleted or not","type":"boolean","example":true}}},"ConsentPreferences-UniversalConsentPreferenceManag_PagePurposeDetailsDto":{"type":"object","properties":{"content":{"description":"The list of items for the current page.","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PurposeDetailsDto"},"type":"array"},"empty":{"description":"The flag to check if the entity is empty or not.","type":"boolean","example":false},"first":{"description":"The flag to check if the entity is first entity or not.","type":"boolean","example":true},"last":{"description":"The flag to check if the entity is last entity or not.","type":"boolean","example":false},"number":{"description":"The number associated with the result.","type":"integer","format":"int32","example":0},"numberOfElements":{"description":"Total number of elements in the result.","type":"integer","format":"int32","example":20},"pageable":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PageableObject"},"sort":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_SortObject"},"totalPages":{"description":"Total number of pages in the result list.","type":"integer","format":"int32","example":5},"totalElements":{"description":"Total number of elements in the result.","type":"integer","format":"int64","example":50},"size":{"description":"Size of the result list.","type":"integer","format":"int32","example":20}}},"ConsentPreferences-UniversalConsentPreferenceManag_PageableObject":{"properties":{"offset":{"type":"integer","format":"int64"},"sort":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_SortObject"},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"paged":{"type":"boolean"},"unpaged":{"type":"boolean"}}},"ConsentPreferences-UniversalConsentPreferenceManag_SortObject":{"properties":{"empty":{"type":"boolean"},"unsorted":{"type":"boolean"},"sorted":{"type":"boolean"}}},"ConsentPreferences-UniversalConsentPreferenceManag_DataSubjectCustomPreferenceOptionDto":{"properties":{"Id":{"type":"string","format":"uuid"}}},"ConsentPreferences-UniversalConsentPreferenceManag_DataSubjectCustomPreferencesDto":{"properties":{"Id":{"type":"string","format":"uuid"},"Options":{"type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_DataSubjectCustomPreferenceOptionDto"}}}},"ConsentPreferences-UniversalConsentPreferenceManag_DataSubjectPreferencesRequestDto":{"type":"object","properties":{"Purposes":{"description":"List of Data Subject Purposes with their consent status","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_DataSubjectPurposesRequestDto"}},"DsDataElements":{"description":"Map of Data Subject Elements and their values. Maximum supported characters for a data element value is 750.","type":"object","example":{"First Name":"John","Last Name":"Doe"},"additionalProperties":{"type":"object","description":"Map of Data Subject Elements and their values. Maximum supported characters for a data element value is 750.","example":{"First Name":"John","Last Name":"Doe"}}},"Language":{"description":"The preferred language of the Data Subject in BCP 47 format","type":"string","example":"en-us"},"dsDataElements":{"type":"object","additionalProperties":{"type":"object"},"writeOnly":true}},"required":["Purposes"]},"ConsentPreferences-UniversalConsentPreferenceManag_DataSubjectPurposesRequestDto":{"properties":{"Id":{"description":"Unique Identifier of the Purpose","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"Topics":{"description":"List of Topics associated with the Purpose and their consent status","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_DataSubjectTopicsDto"}},"CustomPreferences":{"description":"List of custom preferences associated with the Purpose","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_DataSubjectCustomPreferencesDto"}}},"required":["Id"]},"ConsentPreferences-UniversalConsentPreferenceManag_DataSubjectTopicsDto":{"properties":{"Id":{"type":"string","format":"uuid"}}},"ConsentPreferences-UniversalConsentPreferenceManag_DataSubjectPreferencesResponseDto":{"type":"object","properties":{"Purposes":{"description":"List of Purposes with their updated consent status for the Data Subject","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_DataSubjectPurposesResponseDto"}},"Language":{"description":"The preferred language of the Data Subject in BCP 47 format","type":"string","example":"en-us"}}},"ConsentPreferences-UniversalConsentPreferenceManag_DataSubjectPurposesResponseDto":{"properties":{"messages":{"description":"List of status messages related to the Purpose update operation","type":"array","items":{"type":"string"},"example":["added","updated"]},"Id":{"description":"Unique identifier for the Purpose that was updated","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"Status":{"description":"Indicates whether the Purpose update was successful","type":"boolean","example":true},"ReceiptGuid":{"description":"Unique identifier for the receipt of this update operation","type":"string","format":"uuid","example":"64a9b83e-3aae-4e9f-b75e-5fbd01aecd85"}}},"ConsentPreferences-UniversalConsentPreferenceManag_AdditionalIdentifierMergeRequest":{"type":"object","properties":{"syncToSQL":{"description":"Flag indicating whether to synchronize the merge operation to SQL database.","type":"boolean","example":true,"default":false},"interactionDate":{"type":"string","format":"date-time"},"additionalIdentifiers":{"description":"List of additional identifiers to be merged with the primary identifier. Must contain at least one identifier.","type":"array","items":{"type":"string","maxLength":2147483647,"minLength":1},"example":["user1_id@otprivacy.com","user2_id@otprivacy.com"],"maxItems":2147483647,"minItems":1},"primaryIdentifier":{"description":"The primary identifier that additional identifiers will be merged into.","type":"string","example":"user1@example.com"}},"required":["primaryIdentifier"]},"ConsentPreferences-UniversalConsentPreferenceManag_CustomPreferenceDto":{"type":"object","properties":{"Id":{"description":"Unique identifier for the Custom Preference","type":"string","format":"uuid","example":"194e0d3b-0ba8-4bc7-b046-e3ae42b2bd25"},"Name":{"description":"The display name of the Custom Preference","type":"string","example":"Email Frequency","maxLength":255,"minLength":1},"Description":{"description":"Detailed description explaining the purpose and usage of this Custom Preference","type":"string","example":"Options for different frequencies to receive emails","maxLength":1000},"SelectionType":{"description":"Defines how options can be selected in this Custom Preference","type":"string","example":"SINGLE_CHOICE","enum":["SINGLE_CHOICE","MULTI_CHOICE","SINGLE_CHOICE","MULTI_CHOICE"]},"DisplayAs":{"description":"Specifies how the preference options should be displayed in the UI","type":"string","example":"BUTTONs","enum":["BUTTONS","CHECKBOXES","BUTTONs","CHECKBOXES","DROPDOWN","RADIO_BUTTONS"]},"CreatedDate":{"description":"Timestamp when the Custom Preference was created","type":"string","format":"date-time","example":"2023-01-15T10:52:30.974Z"},"UpdatedDate":{"description":"Timestamp when the Custom Preference was last updated","type":"string","format":"date-time","example":"2023-01-15T10:55:30.974Z"},"NumberOfOptions":{"description":"Total number of available options for this Custom Preference","type":"integer","format":"int64","example":4,"minimum":0},"Required":{"description":"Indicates whether a response is mandatory for this Custom Preference","type":"boolean","example":false,"default":false},"NumberOfLanguages":{"description":"Number of languages this Custom Preference has been translated into","type":"integer","format":"int64","example":3,"minimum":0},"DefaultLanguage":{"description":"The default language code for this Custom Preference (BCP 47 format)","type":"string","example":"en-us","pattern":"^[a-z]{2}(-[A-Z]{2})?$"},"Disabled":{"description":"Indicates if this Custom Preference is currently disabled","type":"boolean","example":false,"default":false},"Options":{"description":"List of available options for this Custom Preference","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_CustomPreferenceOptionDto"}},"Languages":{"description":"List of language configurations for this Custom Preference","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_CustomPreferenceLanguageDto"}},"Organizations":{"description":"List of Organization IDs that have access to this Custom Preference","type":"array","items":{"type":"string","format":"uuid","example":"712a1f61-a548-432f-afc4-5a383c28eeb2"}},"TotalLinkedActivePurposes":{"description":"Count of active purposes that reference this Custom Preference","type":"integer","format":"int64","example":5,"minimum":0}},"required":["DisplayAs","Id","Name","SelectionType"]},"ConsentPreferences-UniversalConsentPreferenceManag_CustomPreferenceLanguageDto":{"properties":{"Name":{"description":"The Custom Preference name","type":"string","example":"Email Frequency"},"Description":{"description":"The description of the Custom Preference","type":"string","example":"Options for different frequencies to receive emails"},"Language":{"description":"The Custom Preference content language code","type":"string","example":"en-us"},"Default":{"description":"Whether this language is the default one for the Custom Preference","type":"boolean","example":true},"Options":{"description":"Options associated with a Custom Preference","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_CustomPreferenceOptionDto"}}},"required":["Description","Name"]},"ConsentPreferences-UniversalConsentPreferenceManag_CollectionPointEditRequest":{"type":"object","properties":{"OrganizationId":{"description":"The unique identifier of the Organization associated with the Collection Point. Note: this can be found in the URL path when viewing Organization details under global settings.","type":"string","format":"uuid","example":"92cf3a3a-09a9-4d04-b69d-ea5bb1db550a"},"PurposeId":{"description":"Comma-separated list of Purpose unique identifiers. Will default to the most recent purpose version. It is recommended to use the `PurposeIdsWithVersion` field and specify the desired version.","type":"string","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46,a6d68a29-a185-40e8-ac4c-5656d4856b0a"},"PurposeIds":{"description":"List of Purpose unique identifiers. Will default to the most recent purpose version. It is recommended to use the `PurposeIdsWithVersion` field and specify the desired version.","type":"array","items":{"type":"string","format":"uuid","description":"List of Purpose unique identifiers. Will default to the most recent purpose version. It is recommended to use the `PurposeIdsWithVersion` field and specify the desired version."},"example":["f2229953-b4b5-4042-8cb9-b78038cc4c46","a6d68a29-a185-40e8-ac4c-5656d4856b0a"]},"Name":{"description":"The unique name of the Collection Point. This is a required field and must be unique within the organization. The name is used to identify the Collection Point in the UI and API.","type":"string","example":"Website Consent Banner","maxLength":255,"minLength":1},"Description":{"description":"Detailed description of the Collection Point. This should explain the purpose and functionality of the Collection Point.","type":"string","example":"This collection point is used to collect consent for marketing cookies on the main website.","maxLength":1000,"minLength":1},"WebFormUrl":{"description":"The URL where the web form is hosted. This is required for HOSTED_WEB_FORM collection points. The URL must be a valid HTTPS URL.","type":"string","format":"uri","example":"https://example.com/consent-form","pattern":"https?://.*"},"PrivacyPolicyUrl":{"description":"The URL of the privacy policy associated with this Collection Point. This is typically displayed to users when they are providing consent.","type":"string","format":"uri","example":"https://example.com/privacy-policy"},"SubjectIdentifier":{"description":"The Data Subject identifier of the Collection Point. Note: this string is the Data Element name when viewing details under the Consent & Preference Management module","type":"string","example":"Email"},"IdentifierTypes":{"description":"Used in conjunction with the `AllowMultipleIdentifierTypes` setting. The List of Data Subject identifiers that can be used for the Collection Point","type":"array","items":{"type":"string"}},"AllowMultipleIdentifierTypes":{"description":"Allow the Collection Point to generate data subjects with more than one identifier. Note: this feature is under preview for `API` and `HOSTED_WEB_FORM` Collection Points only","type":"boolean","example":false},"IdentifierDataElementId":{"description":"Unique identifier for the Data Element. Note: this can be found in the url path when viewing Data Element details under the Consent & Preference Management module","type":"string","format":"uuid","example":"7912bfe1-37dd-4180-8b99-963e80f3e125"},"ConsentType":{"description":"The type of consent mechanism used by this Collection Point. This determines how consent is captured and processed. For example, EXPLICIT requires explicit user action, while IMPLIED infers consent from user behavior.","type":"string","example":"EXPLICIT","enum":["FORMSUBMIT","EXPLICIT","UNAMBIGUOUS","OPTINCHECKBOX","OPTOUTCHECKBOX","SINGLETRIGGER","CONDITIONALTRIGGER","COOKIEBANNER","UNCHECKOPTOUT","CHECKOPTOUT","EXPLICIT","IMPLIED","NOTICE_ONLY","CONSENT","LEGITIMATE_INTEREST","FORMSUBMIT","UNAMBIGUOUS","OPTINCHECKBOX","OPTOUTCHECKBOX","SINGLETRIGGER","CONDITIONALTRIGGER","COOKIEBANNER","UNCHECKOPTOUT","CHECKOPTOUT"]},"CollectionPointType":{"description":"The type of the Collection Point. This determines the behavior and features available for the Collection Point. For example, WEB_FORM is used for web-based consent banners, while API is used for programmatic consent management.","type":"string","example":"WEB_FORM","enum":["WEB_FORM","MOBILE_APPLICATION","BULK_IMPORT","API","PREFERENCE_CENTER","COOKIE","TRUST_CENTER","NOTIFICATION_OPT_OUT","ADMIN_UPDATE","HOSTED_WEB_FORM","EMBEDDED_WEB_FORM","WEB_FORM","API","COOKIE","NOTIFICATION_OPT_OUT","ADMIN_UPDATE"]},"DataControllerName":{"description":"The name of the data controller responsible for this Collection Point. This is typically the organization or entity that determines the purposes and means of processing personal data.","type":"string","example":"Acme Corp"},"RightToWithdraw":{"description":"Information about the data subject's right to withdraw consent. This is typically displayed to users to inform them of their rights.","type":"string","example":"You have the right to withdraw your consent at any time."},"HowToWithdraw":{"description":"Instructions on how a data subject can withdraw their consent. This should provide clear, actionable steps.","type":"string","example":"To withdraw your consent, please contact our Data Protection Officer at dpo@example.com."},"OtherInformation":{"description":"Any additional information relevant to the Collection Point that doesn't fit in other fields. This could include legal basis for processing or other compliance-related information.","type":"string","example":"Processing is necessary for the performance of a contract to which the data subject is party."},"DoubleOptIn":{"description":"Indicates whether double opt-in is required for this Collection Point. When enabled, users must confirm their consent via email.","type":"boolean","example":false,"default":false},"DOISendConfirmationEmail":{"description":"Double Opt In child setting to send the confirmation email or not. Note: the confirmation link is included in the Data Subject Profile Updated integrations event, which can be used to send custom email or sms messages","type":"boolean","example":false},"DoiEmailToParent":{"description":"When enabling the parental consent feature and double opt-in emails, emails will be sent to the parent identifier by default instead of the child identifier. This is part of the parental consent preview feature.","type":"boolean","example":false,"default":false},"consentDOICancelOption":{"description":"When enabled, allows sending a cancellation notice for double opt-in (DOI) consent. This is used when a user cancels their consent during the double opt-in process.","type":"boolean","example":false,"default":false},"includeParameter":{"description":"When enabled, includes additional parameters in the double opt-in (DOI) confirmation link. This can be used to pass through custom parameters during the DOI process.","type":"boolean","example":false,"default":false},"RedirectUrl":{"description":"The URL to redirect users to after they have completed the consent process. This is typically a thank you page or the main website.","type":"string","format":"uri","example":"https://example.com/thank-you"},"IABVendorId":{"description":"The IAB Vendor Id. Used for legacy mobile Collection Points","type":"integer","format":"int32","example":13},"DataElements":{"description":"List of data element IDs that this Collection Point will collect consent for. Each data element represents a specific type of data processing activity.","type":"array","items":{"type":"string","description":"The unique identifier of a data element","example":"marketing"},"example":["marketing","analytics","preferences"]},"Language":{"description":"The Collection Point default language code","type":"string","example":"en-us"},"Languages":{"description":"List containing the Collection Point translations' language codes","type":"array","items":{"type":"string"}},"NoConsentTransactions":{"description":"Whether no consent transactions can be recorded against the collection point. For more information about consent transaction types and purpose statuses see this [article](https://my-onetrust-com.surrey.idm.oclc.org/s/article/UUID-d4ed05a9-a999-f2cb-8272-610a5817b43f?topicId=0TO1Q000000bHgoWAE)","type":"boolean","example":false},"HostedSDK":{"description":"Whether the SDK settings are published to external storage for quicker integration. This is enabled by default for all web form type collection points","type":"boolean","example":false},"SendConsentEmail":{"description":"Switch on or off the Consent Acknowledgement Email feature for a Collection Point","type":"boolean","example":false},"PreferenceCenterGuid":{"description":"Unique identifier for a Preference Center to associate with this Collection Point","type":"string","format":"uuid","example":"09ccd1b9-84a0-4bcb-a167-f761391ebffa"},"ResponsibleUserId":{"description":"The Unique Identifier of the Responsible User. Note: this can be found in the url path when viewing Responsible User details under global settings","type":"string","format":"uuid","example":"bc4836e2-c117-461b-a7a2-2b268c037a97"},"ResponsibleGroupId":{"description":"The Unique Identifier of the Responsible Group. Note: this can be found in the url path when viewing Responsible Group details under global settings","type":"string","format":"uuid","example":"5466af43-ff42-4a39-8722-5a98e7981fc4"},"ConsentIntegration":{"description":"Setting to fire the Data Subject Consent Updated integrations event. Note: we recommend using the `EnableNewConsentIntegration` setting to fire the Data Subject Profile Updated event instead","type":"boolean","example":false},"EnableNewConsentIntegration":{"description":"Setting to fire the Data Subject Profile Updated integrations event. For more information see this [article](https://my-onetrust-com.surrey.idm.oclc.org/s/article/UUID-58e8b9fb-0e47-5aca-713b-c2f26102d60c)","type":"boolean","example":false},"IsAuthenticationRequired":{"description":"Setting to require authentication for a collection point. For more information see this [article](https://my-onetrust-com.surrey.idm.oclc.org/s/article/UUID-b359a104-1900-9ac9-7765-ee08c8047f1d?topicId=0TO3q000000kIUHGA2)","type":"boolean","example":false},"ReconfirmActivePurpose":{"description":"Used in conjunction with the double opt in feature. Will treat a returning data subject the same as a new one, and trigger the confirmation email event when re-consenting to the same purpose","type":"boolean","example":false,"default":false},"OverrideActivePurpose":{"description":"Used in conjunction with the double opt in reconfirmation and purpose expiration features. This setting is enabled by default and can be turned off if it is desired for a purpose to remain in active status until expired if a data subject does not reconfirm their consent","type":"boolean","example":true,"default":true},"IsDynamicCollectionPoint":{"description":"Whether this is a dynamic collection point or not. For more information see this [article](https://my-onetrust-com.surrey.idm.oclc.org/s/article/UUID-358c7e03-1d60-ff3b-e443-25d4283c7ac3?topicId=0TO3q000000kIWXGA2)","type":"boolean","example":false},"NewSdkIntegrationEnabled":{"description":"Whether new sdk integration is enabled or not. SDK can be loaded in the and a new script is no longer required for each form","type":"boolean","example":false},"attributeValues":{"description":"A map of attribute values associated with this Collection Point.\n\nThis field allows for custom attributes to be attached to the Collection Point for additional metadata or integration purposes. The key represents the attribute name, and the value is a list of attribute value information objects.","type":"object","additionalProperties":true},"HostedWebForm":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_HostedWebFormDto"},"PurposeIdsWithVersion":{"description":"A list containing the IDs of purposes along with their versions that this Collection Point is associated with. Each entry maps a purpose ID to a specific version.","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_IdVersionPairDto"},"example":[{"id":"7912bfe1-37dd-4180-8b99-963e80f3e125","version":1}]},"includeIdentifierParameter":{"description":"When enabled, includes the identifier parameter in the double opt-in (DOI) confirmation link. This is useful for passing the identifier through the DOI process.","type":"boolean","example":false,"default":false},"EnablePublishEvent":{"description":"Setting to fire the Collection Point Published integrations event. For more information see this [article](https://my-onetrust-com.surrey.idm.oclc.org/s/article/UUID-58e8b9fb-0e47-5aca-713b-c2f26102d60c)","type":"boolean","example":false,"default":false},"EnablePrimaryIdentifier":{"description":"Setting to enable primary identifier functionality. When enabled, designates one of the identifiers as the primary identifier for the data subject.","type":"boolean","example":false,"default":false},"EnableCaptcha":{"description":"When enabled, requires users to complete a CAPTCHA challenge before submitting the form. This helps prevent automated submissions and spam.","type":"boolean","example":false,"default":false},"PrimaryIdentifierType":{"description":"The primary identifier type used to identify data subjects for this Collection Point. This is used when multiple identifier types are configured.","type":"string","example":"Email"},"CookieConsentUpdate":{"description":"Specifies how cookie consent updates should be handled for this Collection Point. This determines the behavior when consent preferences change.","type":"string","example":"UPDATE_ALL","enum":["UPDATE_ALL","SKIP_TRANSACTION"]},"EnableGeolocation":{"description":"When enabled, captures the data subject's geolocation (with their consent) for specific purposes. This feature is currently in preview.","type":"boolean","example":false,"default":false},"EnablePrefillIdentifier":{"description":"When enabled, allows the Collection Point to pre-fill identifier fields when possible, improving user experience for returning visitors.","type":"boolean","example":false,"default":false},"EnableGeoLocationForDataElements":{"description":"When enabled, captures the data subject's geolocation (with their consent) for specific data elements. This feature is currently in preview.","type":"boolean","example":false,"default":false},"RedirectOnFormSubmission":{"description":"When enabled, automatically redirects users to a specified URL after they submit the form. The redirect URL can be configured separately.","type":"boolean","example":false,"default":false},"DisableReports":{"description":"When set to true, disables all reporting for this Collection Point. This can be used to improve performance for high-volume Collection Points where reporting is not needed.","type":"boolean","example":false,"default":false},"ParentIdentifierTypes":{"description":"List of parent data subject identifier types for this Collection Point. Used with Consent on Behalf and Multiple Data Subject Identifiers features.","type":"array","items":{"type":"string"},"example":["Email","Mobile"]},"DOIEmailIdentifier":{"description":"The email address to use when sending double opt-in confirmation emails. If not specified, the primary email identifier will be used.","type":"string","example":"user@example.com"},"AckEmailIdentifier":{"description":"The email address to use when sending acknowledgment emails. This can be different from the main contact email for the Collection Point.","type":"string","example":"acknowledgment@example.com"},"PrefillIdentifier":{"description":"The identifier value to pre-fill in the form when known. This improves user experience by reducing data entry for returning visitors.","type":"string","example":"user@example.com"},"enablePurposeEvent":{"description":"When enabled, generates an event whenever a purpose-related action occurs through this Collection Point. Useful for triggering workflows or integrations.","type":"boolean","example":false,"default":false},"enableDataElementEvent":{"description":"When enabled, generates an event whenever a data element-related action occurs through this Collection Point. Useful for triggering workflows or integrations.","type":"boolean","example":false,"default":false},"enableCustomPreferenceEvent":{"description":"When enabled, generates an event for custom preference changes made through this Collection Point. Useful for triggering workflows or integrations.","type":"boolean","example":false,"default":false},"Status":{"description":"The current status of the Collection Point.\n\nThis field determines whether the Collection Point is active, inactive, or in another state. Only active Collection Points will be served to end users.","type":"string","example":"ACTIVE","enum":["DRAFT","ACTIVE","RETIRED","INACTIVE","ACTIVE","INACTIVE","DRAFT","ARCHIVED"]},"PreferenceCenterSettings":{"description":"A key-value map containing all Preference Center settings for this Collection Point.\n\nThese settings control the appearance and behavior of the Preference Center associated with this Collection Point. The structure of this object depends on the specific configuration of the Preference Center.","type":"object","example":{"theme":{"primaryColor":"#007bff"},"features":{"saveButton":true}},"additionalProperties":true},"PortalSettings":{"description":"A key-value map containing all Portal settings for this Collection Point.\n\nThese settings control the appearance and behavior of the Privacy Portal associated with this Collection Point. The structure of this object depends on the specific configuration of the Portal.","type":"object","example":{"showBanner":true,"consentPurposes":["analytics","marketing"]},"additionalProperties":true},"LastSdkIntegrationDate":{"description":"The timestamp when the SDK integration was last synchronized with this Collection Point.\n\nThis field is automatically updated by the system when changes are made to the Collection Point that require SDK updates. It should not be set manually.","type":"string","format":"date-time","example":"2023-01-15T10:30:00Z","readOnly":true},"Notices":{"description":"The set of notices associated with this Collection Point.\n\nNotices define the privacy notices and consent requests that will be displayed to users. Each notice can be configured with different purposes, data categories, and consent requirements.","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_CollectionPointNoticeCreateDto"}},"HostedWebformPublish":{"description":"Flag indicating whether to publish the hosted webform for this Collection Point.\n\nWhen set to `true`, the webform will be published and made available at the configured URL. When set to `false`, the webform will be unpublished but the configuration will be saved.\n\nNote: This field is only applicable for Collection Points with `collectionPointType` set to `HOSTED_WEB_FORM`.","type":"boolean","example":true,"default":false},"doubleOptInExcludedPurposes":{"description":"List of purposes that should be excluded from the Double Opt-In (DOI) requirement.\n\nWhen a purpose is in this list, users will not be required to confirm their consent via email for that specific purpose, even if DOI is enabled for the Collection Point.","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_DoubleOptInExcludedPurposes"}},"doNotActivateWebform":{"description":"When set to `true`, prevents the embedded webform from being automatically activated.\n\nThis is useful when you want to configure the webform but activate it at a later time. The webform will remain in a draft state until explicitly activated.","type":"boolean","example":false,"default":false}},"required":["CollectionPointType","Description","Name","OrganizationId","Status","doNotActivateWebform"]},"ConsentPreferences-UniversalConsentPreferenceManag_CollectionPointNoticeCreateDto":{"properties":{"name":{"description":"Name of the collection point notice","type":"string","example":"Marketing Preferences Notice","minLength":1},"url":{"description":"URL associated with the notice","type":"string","example":"https://example.com/privacy-notice"},"privacyNoticeGuid":{"description":"Unique identifier of the privacy notice","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"type":{"description":"Type of the collection point notice","type":"string","example":"PRIVACY_NOTICE","enum":["LINKED","EMBEDDED"]},"purposeId":{"description":"Deprecated: Use purposeIds instead. Single purpose ID associated with the notice","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","deprecated":true},"purposeIds":{"description":"Set of purpose IDs associated with the notice","type":"array","items":{"type":"string","format":"uuid","description":"Set of purpose IDs associated with the notice"},"example":["123e4567-e89b-12d3-a456-426614174000","223e4567-e89b-12d3-a456-426614174001"],"uniqueItems":true},"noticeType":{"description":"Type of notice being created","type":"string","example":"PRIVACY_NOTICE","enum":["PRIVACY_NOTICE","DIGITAL_POLICY"]}},"required":["noticeType","type"]},"ConsentPreferences-UniversalConsentPreferenceManag_DoubleOptInExcludedPurposes":{"properties":{"purposeGuid":{"description":"Unique identifier of the purpose","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"excludeFromDoubleOptIn":{"description":"Flag indicating whether the purpose should be excluded from double opt-in requirements","type":"boolean","example":true}},"required":["excludeFromDoubleOptIn","purposeGuid"]},"ConsentPreferences-UniversalConsentPreferenceManag_HostedWebFormDto":{"properties":{"Id":{"description":"Unique identifier for the hosted web form","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"Name":{"description":"Name of the hosted web form","type":"string","example":"Main Consent Form","maxLength":255,"minLength":1},"WebFormData":{"description":"JSON configuration data for the web form","type":"object"},"BrandingData":{"description":"Branding configuration for the web form","type":"object"},"SdkVersion":{"description":"Version of the SDK used for the web form","type":"string","example":"1.0.0"},"PublishedLink":{"description":"URL to access the published version of the web form","type":"string","format":"uri","example":"https://example.com/consent-form/published"},"DraftLink":{"description":"URL to access the draft version of the web form","type":"string","format":"uri","example":"https://example.com/consent-form/draft"},"VersionId":{"description":"Unique identifier for the current version of the hosted web form","type":"string","format":"uuid","example":"b6e376c3-e838-439f-a01b-1af24cf9a5ac"},"DefaultLanguageTranslations":{"description":"Default language translations for the web form","type":"object","example":{"en":"English","es":"Spanish"},"additionalProperties":{"type":"string","description":"Default language translations for the web form","example":"{\"en\":\"English\",\"es\":\"Spanish\"}"}},"PortalData":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_HostedWebFormPortalData"},"TestScriptGuid":{"description":"Unique identifier for the test embedded script","type":"string","format":"uuid","example":"65840dad-c063-48d1-82e0-b9ec79f27908"},"ProdScriptGuid":{"description":"Unique identifier for the production embedded script","type":"string","format":"uuid","example":"2defe229-42b9-4a16-85be-7e9610240d31"},"previewId":{"description":"Unique identifier for the web form draft version","type":"string","format":"uuid","example":"f7cd1221-04a1-4523-89bf-3430c91b5cc9"},"TestPublishVersion":{"description":"Version number of the last test publish","type":"string","example":"1.0.0"},"ProdPublishVersion":{"description":"Version number of the last production publish","type":"string","example":"1.0.1"},"supportedScriptVersion":{"description":"List of supported script versions for the web form.","type":"array","items":{"type":"string"},"example":["1.0.0","2.0.0"]},"NewSelectedLanguages":{"description":"List of newly selected languages for the web form","type":"array","items":{"type":"string"},"example":["en","es","fr"]},"IntegrationUrls":{"description":"A list of External Organization Ids.","type":"array","items":{"type":"string"},"example":["https://example.com/integration1","https://example.com/integration2"]},"IntegrationSettings":{"description":"Configuration settings for various integrations","type":"object","example":{"analytics":{"enabled":true},"crm":{"enabled":false}},"additionalProperties":{"type":"object","description":"Configuration settings for various integrations","example":{"analytics":{"enabled":true},"crm":{"enabled":false}}}},"formTemplate":{"description":"Template identifier for web form customization","type":"string","example":"default-template"}},"required":["Name","SdkVersion","WebFormData"]},"ConsentPreferences-UniversalConsentPreferenceManag_HostedWebFormPortalData":{"properties":{"DefaultLanguage":{"description":"Default language code for the web form portal","type":"string","example":"en"},"SelectedLanguage":{"description":"Set of language codes that are selected/available in the web form portal","type":"array","items":{"type":"string"},"example":["en","es","fr"],"uniqueItems":true},"CustomTranslations":{"description":"Custom translations for the web form portal. Nested map structure where the first key is the language code and the inner map contains key-value pairs of translation keys and their values.","type":"object","example":{"es":{"welcome.message":"Bienvenido"},"fr":{"welcome.message":"Bienvenue"}},"additionalProperties":{"type":"object","additionalProperties":{"type":"string","description":"Custom translations for the web form portal. Nested map structure where the first key is the language code and the inner map contains key-value pairs of translation keys and their values.","example":"{\"es\":{\"welcome.message\":\"Bienvenido\"},\"fr\":{\"welcome.message\":\"Bienvenue\"}}"},"description":"Custom translations for the web form portal. Nested map structure where the first key is the language code and the inner map contains key-value pairs of translation keys and their values.","example":{"es":{"welcome.message":"Bienvenido"},"fr":{"welcome.message":"Bienvenue"}}}}},"required":["CustomTranslations","DefaultLanguage"]},"ConsentPreferences-UniversalConsentPreferenceManag_IdVersionPairDto":{"properties":{"Id":{"description":"The unique identifier of the entity","type":"string","format":"uuid","example":"fcfe3c5e-6b1d-4eac-a5a4-aa7c8719b279"},"Version":{"description":"The version of the entity","type":"integer","format":"int64","example":1}},"example":[{"id":"7912bfe1-37dd-4180-8b99-963e80f3e125","version":1}],"required":["Id"]},"ConsentPreferences-UniversalConsentPreferenceManag_DataSubjectElementSearchDto":{"properties":{"name":{"description":"The name of the data element to search for","type":"string","example":"Work Email"},"value":{"description":"The value to match against the specified data element name","type":"string","example":"example@otprivacy.com"}}},"ConsentPreferences-UniversalConsentPreferenceManag_DataSubjectSearchDto":{"type":"object","properties":{"id":{"description":"Filter Data Subject records by GUID","type":"string","format":"uuid","example":"2a95b8c1-e54f-49f0-906a-2f5880450999"},"identifier":{"description":"Filter Data Subject records by identifier (e.g., email, phone number)","type":"string","example":"example@otprivacy.com"},"updatedSince":{"description":"Filter Data Subject records updated on or after this date (format: yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss)","type":"string","example":"2023-01-01T00:00:00"},"updatedUntil":{"description":"Filter Data Subject records updated on or before this date (format: yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss)","type":"string","example":"2023-12-31T23:59:59"},"dataElements":{"description":"Filter Data Subject records by data elements with specific names and values","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_DataSubjectElementSearchDto"}},"language":{"description":"Filter Data Subject records by preferred language code","type":"string","example":"en-us"},"includeCounts":{"description":"When false, the response will not include the total record count (improves performance for large result sets)","type":"boolean","example":true,"default":true},"linkTokens":{"description":"When true, includes link tokens in the response for magic link functionality","type":"boolean","example":false,"default":false},"linkedDS":{"description":"When true, includes additional linked Data Subject information in the response","type":"boolean","example":false,"default":false},"ignoreDefaultSort":{"description":"When true, overrides the default sorting by last modified date","type":"boolean","example":false,"default":false},"orgIds":{"description":"Filter Data Subject records by organization IDs (internal use only)","type":"array","items":{"type":"string","format":"uuid"}},"includeDataSubjectsWithOutPurposeTransactions":{"description":"When true, includes Data Subjects that don't have any purpose transactions","type":"boolean","example":false}}},"ConsentPreferences-UniversalConsentPreferenceManag_DataSubjectDtoV2":{"properties":{"id":{"description":"Unique identifier for the Data Subject","type":"string","format":"uuid","example":"633ba071-61b0-485f-81a0-a2245777b432"},"identifier":{"description":"The Data Subject's identifier (e.g., email, phone number)","type":"string","example":"example@otprivacy.com"},"language":{"description":"The preferred language code for the Data Subject","type":"string","example":"en-us"},"lastUpdatedDate":{"description":"The timestamp when the Data Subject's record was last updated","type":"string","format":"date-time","example":"2020-01-12T16:11:25.479Z"},"dataElements":{"description":"Map of data elements and their corresponding values for the Data Subject","type":"object","example":{"Title":"Mr","FirstName":"Example"},"additionalProperties":true},"dataElementsMetaData":{"description":"List of data elements with metadata for the Data Subject","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_DataSubjectElementDtoV2"}},"linkToken":{"description":"Token used for magic link authentication of the Data Subject","type":"string","example":"jNJW2e8vm8eWb6DlWyGbZ/7PsfC+AHFN8JqvZHPGzJQ="},"createdDate":{"description":"The timestamp when the Data Subject's record was created","type":"string","format":"date-time","example":"2020-01-12T16:11:25.479Z"},"identifierType":{"description":"The type of identifier used for the Data Subject","type":"string","example":"Email"},"testDataSubject":{"description":"Indicates whether this is a test Data Subject","type":"boolean","example":false},"doNotCall":{"description":"Indicates if the Data Subject's phone number is on the FCC's Do Not Call list","type":"boolean","example":false}}},"ConsentPreferences-UniversalConsentPreferenceManag_DataSubjectElementDtoV2":{"properties":{"name":{"description":"The name of the data element","type":"string","example":"Work Email"},"linked":{"description":"Indicates whether this data element value is linked as an identifier","type":"boolean","example":true},"value":{"description":"The value of the data element. Can be a single value or an array of values.","type":"object","example":"example@otprivacy.com"},"doNotCall":{"description":"Indicates if a phone number is listed in FCC's Do Not Call registry","type":"boolean","example":true}},"required":["linked","name","value"]},"ConsentPreferences-UniversalConsentPreferenceManag_DataSubjectSliceDtoV2":{"type":"object","properties":{"content":{"items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_DataSubjectDtoV2"},"type":"array"},"number":{"description":"The page number of the results.","type":"integer","format":"int32","example":1},"size":{"description":"The number of results per page.","type":"integer","format":"int32","example":20},"pageable":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PageableObject"},"last":{"description":"Flag indicating whether this is the last page or not.","type":"boolean","example":false},"sort":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_SortObject"},"first":{"type":"boolean"},"numberOfElements":{"type":"integer","format":"int32"},"empty":{"type":"boolean"}}},"ConsentPreferences-UniversalConsentPreferenceManag_CollectionPointDtoV2":{"type":"object","properties":{"id":{"description":"Unique identifier of the collection point","type":"string","format":"uuid","example":"25d9ccac-db88-4d34-849c-3d602a629961"},"version":{"description":"Version number of the collection point","type":"integer","format":"int64","example":2,"minimum":1},"name":{"description":"Name of the collection point","type":"string","example":"Web Form Collection Point"},"status":{"description":"Current status of the collection point","type":"string","example":"ACTIVE","enum":["DRAFT","ACTIVE","RETIRED","INACTIVE","DRAFT","ACTIVE","RETIRED","INACTIVE"]},"collectionPointType":{"description":"Type of the collection point","type":"string","example":"WEB_FORM","enum":["WEB_FORM","MOBILE_APPLICATION","BULK_IMPORT","API","PREFERENCE_CENTER","COOKIE","TRUST_CENTER","NOTIFICATION_OPT_OUT","ADMIN_UPDATE","HOSTED_WEB_FORM","EMBEDDED_WEB_FORM","WEB_FORM","HOSTED_WEB_FORM","EMBEDDED_WEB_FORM","API"]},"consentType":{"description":"Type of consent mechanism used by the collection point","type":"string","example":"FORMSUBMIT","enum":["FORMSUBMIT","EXPLICIT","UNAMBIGUOUS","OPTINCHECKBOX","OPTOUTCHECKBOX","SINGLETRIGGER","CONDITIONALTRIGGER","COOKIEBANNER","UNCHECKOPTOUT","CHECKOPTOUT","FORMSUBMIT","IMPLICIT","EXPLICIT"]},"description":{"description":"Detailed description of the collection point's purpose","type":"string","example":"Collecting data for Marketing and Promotion Purposes"},"subjectIdentifier":{"description":"Identifier used to uniquely identify the data subject","type":"string","example":"email"},"identifierDataElement":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_CustomDataElementV2"},"createDate":{"description":"Timestamp when the collection point was created","type":"string","format":"date-time","example":"2018-03-22T20:55:40.237Z"},"firstReceiptOn":{"description":"Timestamp when the first consent receipt was generated for this collection point","type":"string","format":"date-time","example":"2018-05-12T12:23:25.243Z"},"receiptCount":{"description":"Total number of consent receipts generated from this collection point","type":"integer","format":"int64","example":563,"minimum":0},"hostedWebFormId":{"description":"Unique identifier of the hosted web form associated with this collection point","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"webFormUrl":{"description":"URL where the collection point is hosted","type":"string","format":"uri","example":"https://www-onetrust-com.surrey.idm.oclc.org/collection-point"},"privacyPolicyUrl":{"description":"URL that redirects to the Privacy Policy","type":"string","format":"uri","example":"https://www-onetrust-com.surrey.idm.oclc.org/privacy-notice"},"activationDate":{"description":"Timestamp when the collection point was activated","type":"string","format":"date-time","example":"2018-03-15T12:00:20.123Z"},"organizationId":{"description":"Unique identifier of the organization that owns this collection point","type":"string","format":"uuid","example":"92cf3a3a-09a9-4d04-b69d-ea5bb1db550a"},"doubleOptIn":{"description":"Indicates if double opt-in (email confirmation) is required for this collection point","type":"boolean","example":false},"redirectUrl":{"description":"URL to redirect to after double opt-in confirmation","type":"string","format":"uri","example":"https://www-onetrust-com.surrey.idm.oclc.org/thank-you"},"iabVendorId":{"description":"IAB Vendor ID for mobile collection points","type":"integer","format":"int32","example":13,"minimum":1},"noConsentTransactions":{"description":"Indicates if transactions without explicit consent should be recorded","type":"boolean","example":false},"lastSdkIntegrationDate":{"description":"Timestamp when the SDK integration was last updated","type":"string","format":"date-time","example":"2020-01-08T14:25:11.112Z"},"language":{"description":"Default language code for the collection point","type":"string","example":"en-us"},"hostedSDK":{"description":"Indicates if the settings are published to external storage for optimized performance","type":"boolean","example":false},"showWarning":{"type":"boolean"},"sendConsentEmail":{"description":"Indicates if a consent acknowledgement email should be sent","type":"boolean","example":false},"responsibleUserId":{"description":"Unique identifier of the user responsible for this collection point","type":"string","format":"uuid","example":"bc4836e2-c117-461b-a7a2-2b268c037a97"},"responsibleGroupId":{"description":"Unique identifier of the group responsible for this collection point","type":"string","format":"uuid","example":"5466af43-ff42-4a39-8722-5a98e7981fc4"},"lastActivityDate":{"description":"Timestamp of the most recent activity on this collection point","type":"string","format":"date-time","example":"2020-01-10T18:12:13.543Z"},"warningReasons":{"description":"Set of warning reasons associated with the collection point","type":"array","items":{"type":"string","description":"Set of warning reasons associated with the collection point","enum":["SDK_OUT_OF_DATE","NO_ACTIVITY"]}},"consentIntegration":{"description":"Indicates if consent events should be sent to third-party integrations","type":"boolean","example":false},"enableNewConsentIntegration":{"description":"Indicates if the new consent integration is enabled","type":"boolean","example":false},"isAuthenticationRequired":{"description":"Indicates if authentication is required to access this collection point","type":"boolean","example":false},"createdBy":{"description":"Identifier of the user who created the collection point","type":"string","example":"D452EC68-71C4-4935-9F17-5FD054365805"},"lastModifiedBy":{"description":"Identifier of the user who last modified the collection point","type":"string","example":"304F7D36-75A2-4967-81A5-5A7D604C6A19"},"reconfirmActivePurpose":{"description":"Indicates if reconsent is required for active purposes","type":"boolean","example":false},"publishedBy":{"description":"Identifier of the user who last published the collection point","type":"string","example":"304F7D36-75A2-4967-81A5-5A7D604C6A19"},"dataElements":{"description":"List of data elements associated with the collection point","type":"array","items":{"type":"string"},"example":["First Name","Last Name","Email"]},"jwtToken":{"description":"JWT token data for authentication and authorization","type":"object","additionalProperties":{"type":"object","description":"JWT token data for authentication and authorization"}},"noticesWithVersions":{"description":"List of notices with their version information","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_CollectionPointNoticeWithVersionDto"}},"canCreateNewVersion":{"description":"Indicates if a new version of the collection point can be created","type":"boolean","example":true},"newSdkIntegrationEnabled":{"description":"Indicates if the new SDK integration is enabled","type":"boolean","example":false},"disabled":{"description":"Indicates if the collection point is disabled","type":"boolean","example":false},"languages":{"description":"List of language codes for which translations are availablel","type":"array","items":{"type":"string"},"example":["en-us","fr"]},"preferenceCenter":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PreferenceCenterSummaryDto"},"attributes":{"description":"Additional attributes associated with the collection point","type":"object","additionalProperties":{"type":"array","description":"Additional attributes associated with the collection point","items":{"type":"string","description":"Additional attributes associated with the collection point"}}},"purposes":{"description":"The list of Purposes associated with the Collection Point. Each purpose contains detailed information including its status, consent model, and other relevant attributes.","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PurposeDetailDtoV2"},"readOnly":true}}},"ConsentPreferences-UniversalConsentPreferenceManag_CollectionPointNoticeWithVersionDto":{"properties":{"id":{"description":"The unique identifier of the collection point notice.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"name":{"description":"The name of the notice as it appears in the collection point.","type":"string","example":"Privacy Notice (v2.0)"},"url":{"description":"The URL where the full notice content can be accessed, if applicable.","type":"string","format":"uri","example":"https://example.com/privacy-notice"},"privacyNoticeGuid":{"description":"The unique identifier of the privacy notice this collection point notice is associated with.","type":"string","format":"uuid","example":"223e4567-e89b-12d3-a456-426614174001"},"type":{"description":"The type of the collection point notice, indicating its purpose or category.","type":"string","enum":["LINKED","EMBEDDED"]},"purposes":{"description":"Set of purposes associated with this notice, including their names and versions.","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_SimpleNameVersion"},"uniqueItems":true},"privacyNoticeVersion":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PrivacyNoticeVersionDtoV2"},"collectionPoint":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_SimpleNameVersion"},"noticeType":{"description":"The type of notice, which may provide additional categorization beyond the collection point notice type.","type":"string","enum":["PRIVACY_NOTICE","DIGITAL_POLICY"]}},"example":["id","name","privacyNoticeGuid"],"required":["id","name","privacyNoticeGuid","purposes","type"]},"ConsentPreferences-UniversalConsentPreferenceManag_CustomDataElementField":{"properties":{"dataElementType":{"description":"The type of the custom data element (e.g., TEXT, NUMBER, DATE, etc.)","type":"string","enum":["USER_INPUT","SELECTION","EMAIL","NUMBER","DATE_PICKER","COUNTRY","STATE","COUNTRY_CODE","PHONE_NUMBER","STATE_CODE"]},"displayAs":{"description":"Specifies how the data element should be displayed in the UI (e.g., as a text field, dropdown, radio buttons, etc.)","type":"string","enum":["DROPDOWN","NONE"]},"dataElementOptions":{"description":"List of available options for this data element. Only applicable for choice-based elements like dropdowns or radio buttons.","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_CustomDataElementOptionDtoV2"}}},"required":["dataElementType"]},"ConsentPreferences-UniversalConsentPreferenceManag_CustomDataElementOptionDto":{"properties":{"Id":{"description":"Unique identifier for the custom data element option","type":"string","format":"uuid","example":"1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed"},"Label":{"description":"Display text for the option","type":"string","example":"Option 1"}},"required":["Label"]},"ConsentPreferences-UniversalConsentPreferenceManag_CustomDataElementOptionDtoV2":{"properties":{"id":{"type":"string","format":"uuid"},"label":{"type":"string"}}},"ConsentPreferences-UniversalConsentPreferenceManag_CustomDataElementV2":{"properties":{"guid":{"description":"Unique identifier for the custom data element","type":"string","format":"uuid","example":"21e0de87-d6ef-4b39-a54b-6d877698e3f6"},"numberOfLanguages":{"description":"Number of language translations available for this data element","type":"integer","format":"int64","example":3,"readOnly":true},"createdDate":{"description":"Timestamp when the data element was created","type":"string","format":"date-time","example":"2023-01-15T10:30:00Z","readOnly":true},"lastModifiedDate":{"description":"Timestamp when the data element was last modified","type":"string","format":"date-time","example":"2023-01-20T14:45:30Z","readOnly":true},"canEdit":{"description":"Indicates if the data element can be modified","type":"boolean","example":true,"readOnly":true},"dataElementFields":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_CustomDataElementField"},"label":{"description":"The display name/label of the custom data element","type":"string","example":"Work Email"},"isIdentifier":{"description":"Indicates if this data element can be used as an identifier","type":"boolean","example":false,"default":false},"collectionPoints":{"description":"Number of collection points where this data element is being used","type":"integer","format":"int64","example":5,"readOnly":true},"languages":{"description":"List of language-specific translations for this data element","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_DataElementLanguageDto"}}},"required":["guid","label"]},"ConsentPreferences-UniversalConsentPreferenceManag_CustomPreferenceLanguageDtoV2":{"properties":{"name":{"type":"string"},"description":{"type":"string"},"language":{"type":"string"},"default":{"type":"boolean"},"options":{"type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_CustomPreferenceOptionDtoV2"}}}},"ConsentPreferences-UniversalConsentPreferenceManag_CustomPreferenceOptionDtoV2":{"properties":{"id":{"type":"string"},"transactionType":{"type":"string"},"label":{"type":"string"},"order":{"type":"integer","format":"int32"},"isDefault":{"type":"boolean"}}},"ConsentPreferences-UniversalConsentPreferenceManag_DataElementLanguageDto":{"properties":{"Name":{"description":"The Data Element name","type":"string","example":"Work Email"},"DataElementOptions":{"description":"List of options available for this data element in the specified language","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_CustomDataElementOptionDto"}},"Language":{"description":"The Data Element translation language code","type":"string","example":"en-us"}}},"ConsentPreferences-UniversalConsentPreferenceManag_PreferenceCenterSummaryDto":{"properties":{"Id":{"description":"Unique Identifier identifying the Preference Center","type":"string","format":"uuid","example":"09ccd1b9-84a0-4bcb-a167-f761391ebffa"},"Name":{"description":"The Preference Center name","type":"string","example":"Email Communication Preferences"},"OrganizationName":{"description":"The Organization's name","type":"string","example":"OneTrust"},"Template":{"description":"The Preference Center template type","type":"string","example":"ENHANCED","enum":["ORIGINAL","ENHANCED","MULTIPAGE"]}}},"ConsentPreferences-UniversalConsentPreferenceManag_PrivacyNoticeVersionDtoV2":{"properties":{"id":{"description":"Unique identifier of the privacy notice version","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"name":{"description":"Name of the privacy notice version","type":"string","example":"Privacy Policy v2.1"},"version":{"description":"Major version number of the privacy notice","type":"integer","format":"int64","example":2,"minimum":0},"minorVersion":{"description":"Minor version number of the privacy notice (used for patch versions)","type":"integer","format":"int64","example":1,"default":0,"minimum":0}}},"ConsentPreferences-UniversalConsentPreferenceManag_PurposeCustomPreferenceDtoV2":{"properties":{"id":{"description":"Unique identifier of the purpose-custom preference relationship","type":"string","example":"c4a57a38-3774-45ad-9fa4-dbc545542232"},"name":{"description":"Name of the custom preference","type":"string","example":"Email Frequency"},"displayAs":{"description":"Display type for rendering the custom preference in the UI","type":"string","example":"BUTTONS","enum":["BUTTONS","CHECKBOXES"]},"customPreferenceOptions":{"description":"List of available options for this custom preference","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_CustomPreferenceOptionDtoV2"}},"languages":{"description":"List of language-specific content for the custom preference","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_CustomPreferenceLanguageDtoV2"}}},"required":["displayAs","id","name"]},"ConsentPreferences-UniversalConsentPreferenceManag_PurposeDetailDtoV2":{"properties":{"id":{"description":"Unique identifier of the purpose","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"label":{"description":"Name or label of the purpose version","type":"string","example":"Marketing Communications"},"description":{"description":"Detailed description of the purpose version","type":"string","example":"Collect customer emails for marketing purposes"},"status":{"description":"Current status of the purpose version","type":"string","example":"ACTIVE","enum":["DRAFT","ACTIVE","RETIRED"]},"version":{"description":"Version number of the purpose","type":"integer","format":"int64","example":2},"consentLifeSpan":{"description":"Lifespan of consents recorded against this purpose version in seconds","type":"integer","format":"int64","example":31536000},"implicitConsentLifeSpan":{"description":"Lifespan of implicit consents recorded against this purpose version in seconds","type":"integer","format":"int64","example":31536000},"implicitConsentConfirmDesc":{"description":"Description text for the implicit consent confirmation checkbox","type":"string","example":"I agree to the processing of my personal data for this purpose"},"purposeType":{"description":"Type of the purpose","type":"string","example":"STANDARD","enum":["STANDARD","COOKIE","IAB","MOBILE","NOTIFICATION_OPT_OUT"]},"parentPurposeId":{"description":"Unique identifier of the parent purpose, if this is a child purpose","type":"string","format":"uuid","example":"ba54eb25-90f0-4633-ab12-c7bf5afdd856"},"retireOnDate":{"description":"Date when the purpose will be retired","type":"string","format":"date-time","example":"2025-12-31T23:59:59Z"},"createdBy":{"description":"ID of the user who created the purpose","type":"string","example":"304F7D36-75A2-4967-81A5-5A7D604C6A19"},"createdDate":{"description":"Date and time when the purpose version was created","type":"string","format":"date-time","example":"2023-01-01T00:00:00Z"},"lastModifiedBy":{"description":"ID of the user who last modified the purpose","type":"string","example":"304F7D36-75A2-4967-81A5-5A7D604C6A19"},"lastModifiedDate":{"description":"Date and time when the purpose version was last modified","type":"string","format":"date-time","example":"2023-01-15T15:30:45Z"},"publishedBy":{"description":"ID of the user who published the purpose","type":"string","example":"304F7D36-75A2-4967-81A5-5A7D604C6A19"},"publishedDate":{"description":"Date and time when the purpose version was published","type":"string","format":"date-time","example":"2023-01-10T10:15:30Z"},"detail":{"description":"URL to get the detailed information of this purpose version","type":"string","example":"https://app-eu-onetrust-com.surrey.idm.oclc.org/api/consentmanager/v2/purposes/f2229953-b4b5-4042-8cb9-b78038cc4c46?version=2"},"customPreferences":{"description":"List of custom preferences associated with the purpose","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PurposeCustomPreferenceDtoV2"}},"topics":{"description":"List of topics associated with the purpose","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PurposeTopicDtoV2"}},"organizations":{"description":"List of organization IDs associated with this purpose","type":"array","items":{"type":"string","format":"uuid","description":"List of organization IDs associated with this purpose"},"example":["f2229953-b4b5-4042-8cb9-b78038cc4c46","bc4836e2-c117-461b-a7a2-2b268c037a97"]},"expiryDateType":{"description":"Type of date field used for calculating purpose lifespan/expiry","type":"string","example":"LAST_TRANSACTION_DATE","enum":["LAST_TRANSACTION_DATE","CONSENT_DATE"]},"enableGeolocation":{"description":"Flag indicating whether to capture the data subject's geolocation when consent is provided","type":"boolean","example":true},"attributes":{"description":"Additional attributes attached to the purpose","type":"object","additionalProperties":{"type":"array","description":"Additional attributes attached to the purpose","items":{"type":"string","description":"Additional attributes attached to the purpose"}}},"purposeLanguages":{"description":"List of language-specific purpose information","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PurposeLanguageDtoV3"}},"LastMajorVersion":{"type":"integer","format":"int64"},"VersionNotes":{"type":"string"},"IsMajorVersion":{"type":"boolean"},"HardOptOutDisplayFormat":{"description":"The format in which the purpose displays in a Trust Center when the consent status is Hard opt-out. Hard opt-out purposes can either be displayed but locked, or hidden.","type":"string","example":"HIDE","enum":["HIDE","LOCK"]},"HardOptOutMessage":{"description":"The message to display with the purpose when the consent status is Hard opt-out. This message only displays when hardOptOutDisplayFormat is set to LOCK.","type":"string","example":"This purpose is required and cannot be opted out"},"languages":{"description":"List of languages supported by the purpose","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PurposeLanguageDtoV2"}},"receiptInclusionAttributes":{"description":"Attributes that should be included in the receipt","type":"object","additionalProperties":{"type":"array","description":"Attributes that should be included in the receipt","items":{"type":"string","description":"Attributes that should be included in the receipt"}}}},"readOnly":true,"required":["id","label","purposeType","status","version"]},"ConsentPreferences-UniversalConsentPreferenceManag_PurposeLanguageDtoV2":{"properties":{"name":{"description":"The purpose name in the specified language","type":"string","example":"Marketing Communications"},"description":{"description":"The purpose description in the specified language","type":"string","example":"Collect customer emails for marketing purposes"},"implicitConsentConfirmDesc":{"description":"Description text for the implicit consent confirmation checkbox in the specified language","type":"string","example":"I agree to the processing of my personal data for this purpose"},"language":{"description":"IETF BCP 47 language tag for the content","type":"string","example":"en-US"},"default":{"description":"Indicates if this is the default language for the purpose","type":"boolean","example":true},"hardOptOutMessage":{"description":"The message to display with the purpose when the consent status is Hard opt-out. This message only displays when hardOptOutDisplayFormat is set to LOCK.","type":"string","example":"This purpose is required and cannot be opted out"}},"required":["description","name"]},"ConsentPreferences-UniversalConsentPreferenceManag_PurposeLanguageDtoV3":{"properties":{"name":{"description":"The purpose name in the specified language","type":"string","example":"Marketing Communications"},"description":{"description":"The purpose description in the specified language","type":"string","example":"Collect customer emails for marketing purposes"},"implicitConsentConfirmDesc":{"description":"Description text for the implicit consent confirmation checkbox in the specified language","type":"string","example":"I agree to the processing of my personal data for this purpose"},"language":{"description":"IETF BCP 47 language tag for the content","type":"string","example":"en-US"},"default":{"description":"Indicates if this is the default language for the purpose","type":"boolean","example":true},"hardOptOutMessage":{"description":"The message to display with the purpose when the consent status is Hard opt-out. This message only displays when hardOptOutDisplayFormat is set to LOCK.","type":"string","example":"This purpose is required and cannot be opted out"},"purposeId":{"description":"The unique identifier of the purpose this language entry belongs to","type":"integer","format":"int64","example":12345}},"required":["description","name","purposeId"]},"ConsentPreferences-UniversalConsentPreferenceManag_PurposeTopicDtoV2":{"properties":{"id":{"description":"Unique identifier of the purpose-topic relationship","type":"string","format":"uuid","example":"497c4383-2c61-4906-aed0-660e3fd03ef0"},"transactionType":{"description":"Type of transaction associated with the topic","type":"string","example":"OPT_IN"},"name":{"description":"Name of the topic","type":"string","example":"Car Marketing"},"integrationKey":{"description":"Integration key formed by combining purpose and topic names","type":"string","example":"Marketing-Communications_Car-Marketing"},"languages":{"description":"List of language-specific content for the topic","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_TopicLanguageDtoV2"}},"canDelete":{"description":"Indicates whether this topic can be deleted","type":"boolean","example":true}},"required":["id","name"]},"ConsentPreferences-UniversalConsentPreferenceManag_SimpleNameVersion":{"properties":{"id":{"description":"The unique identifier of the entity","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"name":{"description":"The display name of the entity","type":"string","example":"Marketing Consent Form"},"version":{"description":"The version number of the entity","type":"integer","format":"int64","example":1},"type":{"description":"The type of the entity (optional, used for categorization)","type":"string","example":"CONSENT_FORM"}},"required":["id","name","version"]},"ConsentPreferences-UniversalConsentPreferenceManag_TopicLanguageDtoV2":{"properties":{"name":{"type":"string"},"language":{"type":"string"},"default":{"type":"boolean"}}},"ConsentPreferences-UniversalConsentPreferenceManag_MergeDSRequestDto":{"type":"object","properties":{"mergeRequestId":{"description":"Unique identifier of the merge request","type":"string","format":"uuid","example":"8e453d7c-eb4f-4139-913a-3d1f93977665"},"mergeRequestName":{"description":"Name of the merge request which uniquely identifies the job","type":"string","example":"Monthly Duplicate Data Subjects Export"},"triggerTime":{"description":"The time at which triggers the job to find duplicate Data Subjects","type":"string","format":"date-time","example":"2025-10-01T00:00:00Z"},"jobFrequency":{"description":"Frequency at which the job runs","type":"string","enum":["DAILY","WEEKLY","MONTHLY","YEARLY","CUSTOM"]},"jobStatus":{"description":"Current status of the job","type":"string","example":"PENDING","enum":["PENDING","COMPLETED","IN_PROGRESS","MERGE_REPORT_IN_PROGRESS","FAILED","CANCELLED"]},"mergeCondition":{"description":"Condition used to apply between Data Subject Elements when identifying duplicates","type":"string","example":"ANY","enum":["ANY","ALL"]},"totalDataSubjectCount":{"description":"Total number of Data Subjects that match the given conditions","type":"integer","format":"int32","example":150},"duplicateDataSubjectCount":{"description":"Number of duplicate Data Subjects found based on the specified conditions","type":"integer","format":"int32","example":25},"customDataElementNames":{"description":"List of Data Element names for which the merge condition will be applied","type":"array","items":{"type":"string"},"example":["email","phone"],"minItems":1}},"required":["customDataElementNames","jobFrequency","mergeCondition","mergeRequestId","mergeRequestName"]},"ConsentPreferences-UniversalConsentPreferenceManag_PurposeCreateDto":{"type":"object","properties":{"Organizations":{"description":"A list of External Organization Ids.","type":"array","items":{"type":"string"},"example":["Organization Id-1","Organization Id-2"]},"Name":{"description":"Name of the Purpose","type":"string","example":"Marketing Communications"},"Description":{"description":"Detailed description of the Purpose's intended use","type":"string","example":"Collect customer emails for marketing purposes"},"ConsentLifeSpan":{"description":"The lifespan of consents recorded against this purpose in seconds","type":"integer","format":"int64","example":7889238},"DefaultLanguage":{"description":"The default language for the Purpose in BCP 47 format","type":"string","example":"en-us"},"Type":{"description":"Type of the Purpose","type":"string","example":"STANDARD","enum":["STANDARD","COOKIE","IAB","MOBILE","NOTIFICATION_OPT_OUT"]},"ParentPurposeId":{"description":"Unique identifier of the parent purpose","type":"string","format":"uuid","example":"ba54eb25-90f0-4633-ab12-c7bf5afdd856"},"attributeValues":{"description":"Map of attribute values associated with the purpose","type":"object","additionalProperties":{"type":"array","description":"Map of attribute values associated with the purpose","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_AttributeValueInformation"}}},"EnableGeolocation":{"description":"Flag to enable geolocation tracking for this purpose","type":"boolean","example":false},"CustomPreferenceIds":{"description":"List of custom preference IDs associated with the purpose","type":"array","items":{"type":"string","format":"uuid","description":"List of custom preference IDs associated with the purpose"},"example":["f2229953-b4b5-4042-8cb9-b78038cc4c46","bc4836e2-c117-461b-a7a2-2b268c037a97"]},"ImplicitConsentLifeSpan":{"description":"Lifespan for implicit consents in seconds","type":"integer","format":"int64","example":31536000},"ImplicitConsentConfirmDesc":{"description":"Description shown when confirming implicit consent","type":"string","example":"By continuing, you agree to our terms and conditions"},"HardOptOutDisplayFormat":{"description":"The format in which the purpose displays in a Trust Center when the consent status is Hard opt-out. Hard opt-out purposes can either be displayed but locked, or hidden.","type":"string","example":"HIDE","enum":["HIDE","LOCK"]},"PurposeCategory":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_AttributeValueInformation"},"LastMajorVersion":{"description":"Version number of the last major update","type":"integer","format":"int64","example":2},"VersionNotes":{"description":"Release notes for the current version","type":"string","example":"Updated purpose description and consent lifespan"},"IsMajorVersion":{"description":"Indicates if this is a major version update","type":"boolean","example":false},"HardOptOutMessage":{"description":"The message to display with the purpose when the consent status is Hard opt-out. This message only displays when hardOptOutDisplayFormat is set to LOCK.","type":"string","example":"This purpose is required and cannot be opted out"}},"required":["ConsentLifeSpan","Description","Name"]},"ConsentPreferences-UniversalConsentPreferenceManag_DataSubjectCreateDTO":{"type":"object","properties":{"dataElements":{"description":"List containing the Data Subject's Data Elements","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_DataSubjectElementDTO"}},"identifierType":{"description":"The type of identifier used for the Data Subject","type":"string","example":"Email"},"language":{"description":"The preferred language code for the Data Subject","type":"string","example":"en-us"}}},"ConsentPreferences-UniversalConsentPreferenceManag_DataSubjectElementDTO":{"properties":{"name":{"description":"The name of the data element","type":"string","example":"Work Email"},"value":{"description":"The value of the data element","type":"object","example":"example@otprivacy.com","maxLength":750},"linked":{"description":"Indicates whether the data element can be used as an additional identifier","type":"boolean","example":true},"interactionDate":{"type":"string","format":"date-time"}},"required":["name"]},"ConsentPreferences-UniversalConsentPreferenceManag_AdditionalIdInvalidScenariosDto":{"properties":{"name":{"type":"string"},"values":{"type":"object","additionalProperties":{"type":"string"}}}},"ConsentPreferences-UniversalConsentPreferenceManag_DataSubjectDetailDTO":{"type":"object","properties":{"id":{"description":"Unique identifier for the Data Subject","type":"string","format":"uuid","example":"633ba071-61b0-485f-81a0-a2245777b432"},"identifier":{"description":"The Data Subject's identifier value (e.g., email, phone number)","type":"string","example":"example@otprivacy.com"},"identifierType":{"description":"The type of identifier used for the Data Subject","type":"string","example":"Email"},"canBePrimary":{"description":"Indicates if the Data Subject can be used as a primary identifier for a group of related identifiers","type":"boolean","example":true},"elements":{"description":"List of data elements associated with the Data Subject","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_DataSubjectElementDTO"}},"messages":{"description":"List of validation or processing messages related to the Data Subject","type":"array","items":{"type":"string"},"example":["Invalid Data Element Name : Account Number"]},"additionalIdMessages":{"description":"List of validation messages related to additional identifiers","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_AdditionalIdInvalidScenariosDto"}}},"required":["identifier","identifierType"]},"ConsentPreferences-UniversalConsentPreferenceManag_CustomPreferenceCreateDto":{"properties":{"Name":{"description":"The display name of the Custom Preference. This will be shown to end users in the preference center.","type":"string","example":"Email Frequency","maxLength":255,"minLength":1},"Description":{"description":"Detailed description explaining the purpose and usage of this Custom Preference. This helps administrators understand the context of this preference.","type":"string","example":"Allows users to select how often they would like to receive marketing emails","maxLength":1000,"minLength":1},"SelectionType":{"description":"Defines how options can be selected in this Custom Preference. SINGLE_CHOICE allows only one option to be selected, while MULTI_CHOICE allows multiple selections.","type":"string","example":"SINGLE_CHOICE","enum":["SINGLE_CHOICE","MULTI_CHOICE","SINGLE_CHOICE","MULTI_CHOICE"]},"DisplayAs":{"description":"Specifies how the preference options should be displayed in the user interface. This affects the visual representation of the preference options.","type":"string","example":"BUTTONS","enum":["BUTTONS","CHECKBOXES","BUTTONS","CHECKBOXES","DROPDOWN","RADIO_BUTTONS"]},"DefaultLanguage":{"description":"Indicates whether the provided language should be set as the default language for this Custom Preference. If true, the language specified in the 'language' field will be used as the default.","type":"boolean","example":true,"default":true},"Language":{"description":"The language code for this Custom Preference in BCP 47 format. This specifies the language of the preference name, description, and options.","type":"string","example":"en-US","minLength":1,"pattern":"^[a-z]{2}(-[A-Z]{2})?$"},"Required":{"description":"Indicates whether a response is mandatory for this Custom Preference. If true, users must select an option before submitting the form.","type":"boolean","example":false,"default":false},"Disabled":{"description":"Indicates if this Custom Preference should be disabled. Disabled preferences are not shown to end users in the preference center.","type":"boolean","example":false,"default":false},"Options":{"description":"List of available options for this Custom Preference. Each option should be a string representing a selectable choice.","type":"array","items":{"type":"string","description":"A single option for the Custom Preference","example":"Weekly","maxLength":255,"minLength":1},"example":["Daily","Weekly","Monthly","Never"],"minItems":1},"Organizations":{"description":"List of organization IDs that should have access to this Custom Preference. If empty, the preference will be available to all organizations.","type":"array","items":{"type":"string","format":"uuid","description":"A single organization ID","example":"712a1f61-a548-432f-afc4-5a383c28eeb2"},"example":["712a1f61-a548-432f-afc4-5a383c28eeb2","862a1f61-e148-032f-afc4-7a383c28eec6"]},"Purposes":{"description":"List of Purpose IDs that this Custom Preference should be associated with. This links the preference to specific purposes in the system.","type":"array","items":{"type":"string","format":"uuid","description":"A single Purpose ID","example":"a1b2c3d4-e5f6-4a5b-8c7d-9e0f1a2b3c4d"}}},"required":["Description","DisplayAs","Language","Name","Options","SelectionType"]},"ConsentPreferences-UniversalConsentPreferenceManag_CollectionPointCreateRequest":{"type":"object","properties":{"OrganizationId":{"description":"The unique identifier of the Organization associated with the Collection Point. Note: this can be found in the URL path when viewing Organization details under global settings.","type":"string","format":"uuid","example":"92cf3a3a-09a9-4d04-b69d-ea5bb1db550a"},"PurposeId":{"description":"Comma-separated list of Purpose unique identifiers. Will default to the most recent purpose version. It is recommended to use the `PurposeIdsWithVersion` field and specify the desired version.","type":"string","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46,a6d68a29-a185-40e8-ac4c-5656d4856b0a"},"PurposeIds":{"description":"List of Purpose unique identifiers. Will default to the most recent purpose version. It is recommended to use the `PurposeIdsWithVersion` field and specify the desired version.","type":"array","items":{"type":"string","format":"uuid","description":"List of Purpose unique identifiers. Will default to the most recent purpose version. It is recommended to use the `PurposeIdsWithVersion` field and specify the desired version."},"example":["f2229953-b4b5-4042-8cb9-b78038cc4c46","a6d68a29-a185-40e8-ac4c-5656d4856b0a"]},"Name":{"description":"The unique name of the Collection Point. This is a required field and must be unique within the organization. The name is used to identify the Collection Point in the UI and API.","type":"string","example":"Website Consent Banner","maxLength":255,"minLength":1},"Description":{"description":"Detailed description of the Collection Point. This should explain the purpose and functionality of the Collection Point.","type":"string","example":"This collection point is used to collect consent for marketing cookies on the main website.","maxLength":1000,"minLength":1},"WebFormUrl":{"description":"The URL where the web form is hosted. This is required for HOSTED_WEB_FORM collection points. The URL must be a valid HTTPS URL.","type":"string","format":"uri","example":"https://example.com/consent-form","pattern":"https?://.*"},"PrivacyPolicyUrl":{"description":"The URL of the privacy policy associated with this Collection Point. This is typically displayed to users when they are providing consent.","type":"string","format":"uri","example":"https://example.com/privacy-policy"},"SubjectIdentifier":{"description":"The Data Subject identifier of the Collection Point. Note: this string is the Data Element name when viewing details under the Consent & Preference Management module","type":"string","example":"Email"},"IdentifierTypes":{"description":"Used in conjunction with the `AllowMultipleIdentifierTypes` setting. The List of Data Subject identifiers that can be used for the Collection Point","type":"array","items":{"type":"string"}},"AllowMultipleIdentifierTypes":{"description":"Allow the Collection Point to generate data subjects with more than one identifier. Note: this feature is under preview for `API` and `HOSTED_WEB_FORM` Collection Points only","type":"boolean","example":false},"IdentifierDataElementId":{"description":"Unique identifier for the Data Element. Note: this can be found in the url path when viewing Data Element details under the Consent & Preference Management module","type":"string","format":"uuid","example":"7912bfe1-37dd-4180-8b99-963e80f3e125"},"ConsentType":{"description":"The type of consent mechanism used by this Collection Point. This determines how consent is captured and processed. For example, EXPLICIT requires explicit user action, while IMPLIED infers consent from user behavior.","type":"string","example":"EXPLICIT","enum":["FORMSUBMIT","EXPLICIT","UNAMBIGUOUS","OPTINCHECKBOX","OPTOUTCHECKBOX","SINGLETRIGGER","CONDITIONALTRIGGER","COOKIEBANNER","UNCHECKOPTOUT","CHECKOPTOUT","EXPLICIT","IMPLIED","NOTICE_ONLY","CONSENT","LEGITIMATE_INTEREST","FORMSUBMIT","UNAMBIGUOUS","OPTINCHECKBOX","OPTOUTCHECKBOX","SINGLETRIGGER","CONDITIONALTRIGGER","COOKIEBANNER","UNCHECKOPTOUT","CHECKOPTOUT"]},"CollectionPointType":{"description":"The type of the Collection Point. This determines the behavior and features available for the Collection Point. For example, WEB_FORM is used for web-based consent banners, while API is used for programmatic consent management.","type":"string","example":"WEB_FORM","enum":["WEB_FORM","MOBILE_APPLICATION","BULK_IMPORT","API","PREFERENCE_CENTER","COOKIE","TRUST_CENTER","NOTIFICATION_OPT_OUT","ADMIN_UPDATE","HOSTED_WEB_FORM","EMBEDDED_WEB_FORM","WEB_FORM","API","COOKIE","NOTIFICATION_OPT_OUT","ADMIN_UPDATE"]},"DataControllerName":{"description":"The name of the data controller responsible for this Collection Point. This is typically the organization or entity that determines the purposes and means of processing personal data.","type":"string","example":"Acme Corp"},"RightToWithdraw":{"description":"Information about the data subject's right to withdraw consent. This is typically displayed to users to inform them of their rights.","type":"string","example":"You have the right to withdraw your consent at any time."},"HowToWithdraw":{"description":"Instructions on how a data subject can withdraw their consent. This should provide clear, actionable steps.","type":"string","example":"To withdraw your consent, please contact our Data Protection Officer at dpo@example.com."},"OtherInformation":{"description":"Any additional information relevant to the Collection Point that doesn't fit in other fields. This could include legal basis for processing or other compliance-related information.","type":"string","example":"Processing is necessary for the performance of a contract to which the data subject is party."},"DoubleOptIn":{"description":"Indicates whether double opt-in is required for this Collection Point. When enabled, users must confirm their consent via email.","type":"boolean","example":false,"default":false},"DOISendConfirmationEmail":{"description":"Double Opt In child setting to send the confirmation email or not. Note: the confirmation link is included in the Data Subject Profile Updated integrations event, which can be used to send custom email or sms messages","type":"boolean","example":false},"DoiEmailToParent":{"description":"When enabling the parental consent feature and double opt-in emails, emails will be sent to the parent identifier by default instead of the child identifier. This is part of the parental consent preview feature.","type":"boolean","example":false,"default":false},"consentDOICancelOption":{"description":"When enabled, allows sending a cancellation notice for double opt-in (DOI) consent. This is used when a user cancels their consent during the double opt-in process.","type":"boolean","example":false,"default":false},"includeParameter":{"description":"When enabled, includes additional parameters in the double opt-in (DOI) confirmation link. This can be used to pass through custom parameters during the DOI process.","type":"boolean","example":false,"default":false},"RedirectUrl":{"description":"The URL to redirect users to after they have completed the consent process. This is typically a thank you page or the main website.","type":"string","format":"uri","example":"https://example.com/thank-you"},"IABVendorId":{"description":"The IAB Vendor Id. Used for legacy mobile Collection Points","type":"integer","format":"int32","example":13},"DataElements":{"description":"List of data element IDs that this Collection Point will collect consent for. Each data element represents a specific type of data processing activity.","type":"array","items":{"type":"string","description":"The unique identifier of a data element","example":"marketing"},"example":["marketing","analytics","preferences"]},"Language":{"description":"The Collection Point default language code","type":"string","example":"en-us"},"Languages":{"description":"List containing the Collection Point translations' language codes","type":"array","items":{"type":"string"}},"NoConsentTransactions":{"description":"Whether no consent transactions can be recorded against the collection point. For more information about consent transaction types and purpose statuses see this [article](https://my-onetrust-com.surrey.idm.oclc.org/s/article/UUID-d4ed05a9-a999-f2cb-8272-610a5817b43f?topicId=0TO1Q000000bHgoWAE)","type":"boolean","example":false},"HostedSDK":{"description":"Whether the SDK settings are published to external storage for quicker integration. This is enabled by default for all web form type collection points","type":"boolean","example":false},"SendConsentEmail":{"description":"Switch on or off the Consent Acknowledgement Email feature for a Collection Point","type":"boolean","example":false},"PreferenceCenterGuid":{"description":"Unique identifier for a Preference Center to associate with this Collection Point","type":"string","format":"uuid","example":"09ccd1b9-84a0-4bcb-a167-f761391ebffa"},"ResponsibleUserId":{"description":"The Unique Identifier of the Responsible User. Note: this can be found in the url path when viewing Responsible User details under global settings","type":"string","format":"uuid","example":"bc4836e2-c117-461b-a7a2-2b268c037a97"},"ResponsibleGroupId":{"description":"The Unique Identifier of the Responsible Group. Note: this can be found in the url path when viewing Responsible Group details under global settings","type":"string","format":"uuid","example":"5466af43-ff42-4a39-8722-5a98e7981fc4"},"ConsentIntegration":{"description":"Setting to fire the Data Subject Consent Updated integrations event. Note: we recommend using the `EnableNewConsentIntegration` setting to fire the Data Subject Profile Updated event instead","type":"boolean","example":false},"EnableNewConsentIntegration":{"description":"Setting to fire the Data Subject Profile Updated integrations event. For more information see this [article](https://my-onetrust-com.surrey.idm.oclc.org/s/article/UUID-58e8b9fb-0e47-5aca-713b-c2f26102d60c)","type":"boolean","example":false},"IsAuthenticationRequired":{"description":"Setting to require authentication for a collection point. For more information see this [article](https://my-onetrust-com.surrey.idm.oclc.org/s/article/UUID-b359a104-1900-9ac9-7765-ee08c8047f1d?topicId=0TO3q000000kIUHGA2)","type":"boolean","example":false},"ReconfirmActivePurpose":{"description":"Used in conjunction with the double opt in feature. Will treat a returning data subject the same as a new one, and trigger the confirmation email event when re-consenting to the same purpose","type":"boolean","example":false,"default":false},"OverrideActivePurpose":{"description":"Used in conjunction with the double opt in reconfirmation and purpose expiration features. This setting is enabled by default and can be turned off if it is desired for a purpose to remain in active status until expired if a data subject does not reconfirm their consent","type":"boolean","example":true,"default":true},"IsDynamicCollectionPoint":{"description":"Whether this is a dynamic collection point or not. For more information see this [article](https://my-onetrust-com.surrey.idm.oclc.org/s/article/UUID-358c7e03-1d60-ff3b-e443-25d4283c7ac3?topicId=0TO3q000000kIWXGA2)","type":"boolean","example":false},"NewSdkIntegrationEnabled":{"description":"Whether new sdk integration is enabled or not. SDK can be loaded in the and a new script is no longer required for each form","type":"boolean","example":false},"attributeValues":{"description":"A map of attribute names to their corresponding values and metadata. Used for storing custom attributes associated with the Collection Point.","type":"object","example":{"customField1":[{"value":"example","dataType":"string"}]},"additionalProperties":{"type":"array","description":"A map of attribute names to their corresponding values and metadata. Used for storing custom attributes associated with the Collection Point.","example":{"customField1":[{"value":"example","dataType":"string"}]},"items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_AttributeValueInformation"}}},"HostedWebForm":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_HostedWebFormDto"},"PurposeIdsWithVersion":{"description":"A list containing the IDs of purposes along with their versions that this Collection Point is associated with. Each entry maps a purpose ID to a specific version.","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_IdVersionPairDto"},"example":[{"id":"7912bfe1-37dd-4180-8b99-963e80f3e125","version":1}]},"includeIdentifierParameter":{"description":"When enabled, includes the identifier parameter in the double opt-in (DOI) confirmation link. This is useful for passing the identifier through the DOI process.","type":"boolean","example":false,"default":false},"EnablePublishEvent":{"description":"Setting to fire the Collection Point Published integrations event. For more information see this [article](https://my-onetrust-com.surrey.idm.oclc.org/s/article/UUID-58e8b9fb-0e47-5aca-713b-c2f26102d60c)","type":"boolean","example":false,"default":false},"EnablePrimaryIdentifier":{"description":"Setting to enable primary identifier functionality. When enabled, designates one of the identifiers as the primary identifier for the data subject.","type":"boolean","example":false,"default":false},"EnableCaptcha":{"description":"When enabled, requires users to complete a CAPTCHA challenge before submitting the form. This helps prevent automated submissions and spam.","type":"boolean","example":false,"default":false},"PrimaryIdentifierType":{"description":"The primary identifier type used to identify data subjects for this Collection Point. This is used when multiple identifier types are configured.","type":"string","example":"Email"},"CookieConsentUpdate":{"description":"Specifies how cookie consent updates should be handled for this Collection Point. This determines the behavior when consent preferences change.","type":"string","example":"UPDATE_ALL","enum":["UPDATE_ALL","SKIP_TRANSACTION"]},"EnableGeolocation":{"description":"When enabled, captures the data subject's geolocation (with their consent) for specific purposes. This feature is currently in preview.","type":"boolean","example":false,"default":false},"EnablePrefillIdentifier":{"description":"When enabled, allows the Collection Point to pre-fill identifier fields when possible, improving user experience for returning visitors.","type":"boolean","example":false,"default":false},"EnableGeoLocationForDataElements":{"description":"When enabled, captures the data subject's geolocation (with their consent) for specific data elements. This feature is currently in preview.","type":"boolean","example":false,"default":false},"RedirectOnFormSubmission":{"description":"When enabled, automatically redirects users to a specified URL after they submit the form. The redirect URL can be configured separately.","type":"boolean","example":false,"default":false},"DisableReports":{"description":"When set to true, disables all reporting for this Collection Point. This can be used to improve performance for high-volume Collection Points where reporting is not needed.","type":"boolean","example":false,"default":false},"ParentIdentifierTypes":{"description":"List of parent data subject identifier types for this Collection Point. Used with Consent on Behalf and Multiple Data Subject Identifiers features.","type":"array","items":{"type":"string"},"example":["Email","Mobile"]},"DOIEmailIdentifier":{"description":"The email address to use when sending double opt-in confirmation emails. If not specified, the primary email identifier will be used.","type":"string","example":"user@example.com"},"AckEmailIdentifier":{"description":"The email address to use when sending acknowledgment emails. This can be different from the main contact email for the Collection Point.","type":"string","example":"acknowledgment@example.com"},"PrefillIdentifier":{"description":"The identifier value to pre-fill in the form when known. This improves user experience by reducing data entry for returning visitors.","type":"string","example":"user@example.com"},"enablePurposeEvent":{"description":"When enabled, generates an event whenever a purpose-related action occurs through this Collection Point. Useful for triggering workflows or integrations.","type":"boolean","example":false,"default":false},"enableDataElementEvent":{"description":"When enabled, generates an event whenever a data element-related action occurs through this Collection Point. Useful for triggering workflows or integrations.","type":"boolean","example":false,"default":false},"enableCustomPreferenceEvent":{"description":"When enabled, generates an event for custom preference changes made through this Collection Point. Useful for triggering workflows or integrations.","type":"boolean","example":false,"default":false}},"required":["CollectionPointType","Description","Name","OrganizationId"]},"ConsentPreferences-UniversalConsentPreferenceManag_CollectionPointDetailDto":{"properties":{"jwtToken":{"description":"This property always returns null. To fetch the collection point's token, use the [Get collection point token API](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/gettokenusingget).","type":"string","example":"null"},"noticesWithVersions":{"description":"List of Privacy Notices attached to the Collection Point","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_CollectionPointNoticeWithVersionDto"},"example":["id","name","privacyNoticeGuid"]},"Id":{"description":"Unique Identifier of the Collection Point","type":"string","format":"uuid","example":"25d9ccac-db88-4d34-849c-3d602a629961"},"Version":{"description":"Version of the Collection Point","type":"integer","format":"int64","example":2},"Name":{"description":"Name of the Collection Point","type":"string","example":"Web Form Collection Point"},"CollectionPointType":{"description":"Type of the Collection Point","type":"string","example":"WEB_FORM","enum":["WEB_FORM","MOBILE_APPLICATION","BULK_IMPORT","API","PREFERENCE_CENTER","COOKIE","TRUST_CENTER","NOTIFICATION_OPT_OUT","ADMIN_UPDATE","HOSTED_WEB_FORM","EMBEDDED_WEB_FORM"]},"ConsentType":{"description":"Consent type of the Collection Point","type":"string","example":"FORMSUBMIT","enum":["FORMSUBMIT","EXPLICIT","UNAMBIGUOUS","OPTINCHECKBOX","OPTOUTCHECKBOX","SINGLETRIGGER","CONDITIONALTRIGGER","COOKIEBANNER","UNCHECKOPTOUT","CHECKOPTOUT"]},"Status":{"description":"Status of the Collection Point","type":"string","example":"ACTIVE","enum":["DRAFT","ACTIVE","RETIRED","INACTIVE"]},"SubjectIdentifier":{"description":"The Data Subject identifier of the Collection Point. Note: this string is the Data Element name when viewing details under the Consent & Preference Management module","type":"string","example":"Email"},"IdentifierDataElement":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_CustomDataElementDto"},"CreateDate":{"description":"Created Date of the Collection Point","type":"string","format":"date-time"},"FirstReceiptOn":{"description":"Date the first consent receipt was generated on for the Collection Point","type":"string","format":"date-time"},"ReceiptCount":{"description":"Number of consent receipts issued from this Collection Point","type":"integer","format":"int64","example":563},"Description":{"description":"Description of the Collection Point","type":"string","example":"Collecting data for Marketing and Promotion Purposes"},"WebFormUrl":{"description":"URL on which the Collection Point is hosted","type":"string","example":"https://www-onetrust-com.surrey.idm.oclc.org/"},"PrivacyPolicyUrl":{"description":"URL that redirects to a Privacy Policy associated with this Collection Point","type":"string","example":"https://www-onetrust-com.surrey.idm.oclc.org/privacy-notice"},"ActivationDate":{"description":"The Collection Point activation date","type":"string","format":"date-time"},"OrganizationId":{"description":"The unique Identifier of the Organization associated with the Collection Point. Note: this can be found in the url path when viewing Organization details under global settings","type":"string","format":"uuid","example":"92cf3a3a-09a9-4d04-b69d-ea5bb1db550a"},"DoubleOptIn":{"description":"Whether Double Opt In (email confirmation) is enabled or not","type":"boolean","example":false},"RedirectUrl":{"description":"Used in Double Opt In confirmation email to redirect the Data Subject to another website after confirming their consent","type":"string","example":"https://www-onetrust-com.surrey.idm.oclc.org/"},"IABVendorId":{"description":"The IAB Vendor Id. Used for legacy mobile Collection Points","type":"integer","format":"int32","example":13},"NoConsentTransactions":{"description":"Whether no consent transactions can be recorded against the collection point. For more information about consent transaction types and purpose statuses see this [article](https://my-onetrust-com.surrey.idm.oclc.org/s/article/UUID-d4ed05a9-a999-f2cb-8272-610a5817b43f?topicId=0TO1Q000000bHgoWAE)","type":"boolean","example":false},"LastSdkIntegrationDate":{"description":"The date that the SDK Integration was last copied on","type":"string","format":"date-time"},"Language":{"description":"The Collection Point default language code","type":"string","example":"en-us"},"Languages":{"description":"List containing the Collection Point translations' language codes","type":"array","items":{"type":"string"},"example":["en-us","fr"]},"HostedSDK":{"description":"Whether the SDK settings are published to external storage for quicker integration. This is enabled by default for all web form type collection points","type":"boolean","example":false},"SendConsentEmail":{"description":"Switch on or off the Consent Acknowledgement Email feature for a Collection Point","type":"boolean","example":false},"PreferenceCenter":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PreferenceCenterSummaryDto"},"ResponsibleUserId":{"description":"The Unique Identifier of the Responsible User. Note: this can be found in the url path when viewing Responsible User details under global settings","type":"string","format":"uuid","example":"bc4836e2-c117-461b-a7a2-2b268c037a97"},"ResponsibleGroupId":{"description":"The Unique Identifier of the Responsible Group. Note: this can be found in the url path when viewing Responsible Group details under global settings","type":"string","format":"uuid","example":"5466af43-ff42-4a39-8722-5a98e7981fc4"},"LastActivityDate":{"description":"Date on which the latest activity was recorded","type":"string","format":"date-time"},"ConsentIntegration":{"description":"Setting to fire the Data Subject Consent Updated integrations event. Note: we recommend using the `EnableNewConsentIntegration` setting to fire the Data Subject Profile Updated event instead","type":"boolean","example":false},"EnableNewConsentIntegration":{"description":"Setting to fire the Data Subject Profile Updated integrations event. For more information see this [article](https://my-onetrust-com.surrey.idm.oclc.org/s/article/UUID-58e8b9fb-0e47-5aca-713b-c2f26102d60c)","type":"boolean","example":false},"IsAuthenticationRequired":{"description":"Setting to require authentication for a collection point. For more information see this [article](https://my-onetrust-com.surrey.idm.oclc.org/s/article/UUID-b359a104-1900-9ac9-7765-ee08c8047f1d?topicId=0TO3q000000kIUHGA2)","type":"boolean","example":false},"CreatedBy":{"type":"string"},"LastModifiedBy":{"description":"Id of the user who last updated collection point","type":"string","example":"304F7D36-75A2-4967-81A5-5A7D604C6A19"},"ReconfirmActivePurpose":{"description":"Used in conjunction with the double opt in feature. Will treat a returning data subject the same as a new one, and trigger the confirmation email event when re-consenting to the same purpose","type":"boolean","example":false},"OverrideActivePurpose":{"description":"Used in conjunction with the double opt in reconfirmation and purpose expiration features. This setting is enabled by default and can be turned off if it is desired for a purpose to remain in active status until expired if a data subject does not reconfirm their consent","type":"boolean","example":false},"PublishedBy":{"description":"Id of the user who last published the collection point","type":"string","example":"304F7D36-75A2-4967-81A5-5A7D604C6A19"},"IsDynamicCollectionPoint":{"description":"Whether this is a dynamic collection point or not. For more information see this [article](https://my-onetrust-com.surrey.idm.oclc.org/s/article/UUID-358c7e03-1d60-ff3b-e443-25d4283c7ac3?topicId=0TO3q000000kIWXGA2)","type":"boolean","example":false},"DoiEmailToParent":{"description":"When enabling the parental consent feature and double opt in emails, emails will be sent to the parent identifier by default instead of the child identifier. For more information about this preview feature see this [article](https://my-onetrust-com.surrey.idm.oclc.org/s/article/UUID-f247abdd-fc02-413f-f5b8-17bff9dca4fa?topicId=0TO1Q000000ItSSWA0","type":"boolean","example":false},"NewSdkIntegrationEnabled":{"description":"Whether new sdk integration is enabled or not. SDK can be loaded in the and a new script is no longer required for each form","type":"boolean","example":false},"consentDOICancelOption":{"description":"Setting for sending a cancellation for DOI CP","type":"boolean","example":false},"DOISendConfirmationEmail":{"description":"Double Opt In child setting to send the confirmation email or not. Note: the confirmation link is included in the Data Subject Profile Updated integrations event, which can be used to send custom email or sms messages","type":"boolean","example":false},"Disabled":{"description":"Whether this collection point is disabled or not","type":"boolean","example":false},"EnablePublishEvent":{"description":"Setting to fire the Collection Point Published integrations event. For more information see this [article](https://my-onetrust-com.surrey.idm.oclc.org/s/article/UUID-58e8b9fb-0e47-5aca-713b-c2f26102d60c)","type":"boolean","example":false},"EnablePrimaryIdentifier":{"description":"Setting to enable primary identifier","type":"boolean","example":false},"EnableCaptcha":{"description":"Setting to enable captcha","type":"boolean","example":false},"PrimaryIdentifierType":{"description":"The primary Data Subject identifier type of the Collection Point","type":"string","example":"Email"},"EnableGeolocation":{"description":"Setting to capture Data Subject's geolocation if they provide consent with a specific purpose. Note the geolocation feature is currently under preview","type":"boolean","example":true},"EnableGeoLocationForDataElements":{"description":"Setting to capture Data Subject's geolocation if they provide consent with a specific data element. Note the geolocation feature is currently under preview","type":"boolean","example":true},"EnablePrefillIdentifier":{"description":"Setting to capture whether to remember identifier in portal side","type":"boolean","example":true},"RedirectOnFormSubmission":{"description":"Setting to enable/disable the redirection feature on form submission","type":"boolean","example":true},"DisableReports":{"description":"Setting to stop consent Data Subject report for this CollectionPoint","type":"boolean","example":true},"enablePurposeEvent":{"description":"Setting to enable delta events for purposes in this CollectionPoint","type":"boolean","example":true},"enableDataElementEvent":{"description":"Setting to enable delta events for data elements in this CollectionPoint","type":"boolean","example":true},"enableCustomPreferenceEvent":{"description":"Setting to enable delta events for custom preference in this CollectionPoint","type":"boolean","example":true},"DataElements":{"description":"List containing the Data Elements associated with the Collection Point","type":"array","items":{"type":"string"},"example":["First Name","Last Name","Work Email"]},"IdentifierTypes":{"description":"Used in conjunction with the `AllowMultipleIdentifierTypes` setting. The List of Data Subject identifiers that can be used for the Collection Point","type":"array","items":{"type":"string"},"example":["Email","Mobile"]},"AllowMultipleIdentifierTypes":{"description":"Allow list of Data Subject identifier types for the Collection Point","type":"boolean","example":true},"DataElementsTranslation":{"description":"Data Element Translation","type":"object","additionalProperties":{"type":"array","description":"Data Element Translation","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_DataElementLanguageDto"}}},"CanCreateNewVersion":{"description":"Whether a new version of the collection point can be created or not","type":"boolean","example":true},"attributes":{"description":"Attributes attached to the collection point","type":"object","additionalProperties":{"type":"array","description":"Attributes attached to the collection point","items":{"type":"string","description":"Attributes attached to the collection point"}}},"HostedWebForm":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_HostedWebFormDto"},"includeParameter":{"description":"Setting to include parameter for DOI CP","type":"boolean","example":false},"includeIdentifierParameter":{"description":"Setting to include Identifier parameter for DOI CP","type":"boolean","example":false},"CookieConsentUpdate":{"description":"Setting that governs cookie consent updates","type":"string","example":"SKIP_TRANSACTION, UPDATE_ALL","enum":["UPDATE_ALL","SKIP_TRANSACTION"]},"ParentIdentifierTypes":{"description":"The List of parent Data Subject identifier types for the Collection Point. Note: this setting is used with the Consent on Behalf and Multiple Data Subject Identifiers preview features\"","type":"array","items":{"type":"string"},"example":["First Name","Last Name","Address"]},"DOIEmailIdentifier":{"description":"Email identifier for which DOI needs to be sent","type":"string","example":"test@ot.com"},"AckEmailIdentifier":{"description":"Identifier for which acknowledgement email needs to be sent","type":"string","example":"testack@ot.com"},"PrefillIdentifier":{"description":"Identifier which needs to be prefilled","type":"string","example":"randomId"},"ShowDLNotification":{"description":"Setting to indicate whether to show data localization URL change notification for this collection point","type":"boolean","example":false},"Purposes":{"description":"The list of Purposes associated with the Collection Point","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PurposeDto"}}}},"ConsentPreferences-UniversalConsentPreferenceManag_CustomDataElementDto":{"properties":{"Id":{"description":"Unique identifier identifying a Custom Data Element","type":"string","format":"uuid","example":"21e0de87-d6ef-4b39-a54b-6d877698e3f6"},"Label":{"description":"The Custom Data Element name","type":"string","example":"Work Email"},"IsIdentifier":{"description":"Whether the Data Element can be used as an identifier","type":"boolean","example":false},"Languages":{"description":"List containing the Data Element's translations","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_DataElementLanguageDto"}},"NumberOfLanguages":{"description":"The number of languages the Data Element has been translated in","type":"integer","format":"int64","example":3},"CreatedDate":{"description":"The date that the Data Element was created on","type":"string","format":"date-time","example":"2019-12-30T10:52:30.974Z"},"UpdatedDate":{"description":"The date that the Data Element was last modified on","type":"string","format":"date-time","example":"2019-12-30T10:55:30.974Z"},"CollectionPoints":{"description":"The number of Collection Points in which the Data Element is used","type":"integer","format":"int64","example":2},"CollectionPointsWithoutRetired":{"description":"The number of Collection Points excluding Retired Collection Point in which the Data Element is used","type":"integer","format":"int64","example":2},"totalActivePreferenceCenters":{"description":"The number of Active Preference Centers associated with the Data Element","type":"integer","format":"int64","example":2},"PreferenceCenters":{"description":"The number of Preference Centers associated with the Data Element","type":"integer","format":"int64","example":2},"LinkedDataSubjectElementExists":{"description":"Boolean flag that denotes if the Custom Data Element is associated with Data Subject Elements","type":"boolean","example":false},"canEdit":{"description":"Whether the Data Element can be edited or not","type":"boolean","example":false},"canDelete":{"description":"Whether the Data Element can be deleted or not","type":"boolean","example":false},"PIInfo":{"description":"Boolean flag that denotes if the Custom Data Element belongs to PII","type":"boolean","example":false},"Organizations":{"description":"A list of Organization UUIDs","type":"array","items":{"type":"string","format":"uuid","description":"A list of Organization UUIDs"},"example":["712a1f61-a548-432f-afc4-5a383c28eeb2","862a1f61-e148-032f-afc4-7a383c28eec6"]}}},"ConsentPreferences-UniversalConsentPreferenceManag_PurposeDto":{"properties":{"Id":{"description":"Unique Identifier of the Purpose","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"Label":{"description":"Name of the Purpose","type":"string","example":"Marketing Communications"},"Description":{"description":"Description of the Purpose","type":"string","example":"Collect customer emails for marketing purposes"},"Status":{"description":"Status of the Purpose","type":"string","example":"ACTIVE"},"NewVersionAvailable":{"description":"Whether there is a new version of the Purpose available","type":"boolean","example":true},"Type":{"description":"Type of the Purpose","type":"string","example":"STANDARD"},"LifeSpan":{"description":"The lifespan of consents recorded against this Purpose in seconds","type":"integer","format":"int64","example":7889238},"ImplicitConsentConfirmDesc":{"description":"Description of Implicit Consent Confirmation Checkbox","type":"string","example":"I can confirm"},"PurposeCategory":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_AttributeValueInformation"},"Version":{"description":"Version of the Purpose","type":"integer","format":"int64","example":2},"ParentPurposeId":{"description":"Parent purpose guid","type":"string","format":"uuid","example":"ba54eb25-90f0-4633-ab12-c7bf5afdd856"},"ExternalReference":{"type":"string"},"includeParameter":{"description":"Setting to include parameter for DOI CP","type":"string","example":"false"},"CreatedDate":{"description":"Created Date of the Purpose","type":"string","format":"date-time","example":"2019-12-30T10:52:30.974Z"},"UpdatedBy":{"description":"Id of the user who updated the Purpose","type":"string","example":"304F7D36-75A2-4967-81A5-5A7D604C6A19"},"UpdatedDate":{"description":"Last Modified Date of the Purpose","type":"string","format":"date-time","example":"2019-12-30T10:54:30.974Z"},"PublishedBy":{"description":"Id of the user who published the Purpose","type":"string","example":"304F7D36-75A2-4967-81A5-5A7D604C6A19"},"PublishedDate":{"description":"Published Date of the purpose","type":"string","format":"date-time","example":"2019-12-30T10:54:30.974Z"},"Topics":{"description":"A list of the Purpose's Topics","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PurposeTopicDto"}},"CustomPreferences":{"description":"A list of the Purpose's Custom Preferences","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PurposeCustomPreferenceDto"}},"Organizations":{"description":"A list of the Purpose's Organizations","type":"array","items":{"type":"string","format":"uuid","description":"A list of the Purpose's Organizations"}},"attributes":{"description":"Custom Purpose Attributes configured in the Attribute Manager under Consent & Preference Management > Setup > Attribute Manager in the OneTrust application. If values are populated for the attribute they will be displayed in this field.","type":"object","additionalProperties":{"type":"array","description":"Custom Purpose Attributes configured in the Attribute Manager under Consent & Preference Management > Setup > Attribute Manager in the OneTrust application. If values are populated for the attribute they will be displayed in this field.","items":{"type":"string","description":"Custom Purpose Attributes configured in the Attribute Manager under Consent & Preference Management > Setup > Attribute Manager in the OneTrust application. If values are populated for the attribute they will be displayed in this field."}}},"PurposeIdWithVersion":{"type":"string"},"PurposeLanguages":{"description":"List of languages for a Purpose","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PurposeLanguageDto"}},"EnableGeolocation":{"description":"Setting to capture DataSubject's geolocation if they provide consent to this specific Purpose","type":"boolean","example":true},"LastMajorVersion":{"description":"The last major version number for this purpose","type":"integer","format":"int64","example":5},"VersionNotes":{"description":"Notes or comments about this version","type":"string","example":"Added new consent options"},"IsMajorVersion":{"description":"Indicates whether this version is a major release","type":"boolean","example":true},"HardOptOutDisplayFormat":{"description":"The format in which the purpose displays in a Trust Center when the consent status is Hard opt-out. Hard opt-out purposes can either be displayed but locked, or hidden.","type":"string","example":"HIDE","enum":["HIDE","LOCK"]},"HardOptOutMessage":{"description":"The message to display with the purpose when the consent status is Hard opt-out. This message only displays when hardOptOutDisplayFormat is set to LOCK.","type":"string","example":"This purpose is required and cannot be opted out"}}},"ConsentPreferences-UniversalConsentPreferenceManag_CustomPreferenceLanguageDtoV2_Simple":{"properties":{"name":{"type":"string"},"description":{"type":"string"},"language":{"type":"string"},"default":{"type":"boolean"},"options":{"type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_CustomPreferenceOptionDtoV2_Simple"}}}},"ConsentPreferences-UniversalConsentPreferenceManag_CustomPreferenceOptionDtoV2_Simple":{"properties":{"id":{"type":"string"},"label":{"type":"string"}}},"ConsentPreferences-UniversalConsentPreferenceManag_PagePurposeVersionsGroupedByGuid_Simple":{"type":"object","properties":{"content":{"description":"The list of items for the current page.","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PurposeVersionsGroupedByGuid_Simple"},"type":"array"},"empty":{"description":"The flag to check if the entity is empty or not.","type":"boolean","example":false},"first":{"description":"The flag to check if the entity is first entity or not.","type":"boolean","example":true},"last":{"description":"The flag to check if the entity is last entity or not.","type":"boolean","example":false},"number":{"description":"The number associated with the result.","type":"integer","format":"int32","example":0},"numberOfElements":{"description":"Total number of elements in the result.","type":"integer","format":"int32","example":20},"pageable":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PageableObject_Simple"},"sort":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_SortObject_Simple"},"totalPages":{"description":"Total number of pages in the result list.","type":"integer","format":"int32","example":5},"totalElements":{"description":"Total number of elements in the result.","type":"integer","format":"int64","example":50},"size":{"description":"Size of the result list.","type":"integer","format":"int32","example":20}}},"ConsentPreferences-UniversalConsentPreferenceManag_PageableObject_Simple":{"properties":{"offset":{"type":"integer","format":"int64"},"sort":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_SortObject_Simple"},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"paged":{"type":"boolean"},"unpaged":{"type":"boolean"}}},"ConsentPreferences-UniversalConsentPreferenceManag_PurposeCustomPreferenceDtoV2_Simple":{"properties":{"id":{"description":"Unique identifier of the purpose-custom preference relationship","type":"string","example":"c4a57a38-3774-45ad-9fa4-dbc545542232"},"name":{"description":"Name of the custom preference","type":"string","example":"Email Frequency"},"displayAs":{"description":"Display type for rendering the custom preference in the UI","type":"string","example":"BUTTONS","enum":["BUTTONS","CHECKBOXES"]},"customPreferenceOptions":{"description":"List of available options for this custom preference","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_CustomPreferenceOptionDtoV2_Simple"}},"languages":{"description":"List of language-specific content for the custom preference","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_CustomPreferenceLanguageDtoV2_Simple"}}},"required":["displayAs","id","name"]},"ConsentPreferences-UniversalConsentPreferenceManag_PurposeDtoV2_Simple":{"properties":{"label":{"description":"Name or label of the purpose version","type":"string","example":"Marketing Communications"},"description":{"description":"Detailed description of the purpose version","type":"string","example":"Collect customer emails for marketing purposes"},"status":{"description":"Current status of the purpose version","type":"string","example":"ACTIVE","enum":["DRAFT","ACTIVE","RETIRED"]},"version":{"description":"Version number of the purpose","type":"integer","format":"int64","example":2},"consentLifeSpan":{"description":"Lifespan of consents recorded against this purpose version in seconds","type":"integer","format":"int64","example":31536000},"implicitConsentLifeSpan":{"description":"Lifespan of implicit consents recorded against this purpose version in seconds","type":"integer","format":"int64","example":31536000},"implicitConsentConfirmDesc":{"description":"Description text for the implicit consent confirmation checkbox","type":"string","example":"I agree to the processing of my personal data for this purpose"},"purposeType":{"description":"Type of the purpose","type":"string","example":"STANDARD","enum":["STANDARD","COOKIE","IAB","MOBILE","NOTIFICATION_OPT_OUT"]},"parentPurposeId":{"description":"Unique identifier of the parent purpose, if this is a child purpose","type":"string","format":"uuid","example":"ba54eb25-90f0-4633-ab12-c7bf5afdd856"},"retireOnDate":{"description":"Date when the purpose will be retired","type":"string","format":"date-time","example":"2025-12-31T23:59:59Z"},"createdBy":{"description":"ID of the user who created the purpose","type":"string","example":"304F7D36-75A2-4967-81A5-5A7D604C6A19"},"createdDate":{"description":"Date and time when the purpose version was created","type":"string","format":"date-time","example":"2023-01-01T00:00:00Z"},"lastModifiedBy":{"description":"ID of the user who last modified the purpose","type":"string","example":"304F7D36-75A2-4967-81A5-5A7D604C6A19"},"lastModifiedDate":{"description":"Date and time when the purpose version was last modified","type":"string","format":"date-time","example":"2023-01-15T15:30:45Z"},"publishedBy":{"description":"ID of the user who published the purpose","type":"string","example":"304F7D36-75A2-4967-81A5-5A7D604C6A19"},"publishedDate":{"description":"Date and time when the purpose version was published","type":"string","format":"date-time","example":"2023-01-10T10:15:30Z"},"detail":{"description":"URL to get the detailed information of this purpose version","type":"string","example":"https://app-eu-onetrust-com.surrey.idm.oclc.org/api/consentmanager/v2/purposes/f2229953-b4b5-4042-8cb9-b78038cc4c46?version=2"},"customPreferences":{"description":"List of custom preferences associated with this purpose","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PurposeCustomPreferenceDtoV2_Simple"}},"topics":{"description":"List of topics associated with this purpose","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PurposeTopicDtoV2_Simple"}},"organizations":{"description":"List of organization IDs associated with this purpose","type":"array","items":{"type":"string","format":"uuid","description":"List of organization IDs associated with this purpose"},"example":["f2229953-b4b5-4042-8cb9-b78038cc4c46","bc4836e2-c117-461b-a7a2-2b268c037a97"]},"expiryDateType":{"description":"Type of date field used for calculating purpose lifespan/expiry","type":"string","example":"LAST_TRANSACTION_DATE","enum":["LAST_TRANSACTION_DATE","CONSENT_DATE"]},"enableGeolocation":{"description":"Flag indicating whether to capture the data subject's geolocation when consent is provided","type":"boolean","example":true},"LastMajorVersion":{"type":"integer","format":"int64"},"VersionNotes":{"type":"string"},"IsMajorVersion":{"type":"boolean"},"HardOptOutDisplayFormat":{"description":"The format in which the purpose displays in a Trust Center when the consent status is Hard opt-out. Hard opt-out purposes can either be displayed but locked, or hidden.","type":"string","example":"HIDE","enum":["HIDE","LOCK"]},"HardOptOutMessage":{"description":"The message to display with the purpose when the consent status is Hard opt-out. This message only displays when hardOptOutDisplayFormat is set to LOCK.","type":"string","example":"This purpose is required and cannot be opted out"}},"required":["label","purposeType","status","version"]},"ConsentPreferences-UniversalConsentPreferenceManag_PurposeTopicDtoV2_Simple":{"properties":{"id":{"description":"Unique identifier of the purpose-topic relationship","type":"string","format":"uuid","example":"497c4383-2c61-4906-aed0-660e3fd03ef0"},"transactionType":{"description":"Type of transaction associated with the topic","type":"string","example":"OPT_IN"},"name":{"description":"Name of the topic","type":"string","example":"Car Marketing"},"integrationKey":{"description":"Integration key formed by combining purpose and topic names","type":"string","example":"Marketing-Communications_Car-Marketing"},"languages":{"description":"List of language-specific content for the topic","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_TopicLanguageDtoV2_Simple"}},"canDelete":{"description":"Indicates whether this topic can be deleted","type":"boolean","example":true}},"required":["id","name"]},"ConsentPreferences-UniversalConsentPreferenceManag_PurposeVersionsGroupedByGuid_Simple":{"properties":{"purposeId":{"description":"Unique identifier of the purpose","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"retireOnDate":{"description":"Date when the purpose will be retired","type":"string","format":"date-time","example":"2025-12-31T23:59:59Z"},"createdDate":{"description":"Date when the purpose was created","type":"string","format":"date-time","example":"2023-01-01T00:00:00Z"},"publishedBy":{"description":"ID of the user who last published the purpose","type":"string","example":"304F7D36-75A2-4967-81A5-5A7D604C6A19"},"publishedDate":{"description":"Date when the purpose was last published","type":"string","format":"date-time","example":"2023-01-15T10:30:00Z"},"lastModifiedDate":{"description":"Date when the purpose was last modified","type":"string","format":"date-time","example":"2023-01-10T15:45:30Z"},"versions":{"description":"List of all versions of the purpose","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PurposeDtoV2_Simple"}},"attributes":{"description":"Additional attributes attached to the purpose","type":"object","additionalProperties":{"type":"array","description":"Additional attributes attached to the purpose","items":{"type":"string","description":"Additional attributes attached to the purpose"}}}},"required":["createdDate","purposeId","versions"]},"ConsentPreferences-UniversalConsentPreferenceManag_SortObject_Simple":{"properties":{"empty":{"type":"boolean"},"unsorted":{"type":"boolean"},"sorted":{"type":"boolean"}}},"ConsentPreferences-UniversalConsentPreferenceManag_TopicLanguageDtoV2_Simple":{"properties":{"name":{"type":"string"},"language":{"type":"string"},"default":{"type":"boolean"}}},"ConsentPreferences-UniversalConsentPreferenceManag_CustomPreferenceLanguageDtoV2_Detail":{"properties":{"name":{"type":"string"},"description":{"type":"string"},"language":{"type":"string"},"default":{"type":"boolean"},"options":{"type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_CustomPreferenceOptionDtoV2_Detail"}}}},"ConsentPreferences-UniversalConsentPreferenceManag_CustomPreferenceOptionDtoV2_Detail":{"properties":{"id":{"type":"string"},"transactionType":{"type":"string"},"label":{"type":"string"},"order":{"type":"integer","format":"int32"},"isDefault":{"type":"boolean"}}},"ConsentPreferences-UniversalConsentPreferenceManag_PurposeCustomPreferenceDtoV2_Detail":{"properties":{"id":{"description":"Unique identifier of the purpose-custom preference relationship","type":"string","example":"c4a57a38-3774-45ad-9fa4-dbc545542232"},"name":{"description":"Name of the custom preference","type":"string","example":"Email Frequency"},"displayAs":{"description":"Display type for rendering the custom preference in the UI","type":"string","example":"BUTTONS","enum":["BUTTONS","CHECKBOXES"]},"customPreferenceOptions":{"description":"List of available options for this custom preference","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_CustomPreferenceOptionDtoV2_Detail"}},"languages":{"description":"List of language-specific content for the custom preference","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_CustomPreferenceLanguageDtoV2_Detail"}}},"required":["displayAs","id","name"]},"ConsentPreferences-UniversalConsentPreferenceManag_PurposeDetailDtoV2_Detail":{"type":"object","properties":{"id":{"description":"Unique identifier of the purpose","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"label":{"description":"Name or label of the purpose version","type":"string","example":"Marketing Communications"},"description":{"description":"Detailed description of the purpose version","type":"string","example":"Collect customer emails for marketing purposes"},"status":{"description":"Current status of the purpose version","type":"string","example":"ACTIVE","enum":["DRAFT","ACTIVE","RETIRED"]},"version":{"description":"Version number of the purpose","type":"integer","format":"int64","example":2},"consentLifeSpan":{"description":"Lifespan of consents recorded against this purpose version in seconds","type":"integer","format":"int64","example":31536000},"implicitConsentLifeSpan":{"description":"Lifespan of implicit consents recorded against this purpose version in seconds","type":"integer","format":"int64","example":31536000},"implicitConsentConfirmDesc":{"description":"Description text for the implicit consent confirmation checkbox","type":"string","example":"I agree to the processing of my personal data for this purpose"},"purposeType":{"description":"Type of the purpose","type":"string","example":"STANDARD","enum":["STANDARD","COOKIE","IAB","MOBILE","NOTIFICATION_OPT_OUT"]},"parentPurposeId":{"description":"Unique identifier of the parent purpose, if this is a child purpose","type":"string","format":"uuid","example":"ba54eb25-90f0-4633-ab12-c7bf5afdd856"},"retireOnDate":{"description":"Date when the purpose will be retired","type":"string","format":"date-time","example":"2025-12-31T23:59:59Z"},"createdBy":{"description":"ID of the user who created the purpose","type":"string","example":"304F7D36-75A2-4967-81A5-5A7D604C6A19"},"createdDate":{"description":"Date and time when the purpose version was created","type":"string","format":"date-time","example":"2023-01-01T00:00:00Z"},"lastModifiedBy":{"description":"ID of the user who last modified the purpose","type":"string","example":"304F7D36-75A2-4967-81A5-5A7D604C6A19"},"lastModifiedDate":{"description":"Date and time when the purpose version was last modified","type":"string","format":"date-time","example":"2023-01-15T15:30:45Z"},"publishedBy":{"description":"ID of the user who published the purpose","type":"string","example":"304F7D36-75A2-4967-81A5-5A7D604C6A19"},"publishedDate":{"description":"Date and time when the purpose version was published","type":"string","format":"date-time","example":"2023-01-10T10:15:30Z"},"customPreferences":{"description":"List of custom preferences associated with the purpose","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PurposeCustomPreferenceDtoV2_Detail"}},"topics":{"description":"List of topics associated with the purpose","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PurposeTopicDtoV2_Detail"}},"expiryDateType":{"description":"Type of date field used for calculating purpose lifespan/expiry","type":"string","example":"LAST_TRANSACTION_DATE","enum":["LAST_TRANSACTION_DATE","CONSENT_DATE"]},"enableGeolocation":{"description":"Flag indicating whether to capture the data subject's geolocation when consent is provided","type":"boolean","example":true},"attributes":{"description":"Additional attributes attached to the purpose","type":"object","additionalProperties":{"type":"array","description":"Additional attributes attached to the purpose","items":{"type":"string","description":"Additional attributes attached to the purpose"}}},"LastMajorVersion":{"type":"integer","format":"int64"},"VersionNotes":{"type":"string"},"IsMajorVersion":{"type":"boolean"},"HardOptOutDisplayFormat":{"description":"The format in which the purpose displays in a Trust Center when the consent status is Hard opt-out. Hard opt-out purposes can either be displayed but locked, or hidden.","type":"string","example":"HIDE","enum":["HIDE","LOCK"]},"HardOptOutMessage":{"description":"The message to display with the purpose when the consent status is Hard opt-out. This message only displays when hardOptOutDisplayFormat is set to LOCK.","type":"string","example":"This purpose is required and cannot be opted out"},"languages":{"description":"List of languages supported by the purpose","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PurposeLanguageDtoV2_Detail"}},"receiptInclusionAttributes":{"description":"Attributes that should be included in the receipt","type":"object","additionalProperties":{"type":"array","description":"Attributes that should be included in the receipt","items":{"type":"string","description":"Attributes that should be included in the receipt"}}}},"required":["id","label","purposeType","status","version"]},"ConsentPreferences-UniversalConsentPreferenceManag_PurposeLanguageDtoV2_Detail":{"properties":{"name":{"description":"The purpose name in the specified language","type":"string","example":"Marketing Communications"},"description":{"description":"The purpose description in the specified language","type":"string","example":"Collect customer emails for marketing purposes"},"implicitConsentConfirmDesc":{"description":"Description text for the implicit consent confirmation checkbox in the specified language","type":"string","example":"I agree to the processing of my personal data for this purpose"},"language":{"description":"IETF BCP 47 language tag for the content","type":"string","example":"en-US"},"default":{"description":"Indicates if this is the default language for the purpose","type":"boolean","example":true},"hardOptOutMessage":{"description":"The message to display with the purpose when the consent status is Hard opt-out. This message only displays when hardOptOutDisplayFormat is set to LOCK.","type":"string","example":"This purpose is required and cannot be opted out"}},"required":["description","name"]},"ConsentPreferences-UniversalConsentPreferenceManag_PurposeTopicDtoV2_Detail":{"properties":{"id":{"description":"Unique identifier of the purpose-topic relationship","type":"string","format":"uuid","example":"497c4383-2c61-4906-aed0-660e3fd03ef0"},"transactionType":{"description":"Type of transaction associated with the topic","type":"string","example":"OPT_IN"},"name":{"description":"Name of the topic","type":"string","example":"Car Marketing"},"integrationKey":{"description":"Integration key formed by combining purpose and topic names","type":"string","example":"Marketing-Communications_Car-Marketing"},"languages":{"description":"List of language-specific content for the topic","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_TopicLanguageDtoV2_Detail"}},"canDelete":{"description":"Indicates whether this topic can be deleted","type":"boolean","example":true}},"required":["id","name"]},"ConsentPreferences-UniversalConsentPreferenceManag_TopicLanguageDtoV2_Detail":{"properties":{"name":{"type":"string"},"language":{"type":"string"},"default":{"type":"boolean"}}},"ConsentPreferences-UniversalConsentPreferenceManag_PagePreferenceCenterSummaryDtoV2":{"type":"object","properties":{"content":{"description":"The list of items for the current page.","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PreferenceCenterSummaryDtoV2"},"type":"array"},"empty":{"description":"The flag to check if the entity is empty or not.","type":"boolean","example":false},"first":{"description":"The flag to check if the entity is first entity or not.","type":"boolean","example":true},"last":{"description":"The flag to check if the entity is last entity or not.","type":"boolean","example":false},"number":{"description":"The number associated with the result.","type":"integer","format":"int32","example":0},"numberOfElements":{"description":"Total number of elements in the result.","type":"integer","format":"int32","example":20},"pageable":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PageableObject"},"sort":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_SortObject"},"totalPages":{"description":"Total number of pages in the result list.","type":"integer","format":"int32","example":5},"totalElements":{"description":"Total number of elements in the result.","type":"integer","format":"int64","example":50},"size":{"description":"Size of the result list.","type":"integer","format":"int32","example":20}}},"ConsentPreferences-UniversalConsentPreferenceManag_PreferenceCenterSummaryDtoV2":{"properties":{"id":{"description":"Unique identifier of the Preference Center","type":"string","format":"uuid","example":"09ccd1b9-84a0-4bcb-a167-f761391ebffa"},"name":{"description":"Name of the Preference Center","type":"string","example":"Email Communication Preferences"},"organizationName":{"description":"Name of the organization that owns the Preference Center","type":"string","example":"OneTrust"},"template":{"description":"Template type used for the Preference Center","type":"string","enum":["ORIGINAL","ENHANCED","MULTIPAGE"]},"publishedDate":{"description":"Date and time when the Preference Center was published","type":"string","format":"date-time"},"status":{"description":"Current status of the Preference Center","type":"string","enum":["DRAFT","ACTIVE","RETIRED","INACTIVE"]},"createdDate":{"description":"Date and time when the Preference Center was created","type":"string","format":"date-time"}},"required":["createdDate","id","name","organizationName","status","template"]},"ConsentPreferences-UniversalConsentPreferenceManag_AdvancedPreferenceCenterDto_RootPublicAPI":{"type":"object","properties":{"pages":{"description":"A list of all the pages attached to the Preference center","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PreferenceCenterPageDto_RootPublicAPI"}},"defaultLanguage":{"description":"The default language of the preference center","type":"string","example":"en"},"languages":{"description":"A list of translations for the preference center","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_TranslationDto_RootPublicAPI"}},"preferenceCenterSettings":{"description":"A list of labels and their translations for the preference center","type":"object","additionalProperties":{"type":"object","description":"A list of labels and their translations for the preference center"}},"enableMultipleIdentities":{"description":"Boolean flag that denotes if Multi-Identity is enabled for the Preference center","type":"boolean","example":false},"hierarchicalAccessControl":{"description":"Indicates if hierarchical access control is enabled for this preference center","type":"boolean","example":false},"displayUnsubscribeAll":{"description":"Boolean flag that denotes if Unsubscribe-All section needs to be displayed for the Preference center","type":"boolean","example":false},"displaySubscribeAll":{"description":"Boolean flag that denotes if Subscribe-All section needs to be displayed for the Preference center","type":"boolean","example":false},"displayNotificationPurpose":{"description":"Boolean flag that denotes if Notification purpose needs to be displayed on the Preference center","type":"boolean","example":false},"displaySubscribeSettings":{"description":"Boolean flag that denotes if Subscribe settings section needs to be displayed for the Preference center","type":"boolean","example":false},"notificationPurpose":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PCPurposeDto_RootPublicAPI"},"displayPageLevelSubscribeSettings":{"description":"Boolean flag that denotes if Subscribe settings section is allowed to be configured specific to each Preference center page","type":"boolean","example":false},"autoCheckTopics":{"description":"Boolean flag that denotes if auto check topics feature is enabled for the Preference center","type":"boolean","example":false},"updateNotOptedOutToActiveStatus":{"description":"Boolean flag that denotes if 'update not opted-out' to 'active' status is enabled for the Preference center","type":"boolean","example":false}}},"ConsentPreferences-UniversalConsentPreferenceManag_PCCustomPreferenceDto_RootPublicAPI":{"properties":{"id":{"description":"Unique identifier of the custom preference","type":"string","format":"uuid","example":"497c4383-2c61-4906-aed0-660e3fd03ef0"},"name":{"description":"Name of the custom preference","type":"string","example":"Email Frequency"},"description":{"description":"Detailed description of the custom preference","type":"string","example":"Options for different frequencies to receive emails"},"selectionType":{"description":"Type of selection allowed for this preference","type":"string","example":"SINGLE_CHOICE","enum":["SINGLE_CHOICE","MULTI_CHOICE"]},"displayAs":{"description":"How the preference options should be displayed","type":"string","example":"BUTTONS","enum":["BUTTONS","CHECKBOXES"]},"required":{"description":"Whether a selection is required for this preference","type":"boolean","example":false,"default":false},"languages":{"description":"List of translations for the custom preference","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_TranslationDto_RootPublicAPI"}},"customPreferenceOptions":{"description":"List of available options for this custom preference","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PCCustomPreferenceOptionDto_RootPublicAPI"}}}},"ConsentPreferences-UniversalConsentPreferenceManag_PCCustomPreferenceOptionDto_RootPublicAPI":{"properties":{"id":{"description":"Unique identifier of the option","type":"string","format":"uuid","example":"ca0fc41b-b28a-4335-804c-44d1f0f782ed"},"label":{"description":"Display label for the option","type":"string","example":"Weekly"},"order":{"description":"Display order of the option (0-based index)","type":"integer","format":"int32","example":1},"isDefault":{"description":"Indicates if this option is selected by default","type":"boolean","example":true},"languages":{"description":"List of translations for the option label","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_TranslationDto_RootPublicAPI"}}}},"ConsentPreferences-UniversalConsentPreferenceManag_PCPurposeDto_RootPublicAPI":{"properties":{"id":{"description":"Unique identifier of the element","type":"string","format":"uuid","example":"ca0fc41b-b28a-4335-804c-44d1f0f782ed"},"order":{"description":"Display order of the element within the section","type":"integer","format":"int64","example":1},"languages":{"description":"Available translations for the element's content","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_TranslationDto_RootPublicAPI"}},"label":{"description":"Name of the purpose","type":"string","example":"Marketing Communications"},"description":{"description":"Detailed description of the purpose","type":"string","example":"Collect customer emails for marketing purposes"},"implicitConsentConfirmDesc":{"description":"Description shown for the implicit consent confirmation checkbox","type":"string","example":"I agree to receive marketing communications"},"version":{"description":"Version number of the purpose","type":"integer","format":"int64","example":2},"topics":{"description":"List of topics associated with this purpose","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PCPurposeTopicDto_RootPublicAPI"}},"customPreferences":{"description":"List of custom preferences associated with this purpose","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PCCustomPreferenceDto_RootPublicAPI"}},"visibility":{"description":"Visibility settings for the purpose in the preference center","type":"string","enum":["VISIBLE_TO_ALL","VISIBLE_TO_CONSENTED","VISIBLE_TO_PRIOR_CONSENTED"]}}},"ConsentPreferences-UniversalConsentPreferenceManag_PCPurposeTopicDto_RootPublicAPI":{"properties":{"id":{"description":"Unique identifier of the topic-purpose relationship","type":"string","format":"uuid","example":"497c4383-2c61-4906-aed0-660e3fd03ef0"},"name":{"description":"Name of the topic","type":"string","example":"Car Marketing"},"languages":{"description":"List of translations for the topic's name","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_TranslationDto_RootPublicAPI"}}}},"ConsentPreferences-UniversalConsentPreferenceManag_PreferenceCenterPageDto_RootPublicAPI":{"properties":{"id":{"description":"The unique identifier of the Preference Center Page","type":"string","format":"uuid","example":"497c4383-2c61-4906-aed0-660e3fd03ef0"},"order":{"description":"Order of Preference Center Page","type":"integer","format":"int64","example":1},"navigationEnabled":{"description":"Indicates if the Preference Center page navigation is enabled","type":"boolean","example":false},"displaySubscribeSettings":{"description":"Indicates if Subscribe settings should be displayed on the page","type":"boolean","example":false},"displayUnsubscribeAll":{"description":"Indicates if the 'Unsubscribe All' option should be displayed on the page","type":"boolean","example":false},"displaySubscribeAll":{"description":"Indicates if the 'Subscribe All' option should be displayed on the page","type":"boolean","example":false},"languages":{"description":"List of available language translations for this page","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_TranslationDto_RootPublicAPI"}}}},"ConsentPreferences-UniversalConsentPreferenceManag_TranslationDto_RootPublicAPI":{"properties":{"name":{"description":"Translated name of the item","type":"string","example":"Comunicaciones de marketing"},"description":{"description":"Translated description of the item","type":"string","example":"Recopilar correos electrรณnicos de clientes con fines de marketing"},"implicitConsentConfirmDesc":{"description":"Translated text for implicit consent confirmation","type":"string","example":"I can confirm"},"content":{"description":"Translated rich text content (may include HTML)","example":"bloque de texto
","type":"string"},"language":{"description":"Language code for this translation (ISO 639-1)","type":"string","example":"es"},"isDefault":{"description":"Indicates if this is the default translation","type":"boolean","example":false}},"required":["language"]},"ConsentPreferences-UniversalConsentPreferenceManag_ElementDto_PagePublicAPI":{"properties":{"id":{"description":"Unique identifier of the element","type":"string","format":"uuid","example":"ca0fc41b-b28a-4335-804c-44d1f0f782ed"},"order":{"description":"Display order of the element within the section","type":"integer","format":"int64","example":1},"languages":{"description":"Available translations for the element's content","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_TranslationDto_PagePublicAPI"}}}},"ConsentPreferences-UniversalConsentPreferenceManag_PCCustomDataElementDto_PagePublicAPI":{"properties":{"id":{"description":"Unique identifier of the element","type":"string","format":"uuid","example":"ca0fc41b-b28a-4335-804c-44d1f0f782ed"},"order":{"description":"Display order of the element within the section","type":"integer","format":"int64","example":1},"languages":{"description":"Available translations for the element's content","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_TranslationDto_PagePublicAPI"}},"name":{"description":"Name of the custom data element","type":"string","example":"Work Email"},"hidden":{"description":"Whether the element is hidden from the UI","type":"boolean","example":false},"readOnly":{"description":"Whether the element is read-only","type":"boolean","example":false},"required":{"description":"Whether the element is required","type":"boolean","example":false}}},"ConsentPreferences-UniversalConsentPreferenceManag_PCCustomPreferenceDto_PagePublicAPI":{"properties":{"id":{"description":"Unique identifier of the custom preference","type":"string","format":"uuid","example":"497c4383-2c61-4906-aed0-660e3fd03ef0"},"name":{"description":"Name of the custom preference","type":"string","example":"Email Frequency"},"description":{"description":"Detailed description of the custom preference","type":"string","example":"Options for different frequencies to receive emails"},"selectionType":{"description":"Type of selection allowed for this preference","type":"string","example":"SINGLE_CHOICE","enum":["SINGLE_CHOICE","MULTI_CHOICE"]},"displayAs":{"description":"How the preference options should be displayed","type":"string","example":"BUTTONS","enum":["BUTTONS","CHECKBOXES"]},"required":{"description":"Whether a selection is required for this preference","type":"boolean","example":false,"default":false},"languages":{"description":"List of translations for the custom preference","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_TranslationDto_PagePublicAPI"}},"customPreferenceOptions":{"description":"List of available options for this custom preference","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PCCustomPreferenceOptionDto_PagePublicAPI"}}}},"ConsentPreferences-UniversalConsentPreferenceManag_PCCustomPreferenceOptionDto_PagePublicAPI":{"properties":{"id":{"description":"Unique identifier of the option","type":"string","format":"uuid","example":"ca0fc41b-b28a-4335-804c-44d1f0f782ed"},"label":{"description":"Display label for the option","type":"string","example":"Weekly"},"order":{"description":"Display order of the option (0-based index)","type":"integer","format":"int32","example":1},"isDefault":{"description":"Indicates if this option is selected by default","type":"boolean","example":true},"languages":{"description":"List of translations for the option label","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_TranslationDto_PagePublicAPI"}}}},"ConsentPreferences-UniversalConsentPreferenceManag_PCPurposeDto_PagePublicAPI":{"properties":{"id":{"description":"Unique identifier of the element","type":"string","format":"uuid","example":"ca0fc41b-b28a-4335-804c-44d1f0f782ed"},"order":{"description":"Display order of the element within the section","type":"integer","format":"int64","example":1},"languages":{"description":"Available translations for the element's content","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_TranslationDto_PagePublicAPI"}},"label":{"description":"Name of the purpose","type":"string","example":"Marketing Communications"},"description":{"description":"Detailed description of the purpose","type":"string","example":"Collect customer emails for marketing purposes"},"implicitConsentConfirmDesc":{"description":"Description shown for the implicit consent confirmation checkbox","type":"string","example":"I agree to receive marketing communications"},"version":{"description":"Version number of the purpose","type":"integer","format":"int64","example":2},"topics":{"description":"List of topics associated with this purpose","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PCPurposeTopicDto_PagePublicAPI"}},"customPreferences":{"description":"List of custom preferences associated with this purpose","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PCCustomPreferenceDto_PagePublicAPI"}},"visibility":{"description":"Visibility settings for the purpose in the preference center","type":"string","enum":["VISIBLE_TO_ALL","VISIBLE_TO_CONSENTED","VISIBLE_TO_PRIOR_CONSENTED"]}}},"ConsentPreferences-UniversalConsentPreferenceManag_PCPurposeTopicDto_PagePublicAPI":{"properties":{"id":{"description":"Unique identifier of the topic-purpose relationship","type":"string","format":"uuid","example":"497c4383-2c61-4906-aed0-660e3fd03ef0"},"name":{"description":"Name of the topic","type":"string","example":"Car Marketing"},"languages":{"description":"List of translations for the topic's name","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_TranslationDto_PagePublicAPI"}}}},"ConsentPreferences-UniversalConsentPreferenceManag_PCSectionTranslationDto_PagePublicAPI":{"properties":{"name":{"description":"Translated name of the item","type":"string","example":"Comunicaciones de marketing"},"description":{"description":"Translated description of the item","type":"string","example":"Recopilar correos electrรณnicos de clientes con fines de marketing"},"implicitConsentConfirmDesc":{"description":"Translated text for implicit consent confirmation","type":"string","example":"I can confirm"},"content":{"description":"Translated rich text content (may include HTML)","example":"bloque de texto
","type":"string"},"language":{"description":"Language code for this translation (ISO 639-1)","type":"string","example":"es"},"isDefault":{"description":"Indicates if this is the default translation","type":"boolean","example":false}},"required":["language"]},"ConsentPreferences-UniversalConsentPreferenceManag_PreferenceCenterPageDto_PagePublicAPI":{"type":"object","properties":{"id":{"description":"The unique identifier of the Preference Center Page","type":"string","format":"uuid","example":"497c4383-2c61-4906-aed0-660e3fd03ef0"},"order":{"description":"Order of Preference Center Page","type":"integer","format":"int64","example":1},"isHidden":{"description":"Indicates if the Preference Center page header is hidden","type":"boolean","example":false},"navigationEnabled":{"description":"Indicates if the Preference Center page navigation is enabled","type":"boolean","example":false},"displaySubscribeSettings":{"description":"Indicates if Subscribe settings should be displayed on the page","type":"boolean","example":false},"displayUnsubscribeAll":{"description":"Indicates if the 'Unsubscribe All' option should be displayed on the page","type":"boolean","example":false},"displaySubscribeAll":{"description":"Indicates if the 'Subscribe All' option should be displayed on the page","type":"boolean","example":false},"sections":{"description":"List of sections contained within this Preference Center page","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PreferenceCenterSectionDto_PagePublicAPI"}},"languages":{"description":"List of available language translations for this page","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_TranslationDto_PagePublicAPI"}}}},"ConsentPreferences-UniversalConsentPreferenceManag_PreferenceCenterSectionDto_PagePublicAPI":{"properties":{"id":{"description":"The unique identifier of the Preference Center Section","type":"string","format":"uuid","example":"497c4383-2c61-4906-aed0-660e3fd03ef0"},"identifierType":{"description":"Type of identifier used for the section (e.g., Email, Phone, CustomID)","type":"string","example":"Email"},"isHeaderHidden":{"description":"Indicates if the section header should be hidden","type":"boolean","example":false},"order":{"description":"The display order of the section within the page","type":"integer","format":"int64","example":1},"purposes":{"description":"List of purposes associated with this section","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PCPurposeDto_PagePublicAPI"}},"customDataElements":{"description":"Custom data elements associated with this section","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PCCustomDataElementDto_PagePublicAPI"}},"elements":{"description":"UI elements and components in this section","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_ElementDto_PagePublicAPI"}},"languages":{"description":"Available language translations for this section","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PCSectionTranslationDto_PagePublicAPI"}},"isSubscriptionSettings":{"description":"Indicates if this is the system-managed subscription settings section","type":"boolean","example":false}}},"ConsentPreferences-UniversalConsentPreferenceManag_TranslationDto_PagePublicAPI":{"properties":{"name":{"description":"Translated name of the item","type":"string","example":"Comunicaciones de marketing"},"description":{"description":"Translated description of the item","type":"string","example":"Recopilar correos electrรณnicos de clientes con fines de marketing"},"implicitConsentConfirmDesc":{"description":"Translated text for implicit consent confirmation","type":"string","example":"I can confirm"},"content":{"description":"Translated rich text content (may include HTML)","example":"bloque de texto
","type":"string"},"language":{"description":"Language code for this translation (ISO 639-1)","type":"string","example":"es"},"isDefault":{"description":"Indicates if this is the default translation","type":"boolean","example":false}},"required":["language"]},"ConsentPreferences-UniversalConsentPreferenceManag_DataSubjectEntry_Page":{"properties":{"id":{"description":"Unique identifier of the Data Subject","type":"string","format":"uuid","example":"c43a9190-ffd6-4be3-aeff-95b46d0fa59f"},"identifier":{"description":"The identifier value of the Data Subject","type":"string","example":"example@otprivacy.com"},"identifierType":{"description":"The type of identifier used for the Data Subject (e.g., Email, Phone, CustomID)","type":"string","example":"Email"}},"required":["identifier","identifierType"]},"ConsentPreferences-UniversalConsentPreferenceManag_LinkedIdentityGroupDto_Page":{"properties":{"id":{"description":"Globally unique identifier of a Linked Identity Group","type":"string","format":"uuid","example":"b0a6b5da-4ea2-4a9f-a25a-fb3e212efc30"},"numberOfDataSubjects":{"description":"The number of Data Subjects in a Linked Identity Group","type":"integer","format":"int64","example":6},"createdDate":{"description":"Creation date of a Linked Identity Group","type":"string","format":"date-time","example":"2020-05-30T10:52:30.974Z"},"lastModifiedDate":{"description":"Last modified date of a Linked Identity Group","type":"string","format":"date-time","example":"2020-05-30T12:23:42.145Z"},"primaryDataSubjects":{"description":"List of primary Data Subjects in the Linked Identity Group","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_DataSubjectEntry_Page"}},"organizations":{"description":"Set of organization UUIDs associated with the linked identity group","type":"array","items":{"type":"string","format":"uuid","description":"Set of organization UUIDs associated with the linked identity group"},"example":["550e8400-e29b-41d4-a716-446655440000","6ba7b810-9dad-11d1-80b4-00c04fd430c8"],"uniqueItems":true},"primaryDataSubjectId":{"description":"Globally unique identifier of the primary Data Subject","type":"string","format":"uuid","example":"c43a9190-ffd6-4be3-aeff-95b46d0fa59f"},"primaryDataSubjectIdentifier":{"description":"The identifier value of the primary Data Subject","type":"string","example":"example@otprivacy.com"},"primaryDataSubjectIdentifierType":{"description":"The identifier type of the primary Data Subject","type":"string","example":"Email"},"isPrimary":{"description":"Boolean flag that denotes if the Data Subject is the primary of the group","type":"boolean","example":false},"groupName":{"description":"The name of the linked identity group","type":"string","example":"Customer Group A"},"key":{"description":"The type of the linked identity group","type":"string","enum":["PRIMARY","CHILD","GROUP_NAME"]}}},"ConsentPreferences-UniversalConsentPreferenceManag_PageLinkedIdentityGroupDto_Page":{"type":"object","properties":{"content":{"description":"The list of items for the current page.","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_LinkedIdentityGroupDto_Page"},"type":"array"},"empty":{"description":"The flag to check if the entity is empty or not.","type":"boolean","example":false},"first":{"description":"The flag to check if the entity is first entity or not.","type":"boolean","example":true},"last":{"description":"The flag to check if the entity is last entity or not.","type":"boolean","example":false},"number":{"description":"The number associated with the result.","type":"integer","format":"int32","example":0},"numberOfElements":{"description":"Total number of elements in the result.","type":"integer","format":"int32","example":20},"pageable":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PageableObject_Page"},"sort":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_SortObject_Page"},"totalPages":{"description":"Total number of pages in the result list.","type":"integer","format":"int32","example":5},"totalElements":{"description":"Total number of elements in the result.","type":"integer","format":"int64","example":50},"size":{"description":"Size of the result list.","type":"integer","format":"int32","example":20}}},"ConsentPreferences-UniversalConsentPreferenceManag_PageableObject_Page":{"properties":{"offset":{"type":"integer","format":"int64"},"sort":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_SortObject_Page"},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"paged":{"type":"boolean"},"unpaged":{"type":"boolean"}}},"ConsentPreferences-UniversalConsentPreferenceManag_SortObject_Page":{"properties":{"empty":{"type":"boolean"},"unsorted":{"type":"boolean"},"sorted":{"type":"boolean"}}},"ConsentPreferences-UniversalConsentPreferenceManag_CollectionPointDtoV2_DetailV2":{"properties":{"id":{"description":"Unique identifier of the collection point","type":"string","format":"uuid","example":"25d9ccac-db88-4d34-849c-3d602a629961"},"version":{"description":"Version number of the collection point","type":"integer","format":"int64","example":2,"minimum":1},"name":{"description":"Name of the collection point","type":"string","example":"Web Form Collection Point"},"status":{"description":"Current status of the collection point","type":"string","example":"ACTIVE","enum":["DRAFT","ACTIVE","RETIRED","INACTIVE","DRAFT","ACTIVE","RETIRED","INACTIVE"]},"collectionPointType":{"description":"Type of the collection point","type":"string","example":"WEB_FORM","enum":["WEB_FORM","MOBILE_APPLICATION","BULK_IMPORT","API","PREFERENCE_CENTER","COOKIE","TRUST_CENTER","NOTIFICATION_OPT_OUT","ADMIN_UPDATE","HOSTED_WEB_FORM","EMBEDDED_WEB_FORM","WEB_FORM","HOSTED_WEB_FORM","EMBEDDED_WEB_FORM","API"]},"consentType":{"description":"Type of consent mechanism used by the collection point","type":"string","example":"FORMSUBMIT","enum":["FORMSUBMIT","EXPLICIT","UNAMBIGUOUS","OPTINCHECKBOX","OPTOUTCHECKBOX","SINGLETRIGGER","CONDITIONALTRIGGER","COOKIEBANNER","UNCHECKOPTOUT","CHECKOPTOUT","FORMSUBMIT","IMPLICIT","EXPLICIT"]},"description":{"description":"Detailed description of the collection point's purpose","type":"string","example":"Collecting data for Marketing and Promotion Purposes"},"subjectIdentifier":{"description":"Identifier used to uniquely identify the data subject","type":"string","example":"email"},"identifierDataElement":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_CustomDataElementV2_DetailV2"},"createDate":{"description":"Timestamp when the collection point was created","type":"string","format":"date-time","example":"2018-03-22T20:55:40.237Z"},"firstReceiptOn":{"description":"Timestamp when the first consent receipt was generated for this collection point","type":"string","format":"date-time","example":"2018-05-12T12:23:25.243Z"},"receiptCount":{"description":"Total number of consent receipts generated from this collection point","type":"integer","format":"int64","example":563,"minimum":0},"hostedWebFormId":{"description":"Unique identifier of the hosted web form associated with this collection point","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"webFormUrl":{"description":"URL where the collection point is hosted","type":"string","format":"uri","example":"https://www-onetrust-com.surrey.idm.oclc.org/collection-point"},"privacyPolicyUrl":{"description":"URL that redirects to the Privacy Policy","type":"string","format":"uri","example":"https://www-onetrust-com.surrey.idm.oclc.org/privacy-notice"},"activationDate":{"description":"Timestamp when the collection point was activated","type":"string","format":"date-time","example":"2018-03-15T12:00:20.123Z"},"organizationId":{"description":"Unique identifier of the organization that owns this collection point","type":"string","format":"uuid","example":"92cf3a3a-09a9-4d04-b69d-ea5bb1db550a"},"doubleOptIn":{"description":"Indicates if double opt-in (email confirmation) is required for this collection point","type":"boolean","example":false},"redirectUrl":{"description":"URL to redirect to after double opt-in confirmation","type":"string","format":"uri","example":"https://www-onetrust-com.surrey.idm.oclc.org/thank-you"},"iabVendorId":{"description":"IAB Vendor ID for mobile collection points","type":"integer","format":"int32","example":13,"minimum":1},"noConsentTransactions":{"description":"Indicates if transactions without explicit consent should be recorded","type":"boolean","example":false},"lastSdkIntegrationDate":{"description":"Timestamp when the SDK integration was last updated","type":"string","format":"date-time","example":"2020-01-08T14:25:11.112Z"},"language":{"description":"Default language code for the collection point","type":"string","example":"en-us"},"hostedSDK":{"description":"Indicates if the settings are published to external storage for optimized performance","type":"boolean","example":false},"showWarning":{"type":"boolean"},"sendConsentEmail":{"description":"Indicates if a consent acknowledgement email should be sent","type":"boolean","example":false},"responsibleUserId":{"description":"Unique identifier of the user responsible for this collection point","type":"string","format":"uuid","example":"bc4836e2-c117-461b-a7a2-2b268c037a97"},"responsibleGroupId":{"description":"Unique identifier of the group responsible for this collection point","type":"string","format":"uuid","example":"5466af43-ff42-4a39-8722-5a98e7981fc4"},"lastActivityDate":{"description":"Timestamp of the most recent activity on this collection point","type":"string","format":"date-time","example":"2020-01-10T18:12:13.543Z"},"warningReasons":{"description":"Set of warning reasons associated with the collection point","type":"array","items":{"type":"string","description":"Set of warning reasons associated with the collection point","enum":["SDK_OUT_OF_DATE","NO_ACTIVITY"]}},"consentIntegration":{"description":"Indicates if consent events should be sent to third-party integrations","type":"boolean","example":false},"enableNewConsentIntegration":{"description":"Indicates if the new consent integration is enabled","type":"boolean","example":false},"isAuthenticationRequired":{"description":"Indicates if authentication is required to access this collection point","type":"boolean","example":false},"createdBy":{"description":"Identifier of the user who created the collection point","type":"string","example":"D452EC68-71C4-4935-9F17-5FD054365805"},"lastModifiedBy":{"description":"Identifier of the user who last modified the collection point","type":"string","example":"304F7D36-75A2-4967-81A5-5A7D604C6A19"},"reconfirmActivePurpose":{"description":"Indicates if reconsent is required for active purposes","type":"boolean","example":false},"publishedBy":{"description":"Identifier of the user who last published the collection point","type":"string","example":"304F7D36-75A2-4967-81A5-5A7D604C6A19"},"dataElements":{"description":"List of data elements associated with the collection point","type":"array","items":{"type":"string"},"example":["First Name","Last Name","Email"]},"jwtToken":{"description":"JWT token data for authentication and authorization","type":"object","additionalProperties":{"type":"object","description":"JWT token data for authentication and authorization"}},"noticesWithVersions":{"description":"List of notices with their version information","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_CollectionPointNoticeWithVersionDto_DetailV2"}},"canCreateNewVersion":{"description":"Indicates if a new version of the collection point can be created","type":"boolean","example":true},"newSdkIntegrationEnabled":{"description":"Indicates if the new SDK integration is enabled","type":"boolean","example":false},"disabled":{"description":"Indicates if the collection point is disabled","type":"boolean","example":false},"languages":{"description":"List of language codes for which translations are availablel","type":"array","items":{"type":"string"},"example":["en-us","fr"]},"preferenceCenter":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PreferenceCenterSummaryDto_DetailV2"},"attributes":{"description":"Additional attributes associated with the collection point","type":"object","additionalProperties":{"type":"array","description":"Additional attributes associated with the collection point","items":{"type":"string","description":"Additional attributes associated with the collection point"}}},"purposes":{"description":"The list of Purposes associated with the Collection Point. Each purpose contains detailed information including its status, consent model, and other relevant attributes.","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PurposeDetailDtoV2_DetailV2"},"readOnly":true}}},"ConsentPreferences-UniversalConsentPreferenceManag_CollectionPointNoticeWithVersionDto_DetailV2":{"properties":{"id":{"description":"The unique identifier of the collection point notice.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"name":{"description":"The name of the notice as it appears in the collection point.","type":"string","example":"Privacy Notice (v2.0)"},"url":{"description":"The URL where the full notice content can be accessed, if applicable.","type":"string","format":"uri","example":"https://example.com/privacy-notice"},"privacyNoticeGuid":{"description":"The unique identifier of the privacy notice this collection point notice is associated with.","type":"string","format":"uuid","example":"223e4567-e89b-12d3-a456-426614174001"},"type":{"description":"The type of the collection point notice, indicating its purpose or category.","type":"string","enum":["LINKED","EMBEDDED"]},"purposes":{"description":"Set of purposes associated with this notice, including their names and versions.","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_SimpleNameVersion_DetailV2"},"uniqueItems":true},"privacyNoticeVersion":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PrivacyNoticeVersionDtoV2_DetailV2"},"collectionPoint":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_SimpleNameVersion_DetailV2"},"noticeType":{"description":"The type of notice, which may provide additional categorization beyond the collection point notice type.","type":"string","enum":["PRIVACY_NOTICE","DIGITAL_POLICY"]}},"required":["id","name","privacyNoticeGuid","purposes","type"]},"ConsentPreferences-UniversalConsentPreferenceManag_CustomDataElementField_DetailV2":{"properties":{"dataElementType":{"description":"The type of the custom data element (e.g., TEXT, NUMBER, DATE, etc.)","type":"string","enum":["USER_INPUT","SELECTION","EMAIL","NUMBER","DATE_PICKER","COUNTRY","STATE","COUNTRY_CODE","PHONE_NUMBER","STATE_CODE"]},"displayAs":{"description":"Specifies how the data element should be displayed in the UI (e.g., as a text field, dropdown, radio buttons, etc.)","type":"string","enum":["DROPDOWN","NONE"]},"dataElementOptions":{"description":"List of available options for this data element. Only applicable for choice-based elements like dropdowns or radio buttons.","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_CustomDataElementOptionDtoV2_DetailV2"}}},"required":["dataElementType"]},"ConsentPreferences-UniversalConsentPreferenceManag_CustomDataElementOptionDtoV2_DetailV2":{"properties":{"id":{"type":"string","format":"uuid"},"label":{"type":"string"}}},"ConsentPreferences-UniversalConsentPreferenceManag_CustomDataElementOptionDto_DetailV2":{"properties":{"Id":{"description":"Unique identifier for the custom data element option","type":"string","format":"uuid","example":"1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed"},"Label":{"description":"Display text for the option","type":"string","example":"Option 1"}},"required":["Label"]},"ConsentPreferences-UniversalConsentPreferenceManag_CustomDataElementV2_DetailV2":{"properties":{"guid":{"description":"Unique identifier for the custom data element","type":"string","format":"uuid","example":"21e0de87-d6ef-4b39-a54b-6d877698e3f6"},"numberOfLanguages":{"description":"Number of language translations available for this data element","type":"integer","format":"int64","example":3,"readOnly":true},"createdDate":{"description":"Timestamp when the data element was created","type":"string","format":"date-time","example":"2023-01-15T10:30:00Z","readOnly":true},"lastModifiedDate":{"description":"Timestamp when the data element was last modified","type":"string","format":"date-time","example":"2023-01-20T14:45:30Z","readOnly":true},"canEdit":{"description":"Indicates if the data element can be modified","type":"boolean","example":true,"readOnly":true},"dataElementFields":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_CustomDataElementField_DetailV2"},"label":{"description":"The display name/label of the custom data element","type":"string","example":"Work Email"},"isIdentifier":{"description":"Indicates if this data element can be used as an identifier","type":"boolean","example":false,"default":false},"collectionPoints":{"description":"Number of collection points where this data element is being used","type":"integer","format":"int64","example":5,"readOnly":true},"languages":{"description":"List of language-specific translations for this data element","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_DataElementLanguageDto_DetailV2"}}},"required":["guid","label"]},"ConsentPreferences-UniversalConsentPreferenceManag_DataElementLanguageDto_DetailV2":{"properties":{"Name":{"description":"The Data Element name","type":"string","example":"Work Email"},"DataElementOptions":{"description":"List of options available for this data element in the specified language","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_CustomDataElementOptionDto_DetailV2"}},"Language":{"description":"The Data Element translation language code","type":"string","example":"en-us"}}},"ConsentPreferences-UniversalConsentPreferenceManag_PageCollectionPointDtoV2_DetailV2":{"type":"object","properties":{"content":{"description":"The list of items for the current page.","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_CollectionPointDtoV2_DetailV2"},"type":"array"},"empty":{"description":"The flag to check if the entity is empty or not.","type":"boolean","example":false},"first":{"description":"The flag to check if the entity is first entity or not.","type":"boolean","example":true},"last":{"description":"The flag to check if the entity is last entity or not.","type":"boolean","example":false},"number":{"description":"The number associated with the result.","type":"integer","format":"int32","example":0},"numberOfElements":{"description":"Total number of elements in the result.","type":"integer","format":"int32","example":20},"pageable":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PageableObject_DetailV2"},"sort":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_SortObject_DetailV2"},"totalPages":{"description":"Total number of pages in the result list.","type":"integer","format":"int32","example":5},"totalElements":{"description":"Total number of elements in the result.","type":"integer","format":"int64","example":50},"size":{"description":"Size of the result list.","type":"integer","format":"int32","example":20}}},"ConsentPreferences-UniversalConsentPreferenceManag_PageableObject_DetailV2":{"properties":{"offset":{"type":"integer","format":"int64"},"sort":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_SortObject_DetailV2"},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"paged":{"type":"boolean"},"unpaged":{"type":"boolean"}}},"ConsentPreferences-UniversalConsentPreferenceManag_PreferenceCenterSummaryDto_DetailV2":{"properties":{"Id":{"description":"Unique Identifier identifying the Preference Center","type":"string","format":"uuid","example":"09ccd1b9-84a0-4bcb-a167-f761391ebffa"},"Name":{"description":"The Preference Center name","type":"string","example":"Email Communication Preferences"},"OrganizationName":{"description":"The Organization's name","type":"string","example":"OneTrust"},"Template":{"description":"The Preference Center template type","type":"string","example":"ENHANCED","enum":["ORIGINAL","ENHANCED","MULTIPAGE"]}}},"ConsentPreferences-UniversalConsentPreferenceManag_PrivacyNoticeVersionDtoV2_DetailV2":{"properties":{"id":{"description":"Unique identifier of the privacy notice version","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"name":{"description":"Name of the privacy notice version","type":"string","example":"Privacy Policy v2.1"},"version":{"description":"Major version number of the privacy notice","type":"integer","format":"int64","example":2,"minimum":0},"minorVersion":{"description":"Minor version number of the privacy notice (used for patch versions)","type":"integer","format":"int64","example":1,"default":0,"minimum":0}}},"ConsentPreferences-UniversalConsentPreferenceManag_PurposeDetailDtoV2_DetailV2":{"properties":{"id":{"description":"Unique identifier of the purpose","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"label":{"description":"Name or label of the purpose version","type":"string","example":"Marketing Communications"},"description":{"description":"Detailed description of the purpose version","type":"string","example":"Collect customer emails for marketing purposes"},"status":{"description":"Current status of the purpose version","type":"string","example":"ACTIVE","enum":["DRAFT","ACTIVE","RETIRED"]},"version":{"description":"Version number of the purpose","type":"integer","format":"int64","example":2},"consentLifeSpan":{"description":"Lifespan of consents recorded against this purpose version in seconds","type":"integer","format":"int64","example":31536000},"implicitConsentLifeSpan":{"description":"Lifespan of implicit consents recorded against this purpose version in seconds","type":"integer","format":"int64","example":31536000},"implicitConsentConfirmDesc":{"description":"Description text for the implicit consent confirmation checkbox","type":"string","example":"I agree to the processing of my personal data for this purpose"},"purposeType":{"description":"Type of the purpose","type":"string","example":"STANDARD","enum":["STANDARD","COOKIE","IAB","MOBILE","NOTIFICATION_OPT_OUT"]},"parentPurposeId":{"description":"Unique identifier of the parent purpose, if this is a child purpose","type":"string","format":"uuid","example":"ba54eb25-90f0-4633-ab12-c7bf5afdd856"},"retireOnDate":{"description":"Date when the purpose will be retired","type":"string","format":"date-time","example":"2025-12-31T23:59:59Z"},"createdBy":{"description":"ID of the user who created the purpose","type":"string","example":"304F7D36-75A2-4967-81A5-5A7D604C6A19"},"createdDate":{"description":"Date and time when the purpose version was created","type":"string","format":"date-time","example":"2023-01-01T00:00:00Z"},"lastModifiedBy":{"description":"ID of the user who last modified the purpose","type":"string","example":"304F7D36-75A2-4967-81A5-5A7D604C6A19"},"lastModifiedDate":{"description":"Date and time when the purpose version was last modified","type":"string","format":"date-time","example":"2023-01-15T15:30:45Z"},"publishedBy":{"description":"ID of the user who published the purpose","type":"string","example":"304F7D36-75A2-4967-81A5-5A7D604C6A19"},"publishedDate":{"description":"Date and time when the purpose version was published","type":"string","format":"date-time","example":"2023-01-10T10:15:30Z"},"receiptInclusionAttributes":{"description":"Attributes that should be included in the receipt","type":"object","additionalProperties":{"type":"array","description":"Attributes that should be included in the receipt","items":{"type":"string","description":"Attributes that should be included in the receipt"}}}},"readOnly":true,"required":["id","label","purposeType","status","version"]},"ConsentPreferences-UniversalConsentPreferenceManag_SimpleNameVersion_DetailV2":{"properties":{"id":{"description":"The unique identifier of the entity","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"name":{"description":"The display name of the entity","type":"string","example":"Marketing Consent Form"},"version":{"description":"The version number of the entity","type":"integer","format":"int64","example":1},"type":{"description":"The type of the entity (optional, used for categorization)","type":"string","example":"CONSENT_FORM"}},"required":["id","name","version"]},"ConsentPreferences-UniversalConsentPreferenceManag_SortObject_DetailV2":{"properties":{"empty":{"type":"boolean"},"unsorted":{"type":"boolean"},"sorted":{"type":"boolean"}}},"ConsentPreferences-UniversalConsentPreferenceManag_PageMergeDSRequestDto":{"type":"object","properties":{"content":{"description":"The list of items for the current page.","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_MergeDSRequestDto"},"type":"array"},"empty":{"description":"The flag to check if the entity is empty or not.","type":"boolean","example":false},"first":{"description":"The flag to check if the entity is first entity or not.","type":"boolean","example":true},"last":{"description":"The flag to check if the entity is last entity or not.","type":"boolean","example":false},"number":{"description":"The number associated with the result.","type":"integer","format":"int32","example":0},"numberOfElements":{"description":"Total number of elements in the result.","type":"integer","format":"int32","example":20},"pageable":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PageableObject"},"sort":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_SortObject"},"totalPages":{"description":"Total number of pages in the result list.","type":"integer","format":"int32","example":5},"totalElements":{"description":"Total number of elements in the result.","type":"integer","format":"int64","example":50},"size":{"description":"Size of the result list.","type":"integer","format":"int32","example":20}}},"ConsentPreferences-UniversalConsentPreferenceManag_ConsentStringDto":{"properties":{"type":{"description":"Type of the consent string (e.g., IAB_TCF_V2, ONETRUST)","type":"string","example":"IAB_TCF_V2"},"content":{"description":"The actual consent string content (base64 encoded string)","example":"COzQOA8O1zG3YCABBDEA0CsAP_AAH_AAAAAI6td_H__bX9j-em_6bftr9Bf7a_9tfuA0mGcc1ZcnAkigTgQhRfmkfbO2JwY6D5Y6G1AAQhoQHtH6EGAAaEBAgIAAoACAIQAgQAgACBAAAAA","type":"string"}}},"ConsentPreferences-UniversalConsentPreferenceManag_DownStreamRuleAction":{"properties":{"actionType":{"type":"string","enum":["SEND_EMAIL","DATA_SUBJECT_UPDATE","DATA_SUBJECT_PROFILE_UPDATE","PUBLISH_INTEGRATION_EVENT"]},"ruleAction":{"type":"string"},"ruleActionParameter":{"type":"string"}}},"ConsentPreferences-UniversalConsentPreferenceManag_DsAttachments":{"properties":{"id":{"type":"string","format":"uuid"}}},"ConsentPreferences-UniversalConsentPreferenceManag_DsGeolocation":{"properties":{"country":{"description":"Country of the DataSubject","type":"string","example":"US"},"state":{"description":"State Code of the DataSubject","type":"string","example":"GA"},"stateName":{"description":"State Name of the DataSubject","type":"string","example":"Georgia"},"purposeIds":{"description":"List of Unique Identifiers of the Purpose for which Geolocation parameters are sent","type":"array","items":{"type":"string","format":"uuid","description":"List of Unique Identifiers of the Purpose for which Geolocation parameters are sent"},"example":"[f2229953-b4b5-4042-8cb9-b78038cc4c46, bc4836e2-c117-461b-a7a2-2b268c037a97]","uniqueItems":true}}},"ConsentPreferences-UniversalConsentPreferenceManag_DsPurposeScope":{"properties":{"key":{"type":"string"},"value":{"type":"string"}}},"ConsentPreferences-UniversalConsentPreferenceManag_PurposeInformationDtoV2":{"properties":{"id":{"description":"Unique identifier of the purpose","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"name":{"description":"Name of the purpose","type":"string","example":"Marketing Communications"},"description":{"description":"Detailed description of the purpose's data processing activities","type":"string","example":"Collect customer emails for marketing purposes"},"status":{"description":"Current status of the purpose","type":"string","example":"ACTIVE","enum":["DRAFT","ACTIVE","RETIRED"]},"version":{"description":"Version number of the purpose","type":"integer","format":"int64","example":2},"purposeType":{"description":"Classification type of the purpose","type":"string","example":"STANDARD","enum":["STANDARD","COOKIE","IAB","MOBILE","NOTIFICATION_OPT_OUT"]},"consentLifeSpan":{"description":"Duration in seconds that consents for this purpose remain valid","type":"integer","format":"int64","example":7889238},"transactionType":{"description":"Type of transaction associated with the purpose","type":"string","example":"CONFIRMED","enum":["PENDING","CONFIRMED","WITHDRAWN","EXPIRED","NOTGIVEN","OPT_OUT","NO_CHOICE","HARD_OPT_OUT","EXTEND","CHANGE_PREFERENCES","OPT_IN","NO_OPT_OUT","CANCEL","IMPLICIT"]},"topics":{"description":"List of topics associated with this purpose","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PurposeTopicDtoV2"}},"purposeAttachments":{"description":"List of file attachments or documents associated with the purpose","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_DsAttachments"}},"purposeScopes":{"description":"List of scopes or contexts where this purpose applies","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_DsPurposeScope"}},"customPreferences":{"description":"List of custom preferences associated with this purpose","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PurposeCustomPreferenceDtoV2"}},"purposeNote":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PurposeNoteDtoV2"},"attributes":{"description":"Key-value pairs of custom attributes associated with the purpose","type":"object","additionalProperties":{"type":"array","description":"Key-value pairs of custom attributes associated with the purpose","items":{"type":"string","description":"Key-value pairs of custom attributes associated with the purpose"}}}}},"ConsentPreferences-UniversalConsentPreferenceManag_PurposeNoteDtoV2":{"properties":{"noteId":{"description":"Unique identifier of the reason template","type":"string","format":"uuid"},"noteType":{"description":"The type of the note","type":"string","enum":["UNSUBSCRIBE_REASON"]},"noteLanguage":{"description":"The language of the note","type":"string"},"noteText":{"description":"The actual text of the note","type":"string"},"isValidNote":{"description":"Flag indicating if the note is a valid reason template","type":"boolean"}}},"ConsentPreferences-UniversalConsentPreferenceManag_ReceiptInformationDetailDto":{"type":"object","properties":{"id":{"description":"The unique identifier for the receipt","type":"string","format":"uuid","example":"09ccd1b9-84a0-4bcb-a167-f761391ebffa"},"otJwtVersion":{"description":"Version of the JWT token used for the receipt","type":"integer","format":"int64","example":1},"dataSubjectIdentifierHash":{"description":"Hashed value of the data subject's identifier for privacy protection","type":"string","example":"ee26b0dd4af7e749aa1a8ee3c10ae9923f618980772e473f8819a5d4940e0db27ac185f8a0e1d5f84f88bc887fd67b143732c304cc5fa9ad8e6f57f50028a8ff"},"dataSubjectIdentifier":{"description":"The actual identifier of the data subject (e.g., email, user ID)","type":"string","example":"user@example.com"},"collectionPointUUID":{"description":"Unique identifier of the collection point that generated this receipt","type":"string","format":"uuid","example":"25d9ccac-db88-4d34-849c-3d602a629961"},"collectionPointVersion":{"description":"Version number of the collection point","type":"integer","format":"int64","example":2},"collectionPointName":{"description":"Human-readable name of the collection point","type":"string","example":"Website Signup Form"},"consentCreationDate":{"description":"Timestamp when the consent was created","type":"string","format":"date-time","example":"2023-10-08T12:00:00Z"},"receiptJwt":{"description":"JWT token containing the receipt information","type":"string","example":"AABmODM2OGM0ZC1mMmUwLTQ2MGYtYjQyOC03ZTQyZjQ1MWI3MGVJovwdqc7MU+49lOy"},"customPayload":{"description":"Custom JSON payload included with the receipt","type":"string","example":"{\"payload1\":\"value1\",\"payload2\":\"value2\"}"},"purposes":{"description":"List of purposes associated with this receipt","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PurposeInformationDtoV2"}},"test":{"description":"Indicates if this receipt was created in test mode","type":"boolean","example":false},"origin":{"description":"Source origin of the consent request","type":"string","enum":["IMPORT","API","SDK","ONETRUST","PREFERENCE_CENTER","EMAIL_CLIENT_ONE_CLICK","HISTORIC_IMPORT"]},"doubleOptIn":{"description":"Indicates if double opt-in was required for this consent","type":"boolean","example":true},"language":{"description":"Language code for the consent interaction","type":"string","example":"en-US"},"collectionPointType":{"description":"Type of the collection point","type":"string","example":"WEB_FORM"},"isAnonymous":{"description":"Indicates if the consent was given anonymously","type":"boolean","example":false},"attributes":{"description":"Additional attributes associated with the receipt","type":"object","additionalProperties":{"type":"array","description":"Additional attributes associated with the receipt","items":{"type":"object","description":"Additional attributes associated with the receipt"}}},"interactionDate":{"description":"Timestamp of the user interaction that generated this receipt","type":"string","format":"date-time"},"dsDataElements":{"description":"Data subject related data elements","type":"object","additionalProperties":{"type":"object","description":"Data subject related data elements"}},"unsubscribeAll":{"description":"Indicates if the user opted to unsubscribe from all communications","type":"boolean","example":false},"attachments":{"description":"List of attachments associated with the receipt","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_DsAttachments"}},"additionalIdentifiers":{"description":"Additional identifiers for the data subject","type":"object","additionalProperties":{"type":"object","description":"Additional identifiers for the data subject"}},"geolocation":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_DsGeolocation"},"ruleEvaluationResults":{"description":"Results of any rules evaluated during consent processing","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_RuleEvaluationResult"}},"consentStringDto":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_ConsentStringDto"},"source":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_SourceDto"}},"required":["id","receiptJwt"]},"ConsentPreferences-UniversalConsentPreferenceManag_ReceiptInformationDetailSliceDto":{"type":"object","properties":{"content":{"items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_ReceiptInformationDetailDto"},"type":"array"},"number":{"description":"The page number of the results.","type":"integer","format":"int32","example":1},"size":{"description":"The number of results per page.","type":"integer","format":"int32","example":20},"pageable":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PageableObject"},"last":{"description":"Flag indicating whether this is the last page or not.","type":"boolean","example":false},"sort":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_SortObject"},"first":{"type":"boolean"},"numberOfElements":{"type":"integer","format":"int32"},"empty":{"type":"boolean"}}},"ConsentPreferences-UniversalConsentPreferenceManag_RuleActionResult":{"properties":{"ruleAction":{"type":"string"},"ruleActionParameter":{"type":"string"},"ruleActionStatus":{"type":"string","enum":["COMPLETED","PARTIALLY_COMPLETED","NOT_INITIATED","FAILED"]},"downStreamRuleActions":{"type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_DownStreamRuleAction"}}}},"ConsentPreferences-UniversalConsentPreferenceManag_RuleEvaluationResult":{"properties":{"ruleId":{"type":"string","format":"uuid"},"ruleGroupId":{"type":"string","format":"uuid"},"consentRuleType":{"type":"string","enum":["CONSENT_INGEST"]},"evaluationResult":{"type":"boolean"},"actionResults":{"type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_RuleActionResult"}},"resultData":{"type":"array","items":{"type":"object"}},"additionalParams":{"type":"object","additionalProperties":{"type":"object"}}}},"ConsentPreferences-UniversalConsentPreferenceManag_SourceDto":{"properties":{"type":{"description":"Type of the source (e.g., 'WEB', 'MOBILE_APP', 'API')","type":"string","example":"WEB"},"content":{"description":"Content or identifier from the source system","example":"https://example.com/consent","type":"string"},"purposeIds":{"description":"List of purpose IDs associated with this source","type":"array","items":{"type":"string","format":"uuid","description":"List of purpose IDs associated with this source"},"example":"[550e8400-e29b-41d4-a716-446655440000]"}}},"ConsentPreferences-UniversalConsentPreferenceManag_CustomPreferenceInformation":{"properties":{"Id":{"description":"Unique identifier of the custom preference","type":"string","format":"uuid","example":"64f8ebb3-b43d-4e4b-a84a-3d301b6d95f1"},"Name":{"description":"Display name of the custom preference","type":"string","example":"Fiscal preference"},"CustomPreferenceOptions":{"description":"List of options selected by the data subject for this custom preference","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_CustomPreferenceOptionsInformation"}}},"required":["Id","Name"]},"ConsentPreferences-UniversalConsentPreferenceManag_CustomPreferenceOptionsInformation":{"properties":{"Id":{"description":"Unique identifier of the custom preference option","type":"string","format":"uuid","example":"331f4c1c-2dc6-4a04-8603-7edab63e36d4"},"Name":{"description":"Display name of the custom preference option","type":"string","example":"Monthly"}},"required":["Id","Name"]},"ConsentPreferences-UniversalConsentPreferenceManag_DataSubjectForPurposeInformation":{"properties":{"DataSubjectId":{"description":"Unique identifier of the Data Subject (typically an email or ID)","type":"string","example":"example@otprivacy.com"},"Status":{"description":"Current transaction status of the Data Subject for this Purpose","type":"string","example":"ACTIVE","enum":["ACTIVE","WITHDRAWN","EXPIRED","NOT GIVEN","PENDING","OPT OUT"]},"FirstTransactionDate":{"description":"Timestamp of the first transaction for this Data Subject and Purpose","type":"string","format":"date-time","example":"2020-01-06T10:54:30.974Z"},"LastTransactionDate":{"description":"Timestamp of the most recent transaction for this Data Subject and Purpose","type":"string","format":"date-time","example":"2020-01-12T12:42:12.842Z"},"Topics":{"description":"List of topics associated with the Data Subject's consent","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_TopicInformation"}},"CustomPreferences":{"description":"List of custom preferences selected by the Data Subject","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_CustomPreferenceInformation"}}},"required":["DataSubjectId","Status"]},"ConsentPreferences-UniversalConsentPreferenceManag_PageDataSubjectForPurposeInformation":{"type":"object","properties":{"content":{"description":"The list of items for the current page.","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_DataSubjectForPurposeInformation"},"type":"array"},"empty":{"description":"The flag to check if the entity is empty or not.","type":"boolean","example":false},"first":{"description":"The flag to check if the entity is first entity or not.","type":"boolean","example":true},"last":{"description":"The flag to check if the entity is last entity or not.","type":"boolean","example":false},"number":{"description":"The number associated with the result.","type":"integer","format":"int32","example":0},"numberOfElements":{"description":"Total number of elements in the result.","type":"integer","format":"int32","example":20},"pageable":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PageableObject"},"sort":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_SortObject"},"totalPages":{"description":"Total number of pages in the result list.","type":"integer","format":"int32","example":5},"totalElements":{"description":"Total number of elements in the result.","type":"integer","format":"int64","example":50},"size":{"description":"Size of the result list.","type":"integer","format":"int32","example":20}}},"ConsentPreferences-UniversalConsentPreferenceManag_TopicInformation":{"properties":{"Id":{"type":"string","format":"uuid"},"Name":{"type":"string"}}},"ConsentPreferences-UniversalConsentPreferenceManag_PreferenceCenterDto":{"type":"object","properties":{"messages":{"description":"List of messages associated with the Preference Center","type":"array","items":{"type":"string","description":"List of messages associated with the Preference Center"}},"PreferenceCentreId":{"description":"Unique identifier identifying a Preference Center","type":"string","format":"uuid","example":"d3c9d247-8f0b-4277-bd22-01837d6db3e6"},"Purposes":{"description":"List of Purposes associated to the Preference Center","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PurposesWithLanguagesDto"}},"Status":{"description":"Status code for the preference center [200 (active), 400 (error retrieving this preference center)]","type":"integer","format":"int32","example":200},"PreferenceCenterSettings":{"description":"Preference Center settings","type":"object"},"PortalSettings":{"description":"Preference Center Portal settings","type":"object"},"Language":{"description":"The Preference Center content language code","type":"string","example":"en-us"},"Languages":{"description":"List containing the Preference Center translations' language codes","type":"array","items":{"type":"string"},"example":["en-us","fr"]},"Translations":{"description":"List containing the Preference Center translations","type":"object","example":{"languageCode":{"property":"value"}},"additionalProperties":{"type":"object","additionalProperties":{"type":"string","description":"List containing the Preference Center translations","example":"{\"languageCode\":{\"property\":\"value\"}}"},"description":"List containing the Preference Center translations","example":{"languageCode":{"property":"value"}}}},"DisplayNotificationPurpose":{"description":"Setting to display or hide email notification option when Preferences change","type":"boolean","example":true,"default":true},"Template":{"description":"The Preference Center template type","type":"string","example":"ENHANCED","enum":["ORIGINAL","ENHANCED","MULTIPAGE"]},"ProfileSettings":{"description":"Preference Center Profile page settings","type":"object"},"EnableMultipleIdentities":{"type":"boolean"},"HierarchicalAccessControl":{"type":"boolean"}}},"ConsentPreferences-UniversalConsentPreferenceManag_PreferenceCustomPreferenceLanguageDto":{"properties":{"Name":{"description":"name for a Custom Preference","type":"string","example":"Monthly"},"Description":{"description":"The description of the Custom Preference","type":"string","example":"Options for different frequencies to receive emails"},"Language":{"description":"The Custom Preference content language code","type":"string","example":"en-us"},"Default":{"description":"The Option label","type":"boolean","example":true},"Options":{"description":"Options associated with a Custom Preference","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PreferenceCustomPreferenceOptionDto"}}},"required":["Description","Name"]},"ConsentPreferences-UniversalConsentPreferenceManag_PreferenceCustomPreferenceOptionDto":{"properties":{"Id":{"description":"Unique Identifier identifying an Option","type":"string","format":"uuid","example":"ca0fc41b-b28a-4335-804c-44d1f0f782ed"},"Label":{"description":"The Option label","type":"string","example":"Weekly"},"Order":{"description":"The order of the Option, Starts from 0","type":"integer","format":"int32","example":1},"IsDefault":{"description":"Whether the Option is default option or not","type":"boolean","example":true}}},"ConsentPreferences-UniversalConsentPreferenceManag_PreferencePurposeCustomPreferenceDto":{"properties":{"Id":{"description":"Unique identifier of the Purpose and Custom Preference relation","type":"string","format":"uuid","example":"c4a57a38-3774-45ad-9fa4-dbc545542232"},"Name":{"description":"The Custom Preference name","type":"string","example":"Email Frequency"},"Description":{"description":"The description of the Custom Preference","type":"string","example":"Options for different frequencies to receive emails"},"SelectionType":{"description":"Selection Type of the Custom Preference Options","type":"string","enum":["SINGLE_CHOICE","MULTI_CHOICE"]},"DisplayAs":{"description":"Display Type of the Custom Preference Options","type":"string","enum":["BUTTONS","CHECKBOXES"]},"Required":{"description":"Whether selection for this Custom Preference is required","type":"boolean","example":false},"Options":{"description":"A list containing the Custom Preference's Options","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PreferenceCustomPreferenceOptionDto"}},"Languages":{"description":"A list containing the Custom Preference's Languages","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PreferenceCustomPreferenceLanguageDto"}}}},"ConsentPreferences-UniversalConsentPreferenceManag_PreferencePurposeTopicDto":{"properties":{"Id":{"description":"The unique identifier of the Purpose and Topic relation","type":"string","format":"uuid","example":"497c4383-2c61-4906-aed0-660e3fd03ef0"},"Name":{"description":"The Topic name","type":"string","example":"Car Marketing"},"IntegrationKey":{"description":"The Topic integration key (combination of Purpose and Topic names)","type":"string","example":"Marketing-Communications_Car-Marketing"},"Languages":{"description":"Translations for a Topic","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_TopicLanguageDto"}}}},"ConsentPreferences-UniversalConsentPreferenceManag_PurposesWithLanguagesDto":{"properties":{"Id":{"description":"Unique identifier of the Purpose","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"Version":{"description":"Version number of the Purpose","type":"integer","format":"int64","example":2},"Label":{"description":"Display name of the Purpose","type":"string","example":"Marketing Communications"},"Description":{"description":"Detailed description explaining the Purpose","type":"string","example":"Collect customer emails for marketing purposes"},"Status":{"description":"Current status of the Purpose (e.g., ACTIVE, INACTIVE)","type":"string","example":"ACTIVE"},"PurposeType":{"description":"Classification type of the Purpose","type":"string","example":"STANDARD","enum":["STANDARD","COOKIE","IAB","MOBILE","NOTIFICATION_OPT_OUT"]},"ExternalReference":{"type":"string"},"Languages":{"description":"List of language-specific data for the Purpose","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PurposeLanguageDto"}},"Topics":{"description":"List of Topics associated with this Purpose","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PreferencePurposeTopicDto"}},"CustomPreferences":{"description":"List of custom preference settings for this Purpose","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PreferencePurposeCustomPreferenceDto"}},"LifeSpan":{"description":"Lifespan of consents recorded against this Purpose in seconds","type":"integer","format":"int64","example":7889238},"ImplicitConsentLifeSpan":{"description":"Lifespan of implicit consents for this Purpose in seconds","type":"integer","format":"int64","example":7889238},"ImplicitConsentConfirmDesc":{"description":"Description text for the implicit consent confirmation checkbox","type":"string","example":"I can confirm"},"DefaultConsentStatus":{"description":"Default consent status for this Purpose","type":"string","example":"OPT_OUT","default":"OPT_OUT","enum":["ACTIVE","OPT_OUT"]}}},"ConsentPreferences-UniversalConsentPreferenceManag_TopicLanguageDto":{"properties":{"Name":{"description":"The Topic name","type":"string","example":"Car Marketing"},"Language":{"description":"The Topic content language code","type":"string","example":"en-us"},"Default":{"description":"Whether this language is the default one for the Topic","type":"boolean","example":true}}},"ConsentPreferences-UniversalConsentPreferenceManag_PreferenceCenterPurposesByIdentifier":{"type":"object","properties":{"DataSubjectId":{"description":"The Data Subject identifier","type":"string","example":"example@otprivacy.com"},"Language":{"description":"The Data Subject's preferred language code","type":"string","example":"en-us"},"Purposes":{"description":"A list of Purposes associated to the Data Subject","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PurposesByIdentifierDto"}},"Status":{"description":"Status code for the Preference Center [200 (active), 400 (no transactions for this Data Subject)]","type":"integer","format":"int32","example":200},"DsDataElements":{"description":"A list containing the Data Elements and their values for the specified Data Subject","type":"object","example":[{"First Name":"John","Last Name":"Doe"}],"additionalProperties":{"type":"object","description":"A list containing the Data Elements and their values for the specified Data Subject","example":[{"First Name":"John","Last Name":"Doe"}]}},"messages":{"type":"array","items":{"type":"string"}},"unsubscribeAll":{"description":"Indicates whether a data subject has opted to unsubscribe from all Purposes within a Preference Center ","type":"boolean","example":true}}},"ConsentPreferences-UniversalConsentPreferenceManag_PurposesByIdentifierDto":{"properties":{"Id":{"description":"Unique Identifier of the Purpose","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"Label":{"description":"Name of the Purpose","type":"string","example":"Marketing Communications"},"Description":{"description":"Description of the Purpose","type":"string","example":"Collect customer emails for marketing purposes"},"Status":{"description":"Status of the Purpose","type":"string","example":"ACTIVE"},"TransactionStatus":{"description":"Status for a Data Subject consent on a Purpose","type":"string","example":"ACTIVE"},"ExternalReference":{"type":"string"},"Topics":{"description":"List of consented Topics associated to a Purpose","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PreferencePurposeTopicDto"}},"CustomPreferences":{"description":"List of consented Custom Preferences associated to a Purpose","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PreferencePurposeCustomPreferenceDto"}}}},"ConsentPreferences-UniversalConsentPreferenceManag_LinkTokenDto":{"properties":{"DataSubjectId":{"description":"The unique identifier of the Data Subject (e.g., email address)","type":"string","example":"example@otprivacy.com"},"LinkToken":{"description":"The secure token used to authenticate the Data Subject in the Preference Center","type":"string","example":"jNJW2e8vm8eWb6DlWyGbZ/7PsfC+AHFN8JqvZHPGzJQ="},"UrlEncodedLinkToken":{"description":"URL-encoded version of the link token for use in URLs","type":"string","example":"jNJW2e8vm8eWb6DlWyGbZ%2F7PsfC%2BAHFN8JqvZHPGzJQ%3D"},"ExpiryDate":{"description":"The date and time when the link token will expire","type":"string","format":"date-time","example":"2023-12-31T23:59:59.999Z"},"CreatedDate":{"description":"The date and time when the link token was created","type":"string","format":"date-time","example":"2023-01-01T00:00:00Z"}},"required":["DataSubjectId","LinkToken"]},"ConsentPreferences-UniversalConsentPreferenceManag_PageLinkTokenDto":{"type":"object","properties":{"content":{"description":"The list of items for the current page.","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_LinkTokenDto"},"type":"array"},"empty":{"description":"The flag to check if the entity is empty or not.","type":"boolean","example":false},"first":{"description":"The flag to check if the entity is first entity or not.","type":"boolean","example":true},"last":{"description":"The flag to check if the entity is last entity or not.","type":"boolean","example":false},"number":{"description":"The number associated with the result.","type":"integer","format":"int32","example":0},"numberOfElements":{"description":"Total number of elements in the result.","type":"integer","format":"int32","example":20},"pageable":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PageableObject"},"sort":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_SortObject"},"totalPages":{"description":"Total number of pages in the result list.","type":"integer","format":"int32","example":5},"totalElements":{"description":"Total number of elements in the result.","type":"integer","format":"int64","example":50},"size":{"description":"Size of the result list.","type":"integer","format":"int32","example":20}}},"ConsentPreferences-UniversalConsentPreferenceManag_DataSubjectByPurposeInformation":{"type":"object","properties":{"DataSubjectId":{"description":"The unique identifier of the Data Subject","type":"string","example":"example@otprivacy.com"},"Purposes":{"description":"List of purpose information associated with the Data Subject","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PurposeInformation"}}},"deprecated":true},"ConsentPreferences-UniversalConsentPreferenceManag_PreferenceDetail":{"properties":{"TopicId":{"type":"string","format":"uuid"},"TransactionType":{"type":"string"}}},"ConsentPreferences-UniversalConsentPreferenceManag_PurposeInformation":{"properties":{"Id":{"description":"Unique identifier for the Purpose","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"Label":{"description":"Name of the Purpose version","type":"string","example":"Marketing Communications"},"Topics":{"description":"List of topics associated with the Purpose","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_TopicInformation"}},"Transactions":{"description":"List of consent transactions related to the Purpose","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_TransactionInformation"}}},"deprecated":true},"ConsentPreferences-UniversalConsentPreferenceManag_TransactionInformation":{"properties":{"IssueDate":{"type":"string","format":"date-time"},"CollectionPointId":{"type":"string","format":"uuid"},"ReceiptId":{"type":"string","format":"uuid"},"TransactionId":{"type":"string","format":"uuid"},"Status":{"type":"string","enum":["EXPIRED","WITHDRAWN","NO_CONSENT","PENDING","ACTIVE","OPT_OUT","ALWAYS_ACTIVE","HARD_OPT_OUT","EXTEND","CHANGE_PREFERENCES","NOT_OPT_OUT","OPT_IN","IMPLICIT"]},"WithdrawalDate":{"type":"string","format":"date-time"},"ExpiryDate":{"type":"string","format":"date-time"},"Preferences":{"type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PreferenceDetail"}}}},"ConsentPreferences-UniversalConsentPreferenceManag_CollectionPointNoticeWithVersionDtoV1":{"properties":{"Id":{"description":"The unique identifier of the collection point notice","type":"string","format":"uuid","example":"05e30742-7e6c-4916-a5a1-7742a14ee984"},"Name":{"description":"The name of the collection point notice","type":"string","example":"Marketing Notice"},"Url":{"description":"The URL to a linked privacy notice","type":"string","format":"uri","example":"https://www-onetrust-com.surrey.idm.oclc.org/privacy-notice"},"Guid":{"description":"The unique identifier of the embedded privacy notice","type":"string","format":"uuid","example":"1439b150-ef4c-444c-a20e-44622c8ccaf3"},"Type":{"description":"The type of the collection point notice","type":"string","example":"EMBEDDED","enum":["LINKED","EMBEDDED"]},"Purposes":{"description":"Set of purposes linked to the collection point notice","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PurposeSimpleDetailsDtoV1"},"uniqueItems":true},"PrivacyNoticeVersion":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_SimpleNameVersionDtoV1"},"CollectionPoint":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_SimpleNameVersionDtoV1"}}},"ConsentPreferences-UniversalConsentPreferenceManag_ConsentAttachmentResponseDto":{"properties":{"fileName":{"description":"The name of the attached file","type":"string","example":"consent_agreement.pdf"},"attachmentId":{"description":"Unique identifier for the consent attachment","type":"string","format":"uuid","example":"a9adf402-adcd-45be-b981-a56a5c0739ec"}}},"ConsentPreferences-UniversalConsentPreferenceManag_DataSubjectElementDto":{"properties":{"Name":{"description":"The name of the data element","type":"string","example":"Work Email"},"Value":{"description":"The value of the data element. Can be a single value or an array of values.","type":"object","example":"example@otprivacy.com"},"DoNotCall":{"description":"Indicates if the phone number is listed in the FCC's Do Not Call registry","type":"boolean","example":false},"Linked":{"description":"Indicates if this data element is linked as an identifier for the Data Subject","type":"boolean","example":true}},"required":["Name"]},"ConsentPreferences-UniversalConsentPreferenceManag_DataSubjectGeolocationDto":{"properties":{"DataSubjectId":{"description":"Unique identifier of the Data Subject associated with this geolocation data","type":"string","format":"uuid","example":"633ba071-61b0-485f-81a0-a2245777b432"},"ReceiptGuid":{"description":"Unique identifier of the receipt associated with this geolocation data","type":"string","format":"uuid","example":"633ba071-61b0-485f-81a0-a2245777b432"},"Country":{"description":"Two-letter country code where the Data Subject is located","type":"string","example":"US","maxLength":2},"State":{"description":"State or region code where the Data Subject is located","type":"string","example":"GA","maxLength":3},"StateName":{"description":"Full name of the state or region where the Data Subject is located","type":"string","example":"Georgia"},"CreatedDate":{"description":"The date and time when the geolocation data was recorded","type":"string","format":"date-time","example":"2020-01-12T16:11:25.479Z"}}},"ConsentPreferences-UniversalConsentPreferenceManag_DataSubjectProfileCustomPreferenceDto":{"properties":{"Id":{"description":"Unique identifier for the custom preference","type":"string","format":"uuid","example":"c4a57a38-3774-45ad-9fa4-dbc545542232"},"Name":{"description":"The display name of the custom preference","type":"string","example":"Email Frequency"},"Options":{"description":"List of available options for this custom preference","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_DataSubjectProfileCustomPreferenceOptionDto"}}},"required":["Id","Name"]},"ConsentPreferences-UniversalConsentPreferenceManag_DataSubjectProfileCustomPreferenceOptionDto":{"properties":{"Id":{"description":"Unique identifier for the custom preference option","type":"string","format":"uuid","example":"ca0fc41b-b28a-4335-804c-44d1f0f782ed"},"Name":{"description":"The display name of the option","type":"string","example":"Weekly"},"IsConsented":{"description":"Indicates whether the data subject has given consent for this specific option","type":"boolean","example":true}},"required":["Id","IsConsented","Name"]},"ConsentPreferences-UniversalConsentPreferenceManag_DataSubjectProfileDto":{"properties":{"Id":{"description":"Unique identifier for the Data Subject","type":"string","format":"uuid","example":"1b1f53d3-dc40-4288-abf1-74a4a4c33510"},"Language":{"description":"The preferred language code for the Data Subject","type":"string","example":"en-us"},"Identifier":{"description":"The Data Subject's primary identifier (e.g., email, phone number)","type":"string","example":"example@otprivacy.com"},"LinkToken":{"description":"Token used for magic link authentication of the Data Subject","type":"string","example":"jNJW2e8vm8eWb6DlWyGbZ/7PsfC+AHFN8JqvZHPGzJQ="},"LastUpdatedDate":{"description":"The timestamp when the Data Subject's profile was last updated","type":"string","format":"date-time","example":"2020-01-12T16:11:25.479Z"},"CreatedDate":{"description":"The timestamp when the Data Subject's profile was created","type":"string","format":"date-time","example":"2020-01-12T16:11:25.479Z"},"DataElements":{"description":"List of data elements associated with the Data Subject","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_DataSubjectElementDto"}},"Purposes":{"description":"List of purposes associated with the Data Subject's profile","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_DataSubjectProfilePurposeDto"}},"Notices":{"description":"List of privacy notices associated with the Data Subject","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_CollectionPointNoticeWithVersionDtoV1"}},"TestDataSubject":{"description":"Indicates whether this is a test Data Subject","type":"boolean","example":false},"attachments":{"description":"List of attachments associated with the Data Subject's consent","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_ConsentAttachmentResponseDto"}},"doNotCall":{"type":"boolean"},"LatestGeolocation":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_DataSubjectGeolocationDto"}}},"ConsentPreferences-UniversalConsentPreferenceManag_DataSubjectProfilePurposeDto":{"properties":{"Id":{"description":"Unique identifier for the Purpose","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"LastReceiptId":{"description":"Unique identifier for the most recent receipt associated with this Purpose","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"Name":{"description":"The name of the Purpose","type":"string","example":"Marketing Communications"},"Version":{"description":"Version number of the Purpose","type":"integer","format":"int64","example":2},"Status":{"description":"Current status of the Purpose (e.g., ACTIVE, WITHDRAWN, EXPIRED)","type":"string","example":"ACTIVE"},"FirstTransactionDate":{"description":"The date and time when the first transaction was recorded for this Purpose","type":"string","format":"date-time","example":"2020-01-05T11:34:30.974Z"},"LastTransactionDate":{"description":"The date and time when the most recent transaction was recorded for this Purpose","type":"string","format":"date-time","example":"2020-01-12T16:11:25.479Z"},"WithdrawalDate":{"description":"The date and time when the Data Subject withdrew consent for this Purpose","type":"string","format":"date-time","example":"2020-01-12T16:11:25.479Z"},"ConsentDate":{"description":"The date and time when the Data Subject initially consented to this Purpose","type":"string","format":"date-time","example":"2020-01-07T13:18:23.123Z"},"ExpiryDate":{"description":"The date and time when the Data Subject's consent for this Purpose will expire","type":"string","format":"date-time","example":"2020-01-07T13:18:23.123Z"},"TotalTransactionCount":{"description":"The total number of transactions recorded for this Purpose","type":"integer","format":"int64","example":3},"Topics":{"description":"List of topics associated with this Purpose","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_DataSubjectProfileTopic"}},"CustomPreferences":{"description":"List of custom preferences associated with this Purpose","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_DataSubjectProfileCustomPreferenceDto"}},"LastTransactionCollectionPointId":{"description":"Unique identifier of the collection point used in the last transaction","type":"string","format":"uuid"},"LastTransactionCollectionPointVersion":{"description":"Version of the collection point used in the last transaction","type":"integer","format":"int64"},"PurposeNote":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PurposeNoteDto"},"GroupEffectiveStatus":{"description":"List of effective statuses for all purposes in the same consent group","type":"array","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PurposesGroupEffectiveStatusDto"}},"LastUpdatedDate":{"description":"Date and time of the most recent update to this Purpose, including changes to version, status, or preferences","type":"string","format":"date-time","example":"2020-01-05T11:34:30.974Z"},"LastInteractionDate":{"description":"Date and time of the most recent interaction with this Purpose through the Receipt API","type":"string","format":"date-time","example":"2020-01-05T11:34:30.974Z"},"attributes":{"description":"Additional attributes associated with the Purpose as key-value pairs","type":"object","additionalProperties":{"type":"array","description":"Additional attributes associated with the Purpose as key-value pairs","items":{"type":"string","description":"Additional attributes associated with the Purpose as key-value pairs"}}},"Geolocation":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_DataSubjectGeolocationDto"}}},"ConsentPreferences-UniversalConsentPreferenceManag_DataSubjectProfileSliceDto":{"type":"object","properties":{"content":{"items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_DataSubjectProfileDto"},"type":"array"},"number":{"description":"The page number of the results.","type":"integer","format":"int32","example":1},"size":{"description":"The number of results per page.","type":"integer","format":"int32","example":20},"pageable":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PageableObject"},"last":{"description":"Flag indicating whether this is the last page or not.","type":"boolean","example":false},"sort":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_SortObject"},"first":{"type":"boolean"},"numberOfElements":{"type":"integer","format":"int32"},"empty":{"type":"boolean"}}},"ConsentPreferences-UniversalConsentPreferenceManag_DataSubjectProfileTopic":{"properties":{"Id":{"description":"Unique identifier for the topic","type":"string","format":"uuid","example":"497c4383-2c61-4906-aed0-660e3fd03ef0"},"Name":{"description":"The display name of the topic","type":"string","example":"Car Marketing"},"IsConsented":{"description":"Indicates whether the data subject has given consent for this topic","type":"boolean","example":true}},"required":["Id","IsConsented","Name"]},"ConsentPreferences-UniversalConsentPreferenceManag_PurposeNoteDto":{"properties":{"NoteId":{"description":"Unique identifier of the reason template","type":"string","format":"uuid"},"NoteType":{"description":"The type of the note","type":"string","enum":["UNSUBSCRIBE_REASON"]},"NoteLanguage":{"description":"The language of the note","type":"string"},"NoteText":{"description":"The actual text of the note","type":"string"},"IsValidNote":{"description":"Flag indicating if the note is a valid reason template","type":"boolean"}}},"ConsentPreferences-UniversalConsentPreferenceManag_PurposeSimpleDetailsDtoV1":{"properties":{"Id":{"type":"string","format":"uuid"},"Name":{"type":"string"}}},"ConsentPreferences-UniversalConsentPreferenceManag_PurposesGroupEffectiveStatusDto":{"properties":{"GroupId":{"type":"string","format":"uuid"},"EffectiveStatus":{"type":"string"}}},"ConsentPreferences-UniversalConsentPreferenceManag_SimpleNameVersionDtoV1":{"properties":{"Id":{"type":"string","format":"uuid"},"Name":{"type":"string"},"Version":{"type":"integer","format":"int64"},"MinorVersion":{"type":"integer","format":"int64"}}},"ConsentPreferences-UniversalConsentPreferenceManag_PageCollectionPointDetailDto":{"type":"object","properties":{"content":{"description":"The list of items for the current page.","items":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_CollectionPointDetailDto"},"type":"array"},"empty":{"description":"The flag to check if the entity is empty or not.","type":"boolean","example":false},"first":{"description":"The flag to check if the entity is first entity or not.","type":"boolean","example":true},"last":{"description":"The flag to check if the entity is last entity or not.","type":"boolean","example":false},"number":{"description":"The number associated with the result.","type":"integer","format":"int32","example":0},"numberOfElements":{"description":"Total number of elements in the result.","type":"integer","format":"int32","example":20},"pageable":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PageableObject"},"sort":{"$ref":"#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_SortObject"},"totalPages":{"description":"Total number of pages in the result list.","type":"integer","format":"int32","example":5},"totalElements":{"description":"Total number of elements in the result.","type":"integer","format":"int64","example":50},"size":{"description":"Size of the result list.","type":"integer","format":"int32","example":20}}},"ConsentPreferences-UniversalConsentPreferenceManag_DeletePurposeFromDataSubject":{"properties":{"purposes":{"description":"The unique identifiers of the purposes.","type":"array","items":{"type":"string","format":"uuid","description":"Purpose ID","example":"550e8400-e29b-41d4-a716-446655440000"}},"dataSubjects":{"description":"The list of GUIDS for the data subject identifiers.","type":"array","items":{"type":"string","format":"uuid","description":"Data Subject GUID","example":"a9adf402-adcd-45be-b981-a56a5c0739ec"}},"retainTransactions":{"description":"This flag indicates whether transactions will be retained while deleting purposes from data subjects. When set to `false`, transactions are removed from the database and no longer appear in the OneTrust Platform UI. However, these transactions are not permanently deleted and can still be retrieved using the [Get List of Receipts API](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/getreceiptlistdetailsusingpost).","type":"boolean","example":false},"identifiers":{"description":"The list of data subject identifiers for the data subjects.","type":"array","items":{"type":"string","description":"Data Subject identifier (e.g., email, phone number)","example":"user@example.com"}}}},"ConsentAPI_LinkedIdentityGroupRequestDto":{"type":"object","properties":{"groupName":{"description":"A user-defined name for the group of linked identities.","type":"string","example":"LIG_1"},"memberIdentifiers":{"description":"A list of all member identifiers that belong to the group.","type":"array","items":{"type":"string"},"example":["user_12345@ot.com","user_67890@ot.com","user_54321@ot.com"]},"primaryIdentifiers":{"description":"A List of all identifiers that are primary identifiers. The members in this list need not be present in member identifiers list as they are mutually exclusive.","type":"array","items":{"type":"string"},"example":["user_primary@ot.com"]}},"required":["groupName","memberIdentifiers","primaryIdentifiers"]},"ConsentAPI_LinkedIdentityGroupDataSubjectResponseDto":{"type":"object","properties":{"id":{"description":"Unique identifier (UUID) of the data subject","type":"string","format":"uuid","example":"a3f8d56a-b123-4b2a-9eab-12cfea1bc456"},"identifier":{"description":"The original identifier value for the data subject","type":"string","example":"user@example.com"},"identifierType":{"description":"Type of identifier (e.g., EMAIL, PHONE)","type":"string","example":"EMAIL"},"addedDate":{"description":"Date and time when the data subject was added to the group","type":"string","format":"date-time","example":"2024-11-12T10:15:30"}}},"ConsentAPI_LinkedIdentityGroupResponseDto":{"type":"object","properties":{"id":{"description":"Unique identifier of the linked identity group","type":"string","example":"123e4567-e89b-12d3-a456-426614174000"},"createdDate":{"description":"Date and time when the group was created","type":"string","format":"date-time","example":"2024-11-12T10:15:30"},"groupName":{"description":"Name of the group","type":"string","example":"UserAccountGroup"},"primaryDataSubjects":{"description":"List of primary data subjects in the group","type":"array","items":{"$ref":"#/components/schemas/ConsentAPI_LinkedIdentityGroupDataSubjectResponseDto"}},"memberDataSubjects":{"description":"List of member data subjects in the group","type":"array","items":{"$ref":"#/components/schemas/ConsentAPI_LinkedIdentityGroupDataSubjectResponseDto"}}}},"ConsentAPI_ConsentGroupPurposeRulesRequest":{"type":"object","properties":{"purposeRules":{"description":"A list of Purpose Rules to be added to a Consent Group","type":"array","items":{"$ref":"#/components/schemas/ConsentAPI_PurposeRuleRequest"},"maxItems":2147483647,"minItems":1}}},"ConsentAPI_PurposeRuleRequest":{"type":"object","properties":{"purposeId":{"description":"Identifier identifying a Purpose","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"enforcedStatus":{"description":"The Transaction Status enforced by the Consent Group for this Purpose","type":"string","example":"ACTIVE","minLength":1}},"required":["purposeId"]},"ConsentAPI_ConsentGroupDto":{"type":"object","properties":{"name":{"description":"The Consent Group name","type":"string","example":"OneTrust Atlanta","minLength":1},"description":{"description":"A description of the Consent Group","type":"string","example":"Consent for the company OneTrust, specifically for the Atlanta Office. Contains subsidiary data subjects representing OneTrust employees that work at this location."},"externalName":{"description":"The Consent Group's external name. If not provided, this will be generated based on the name","type":"string","example":"onetrust_atlanta"},"consentGroupId":{"description":"Unique identifier identifying a Consent Group","type":"string","format":"uuid","example":"2a644966-fe93-4561-b71a-f0dda4396459"},"membershipType":{"description":"Indicates whether the consent group has other consent groups as its children, or if it has data subjects associated to it","type":"string","example":"CHILD_GROUPS","enum":["EMPTY","CHILD_GROUPS","DATA_SUBJECTS"]},"purposeRules":{"description":"The Consent Group's Purpose Rules","type":"array","items":{"$ref":"#/components/schemas/ConsentAPI_PurposeRuleDto"}},"dataSubjects":{"description":"The Consent Group's Data Subjects","type":"array","items":{"$ref":"#/components/schemas/ConsentAPI_DataSubjectInformationDto"}},"consentGroups":{"description":"Consent Groups that are children of the current Consent Group","type":"array","items":{"$ref":"#/components/schemas/ConsentAPI_ConsentGroupSummaryDto"}}}},"ConsentAPI_ConsentGroupSummaryDto":{"type":"object","properties":{"name":{"description":"The Consent Group name","type":"string","example":"OneTrust Atlanta","minLength":1},"description":{"description":"A description of the Consent Group","type":"string","example":"Consent for the company OneTrust, specifically for the Atlanta Office. Contains subsidiary data subjects representing OneTrust employees that work at this location."},"externalName":{"description":"The Consent Group's external name. If not provided, this will be generated based on the name","type":"string","example":"onetrust_atlanta"},"consentGroupId":{"description":"Unique identifier identifying a Consent Group","type":"string","format":"uuid","example":"2a644966-fe93-4561-b71a-f0dda4396459"},"membershipType":{"description":"Indicates whether the consent group has other consent groups as its children, or if it has data subjects associated to it","type":"string","example":"CHILD_GROUPS","enum":["EMPTY","CHILD_GROUPS","DATA_SUBJECTS"]}}},"ConsentAPI_DataSubjectInformationDto":{"type":"object","properties":{"id":{"description":"Unique Identifier identifying a Data Subject","type":"string","format":"uuid","example":"633ba071-61b0-485f-81a0-a2245777b432"},"identifier":{"description":"The Data Subject identifier value","type":"string","example":"example@otprivacy.com"},"purposes":{"description":"The Data Subject's Purpose list","type":"array","items":{"$ref":"#/components/schemas/ConsentAPI_DataSubjectPurposeInformationDto"}}}},"ConsentAPI_DataSubjectPurposeInformationDto":{"type":"object","properties":{"id":{"description":"Identifier identifying a Purpose","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"version":{"description":"The Purpose's version","type":"integer","format":"int64","example":2},"status":{"description":"The Data Subject's actual consent status for this Purpose","type":"string","example":"ACTIVE"},"effectiveStatus":{"description":"The Data Subject's effective status for this Purpose, in the context of the specified Consent Group","type":"string","example":"OPT_OUT"}}},"ConsentAPI_PurposeRuleDto":{"type":"object","properties":{"purposeId":{"description":"Identifier identifying a Purpose","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"enforcedStatus":{"description":"The Transaction Status enforced by the Consent Group for this Purpose","type":"string","example":"ACTIVE","minLength":1},"effectiveStatus":{"description":"The Consent Group's effective Transaction Status for this Purpose, which is calculated based on the Consent Group hierarchy","type":"string","example":"OPT_OUT"}},"required":["purposeId"]},"ConsentAPI_ConsentGroupSettingsDto":{"type":"object","properties":{"statusPriorityRules":{"description":"The Priority of the Purpose Statuses in the context of Consent Groups","type":"array","items":{"$ref":"#/components/schemas/ConsentAPI_ConsentGroupStatusPriorityDto"}}},"required":["statusPriorityRules"]},"ConsentAPI_ConsentGroupStatusPriorityDto":{"type":"object","properties":{"status":{"description":"The Purpose Status value","type":"string","example":"ACTIVE","enum":["ACTIVE","ALWAYS","ACTIVE","OPT OUT","HARD OPT OUT","PENDING","NO CONSENT","WITHDRAWN","EXPIRED"],"minLength":1},"priority":{"description":"The Priority of the Purpose Status, with 0 being the highest possible value","type":"integer","format":"int32","example":3,"minimum":0}},"required":["priority"]},"ConsentAPI_JobCreateRequest":{"type":"object","properties":{"EntityId":{"description":"The unique identifier of the entity for which the job is being created.","type":"string","example":"478059e6-97ff-4080-ae18-46989056fabb"},"Name":{"description":"The name of the job.","type":"string","example":"import123"},"Description":{"description":"The description of the job.","type":"string","example":"Bulk import of consent data subjects"},"Type":{"description":"The type of job.","type":"string","enum":["consent_ds_bulk_actions"]},"Token":{"description":"The authentication token required to execute the job.","type":"string","example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."}},"required":["EntityId","Name","Token"]},"ConsentAPI_JobResponse":{"type":"object","properties":{"Id":{"description":"The unique identifier of the scheduled job.","type":"string","format":"uuid","example":"1053400f-2a31-49cc-b164-3de08506ab6e"},"Name":{"description":"The name of the job.","type":"string","example":"job 1234"},"Description":{"description":"The description of the job.","type":"string"},"TypeId":{"description":"The type of job.","type":"string","example":"consent_ds_bulk_actions"},"Status":{"description":"The status of the job.","type":"string","example":"Pending","enum":["Pending","In Progress","Error","Completed"]},"StatusId":{"description":"The numeric status identifier of the job.","type":"integer","format":"int32","example":1},"ErrorCount":{"description":"The number of errors encountered during job execution.","type":"integer","format":"int32","example":0},"CreatedBy":{"description":"The unique identifier of the user who created the job.","type":"string","format":"uuid","example":"16eb22c4-415d-4852-ba36-1567a1bd277d"},"CreatedDate":{"description":"The date and time that the job was created.","type":"string","format":"date-time","example":"2026-02-11T06:32:23.769+00:00"}}},"ConsentAPI_ContinuationToken":{"type":"object","properties":{"requestContinuation":{"description":"Request continuation token used to paginate. If the number of records in the response is more than a page, it returns a `requestContinuation` token in the response. This `requestContinuation` token should be passed to the next request's body to paginate.","type":"string","example":{"compositeToken":{"token":"+RID:iNFkAI-ei-4uLDsAAAAAAA==#RT:2#SRC:1#TRC:40#RTD:0Idx9i7ua9Rq4VL3LfZOBTMxMzMuMjMuMjpVMjY7NTo7MjIvMzE5Nzo1AA==#ISV:2#IEO:65567#QCF:8#FPC:AgHq7OoGADE1APzASusCAABA7GoAIVt//sFH5/+hQP9/EUD/f/JAn8/9/xFAv/9DQP/7v//f/yJA//f/+2FC//sxQf9/IUD/O1FA/38RQP7/IUD7/5VA/7/t/93u93+2/xFA/58hQH/6MUB/+xhAv2//99v//f+//ev//+EfAA==","range":{"min":"","max":"FF"}},"orderByItems":[{"item":"2022-12-19T15:49:11.236953"}],"rid":"iNFkAI-ei-4FKjsAAAAAAA==","inclusive":true}},"nextMarker":{"description":"Request continuation token used to paginate over historical receipts","type":"string","example":"TGp8AqS3Gfnzwc5srJKeaA=="}}},"ConsentAPI_AttachmentDto":{"type":"object","properties":{"id":{"description":"The unique identifier of the uploaded attachment.","type":"string","format":"uuid","example":"3f6b0b58-1c9e-4f65-92b6-8e5c0cb9a1d2"}}},"ConsentAPI_CustomPreferenceChoiceDto":{"type":"object","properties":{"optionId":{"description":"The identifier of the selected option for this preference.","type":"string","format":"uuid","example":"8f3c2a47-6b2d-4b9d-9d8b-1b5f3c8f1a23"},"transactionType":{"description":"The type of transaction associated with this option.","type":"string","example":"OPT_IN"}}},"ConsentAPI_CustomPreferenceDto":{"type":"object","properties":{"id":{"description":"The unique identifier of the custom preference.","type":"string","format":"uuid","example":"3f6b0b58-1c9e-4f65-92b6-8e5c0cb9a1d2"},"options":{"description":"List of options linked to this preference.","type":"array","items":{"type":"string","format":"uuid"},"example":["8f3c2a47-6b2d-4b9d-9d8b-1b5f3c8f1a23","f1d24c56-9873-4c43-84af-2c94a7f9b11d"]},"choices":{"description":"List of choices made for this custom preference.","type":"array","items":{"$ref":"#/components/schemas/ConsentAPI_CustomPreferenceChoiceDto"}}}},"ConsentAPI_PageableObjectWithContinuationToken":{"type":"object","properties":{"paged":{"type":"boolean"},"pageNumber":{"type":"integer","format":"int32"},"offset":{"type":"integer","format":"int64"},"pageSize":{"type":"integer","format":"int32"},"unpaged":{"type":"boolean"},"sort":{"$ref":"#/components/schemas/ConsentAPI_SortObject"},"requestContinuation":{"description":"The token used to paginate a response if the number of records is more than a page.","type":"string"}}},"ConsentAPI_PreferenceDto":{"type":"object","properties":{"topicId":{"description":"Unique Identifier identifying a Topic","type":"string","format":"uuid","example":"8b2cbb9f-c567-4872-b063-139d0b64cb1c"},"transactionType":{"description":"Transaction type for the topic","type":"string","example":"OPT_IN"}}},"ConsentAPI_PrivacyNoticeDto":{"type":"object","properties":{"id":{"description":"The unique identifier of the privacy notice.","type":"string","format":"uuid","example":"a1b2c3d4-e5f6-7a89-b0c1-d2e3f4a5b6c7"},"version":{"description":"The major version number of the privacy notice.","type":"integer","format":"int64","example":3},"minorVersion":{"description":"The minor version number of the privacy notice.","type":"integer","format":"int64","example":2}}},"ConsentAPI_PurposeNoteDto":{"type":"object","properties":{"noteId":{"description":"Unique identifier for the purpose note","type":"string","format":"uuid","example":"d1a8f6f2-781a-4b2b-b1db-07e25f1c9a94"},"noteType":{"description":"Type of the note","type":"string","enum":["UNSUBSCRIBE_REASON"]},"noteLanguage":{"description":"Language of the purpose note","type":"string","example":"en-us"},"noteText":{"description":"The actual text of the note","type":"string","example":"0e7ed8b7-a64d-4e38-a7ea-7c28dbdd5869"}}},"ConsentAPI_PurposeScopeDto":{"type":"object","properties":{"key":{"description":"The key representing a specific scope of the purpose.","type":"string"},"value":{"description":"The description of the purpose scope.","type":"string"}}},"ConsentAPI_SortObject":{"type":"object","properties":{"empty":{"type":"boolean"},"unsorted":{"type":"boolean"},"sorted":{"type":"boolean"}}},"ConsentAPI_TransactionDto":{"type":"object","properties":{"receiptId":{"description":"The unique identifier identifying the Receipt","type":"string","example":"51a3384e-46d5-43ec-8d88-d7a4b95c7e3e"},"collectionPointUUID":{"description":"Unique Identifier identifying a Collection Point","type":"string","format":"uuid","example":"eb27838a-1ce2-4438-9601-82d88ade6af1"},"identifier":{"description":"Unique Identifier identifying a Data Subject","type":"string","example":"example@otprivacy.com"},"consentCreationDate":{"description":"The Date the Data Subject consented","type":"string","format":"date-time","example":"2024-01-01T00:00:00.000"},"interactionDate":{"description":"The date and time that the data subject data subject consent was interacted.","type":"string","format":"date-time","example":"2022-10-01T00:00:00.000"},"collectionPointAttributes":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"transactionGuid":{"description":"The unique identifier for the transaction.","type":"string","format":"uuid","example":"2f726312-73b8-4d17-90d1-0c9bb1f09f0f"},"guid":{"description":"The unique identifier for purpose.","type":"string","format":"uuid","example":"0e7ed8b7-a64d-4e38-a7ea-7c28dbdd5869"},"purposeGuid":{"description":"The unique identifier for purpose.","type":"string","format":"uuid","example":"0e7ed8b7-a64d-4e38-a7ea-7c28dbdd5869"},"purposeVersion":{"description":"The version of the purpose.","type":"integer","format":"int64","example":2},"expiryDate":{"description":"The Date by which the consent will expire.","type":"string","format":"date-time","example":"2024-01-01T00:00:00.000"},"removeExpiry":{"description":"Whether the purpose's expiry can be removed","type":"boolean","example":true},"topics":{"description":"The topics tied to the transaction.","type":"array","items":{"$ref":"#/components/schemas/ConsentAPI_PreferenceDto"}},"customPreferences":{"description":"List of CustomPreferences for the purpose","type":"array","items":{"$ref":"#/components/schemas/ConsentAPI_CustomPreferenceDto"}},"transactionType":{"description":"The transaction type.","type":"string","enum":["PENDING","CONFIRMED","WITHDRAWN","EXPIRED","NOTGIVEN","OPT_OUT","NO_CHOICE","HARD_OPT_OUT","EXTEND","CHANGE_PREFERENCES","CANCEL","NO_OPT_OUT","OPT_IN","IMPLICIT"]},"attributes":{"description":"The attributes attached to the purpose.","type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"purposeNote":{"description":"The notes tied to the purpose","example":"0e7ed8b7-a64d-4e38-a7ea-7c28dbdd5869","$ref":"#/components/schemas/ConsentAPI_PurposeNoteDto"},"autoGenerated":{"type":"boolean"},"purposeAttachments":{"description":"The attachment guids tied to the purpose","type":"array","items":{"$ref":"#/components/schemas/ConsentAPI_AttachmentDto"}},"consentDate":{"description":"The date and time when the consent was given by the data subject.","type":"string","format":"date-time","example":"2025-01-15T00:00:00.000"},"issueDate":{"description":"The date and time when the consent receipt was issued.","type":"string","format":"date-time","example":"2025-01-15T10:46:05Z"},"withdrawalDate":{"description":"The date and time when the consent was withdrawn, if applicable.","type":"string","format":"date-time","example":"2025-03-02T14:22:10Z"},"activationDate":{"description":"The date and time when the consent became active.","type":"string","format":"date-time","example":"2025-01-15T11:00:00Z"},"createdBy":{"description":"The guid of the user or system that created the consent record.","type":"string","example":"d72b29b1-5b0c-4c07-b09c-0e71f48bbdde"},"withdrawnBy":{"description":"The guid of the user or system that withdrew the consent, if applicable.","type":"string","example":"51a3384e-46d5-43ec-8d88-d7a4b95c7e3e"},"doubleOptIn":{"description":"Indicates whether the consent requires Double Opt-In confirmation.","type":"boolean","example":true},"test":{"description":"Indicates whether the data subject is marked as a test record.","type":"boolean","example":false},"purposePrivacyNotices":{"description":"List of privacy notices associated with the purposes of this consent.","type":"array","items":{"$ref":"#/components/schemas/ConsentAPI_PrivacyNoticeDto"}},"collectionPointPrivacyNotices":{"description":"List of privacy notices associated with the collection point where the consent was captured.","type":"array","items":{"$ref":"#/components/schemas/ConsentAPI_PrivacyNoticeDto"}},"purposeScopes":{"description":"The specific scope of purposes for which the consent applies.","type":"array","items":{"$ref":"#/components/schemas/ConsentAPI_PurposeScopeDto"}}}},"ConsentAPI_TransactionSliceDto":{"type":"object","properties":{"content":{"items":{"$ref":"#/components/schemas/ConsentAPI_TransactionDto"},"type":"array"},"pageable":{"$ref":"#/components/schemas/ConsentAPI_PageableObjectWithContinuationToken"},"first":{"type":"boolean"},"last":{"description":"Flag indicating whether this is the last page or not.","type":"boolean","example":false},"number":{"description":"The page number of the results.","type":"integer","format":"int32","example":1},"sort":{"$ref":"#/components/schemas/ConsentAPI_SortObject"},"size":{"description":"The number of results per page.","type":"integer","format":"int32","example":20},"numberOfElements":{"type":"integer","format":"int32"},"empty":{"type":"boolean"}}},"ConsentAPI_ConsentString":{"type":"object","properties":{"type":{"description":"The type of the consent string.","type":"string"},"content":{"description":"The content of the consent string.","type":"string"}}},"ConsentAPI_CustomPreferenceLanguageDtoV2":{"type":"object","properties":{"name":{"description":"The name identifying the Custom Preference","type":"string"},"description":{"description":"Whether this language is the default one for the Custom Preference","type":"string"},"language":{"description":"The Custom Preference content language code","type":"string"},"default":{"description":"Whether this language is the default one for the Custom Preference","type":"boolean"},"options":{"description":"Options associated with a Custom Preference","type":"array","items":{"$ref":"#/components/schemas/ConsentAPI_CustomPreferenceOptionDtoV2"}}}},"ConsentAPI_CustomPreferenceOptionDtoV2":{"type":"object","properties":{"id":{"type":"string"},"transactionType":{"type":"string"},"label":{"description":"The Option label","type":"string"},"order":{"type":"integer","format":"int32"},"isDefault":{"type":"boolean"}}},"ConsentAPI_DownStreamRuleAction":{"type":"object","properties":{"actionType":{"type":"string","enum":["SEND_EMAIL","DATA_SUBJECT_UPDATE","DATA_SUBJECT_PROFILE_UPDATE","PUBLISH_INTEGRATION_EVENT"]},"ruleAction":{"type":"string"},"ruleActionParameter":{"type":"string"}}},"ConsentAPI_DsAttachments":{"type":"object","properties":{"id":{"type":"string","format":"uuid"}}},"ConsentAPI_DsGeolocation":{"type":"object","properties":{"country":{"description":"The country of the captured consent.","type":"string","example":"US"},"state":{"description":"The abbreviated state of the captured consent.","type":"string","example":"CA"},"stateName":{"description":"The state of the captured consent.","type":"string","example":"California"},"purposeIds":{"description":"A list of unique identifiers of the Purpose for which Geolocation parameters are sent.","type":"array","items":{"type":"string","format":"uuid"},"uniqueItems":true}}},"ConsentAPI_DsPurposeScope":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}},"ConsentAPI_PurposeCustomPreferenceDtoV2":{"type":"object","properties":{"id":{"description":"The unique identifier of the Purpose and Custom Preference relation.","type":"string"},"name":{"description":"The name of the custom preference.","type":"string"},"displayAs":{"description":"The display type of the Custom Preference.","type":"string","enum":["BUTTONS","CHECKBOXES"]},"customPreferenceOptions":{"description":"The custom preference options.","type":"array","items":{"$ref":"#/components/schemas/ConsentAPI_CustomPreferenceOptionDtoV2"}},"languages":{"type":"array","items":{"$ref":"#/components/schemas/ConsentAPI_CustomPreferenceLanguageDtoV2"}}}},"ConsentAPI_PurposeInformationDtoV2":{"type":"object","properties":{"id":{"description":"The unique identifier for the purpose.","type":"string","format":"uuid","example":"ba8cab6d-a581-464b-8a6a-2a8de65f6d54"},"name":{"description":"The name of the purpose.","type":"string","example":"Marketing Purpose"},"description":{"description":"A brief description of the purpose.","type":"string","example":"Obtain consent for receiving promotional emails and product updates"},"status":{"description":"The status of the purpose.","type":"string","enum":["DRAFT","ACTIVE","RETIRED"]},"version":{"description":"The version number of the purpose.","type":"integer","format":"int64"},"purposeType":{"description":"The type of purpose.","type":"string","enum":["STANDARD","COOKIE","IAB","MOBILE","NOTIFICATION_OPT_OUT"]},"consentLifeSpan":{"description":"The lifespan of the consent for this purpose.","type":"integer","format":"int64","example":31536000},"transactionType":{"description":"The type of consent transaction.","type":"string","enum":["PENDING","CONFIRMED","WITHDRAWN","EXPIRED","NOTGIVEN","OPT_OUT","NO_CHOICE","HARD_OPT_OUT","EXTEND","CHANGE_PREFERENCES","CANCEL","NO_OPT_OUT","OPT_IN","IMPLICIT"]},"topics":{"description":"An array of topics associated with the purpose.","type":"array","items":{"$ref":"#/components/schemas/ConsentAPI_PurposeTopicDtoV2"}},"purposeScopes":{"description":"The list of purpose scopes associated with this data subject.","type":"array","items":{"$ref":"#/components/schemas/ConsentAPI_DsPurposeScope"}},"customPreferences":{"description":"The custom preferences related to the purpose.","type":"array","items":{"$ref":"#/components/schemas/ConsentAPI_PurposeCustomPreferenceDtoV2"}},"purposeNote":{"$ref":"#/components/schemas/ConsentAPI_PurposeNoteDtoV2"},"attributes":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"transactionId":{"type":"string","format":"uuid"},"expiryDate":{"type":"string","format":"date-time"},"purposeAttachments":{"type":"array","items":{"$ref":"#/components/schemas/ConsentAPI_DsAttachments"}}}},"ConsentAPI_PurposeNoteDtoV2":{"type":"object","properties":{"noteId":{"description":"The unique identifier of the reason template.","type":"string","format":"uuid"},"noteType":{"description":"The type of the note.","type":"string","enum":["UNSUBSCRIBE_REASON"]},"noteLanguage":{"description":"The language of the note.","type":"string"},"noteText":{"description":"The actual text of the note.","type":"string"},"isValidNote":{"description":"The flag that indicates if the purpose note is valid.","type":"boolean"}}},"ConsentAPI_PurposeTopicDtoV2":{"type":"object","properties":{"id":{"description":"The unique identifier of the purpose and topic relation.","type":"string","format":"uuid"},"transactionType":{"type":"string"},"name":{"description":"The name of the purpose topic.","type":"string"},"integrationKey":{"description":"The topic integration key (combination of purpose and topic names).","type":"string"},"languages":{"description":"A list of languages for a topic.","type":"array","items":{"$ref":"#/components/schemas/ConsentAPI_TopicLanguageDtoV2"}}}},"ConsentAPI_ReceiptInformationDetailDto":{"type":"object","properties":{"id":{"description":"The unique identifier for the receipt.","type":"string","format":"uuid","example":"5a2c2d8f-fd08-41c9-b912-6fcd073f8d4f"},"otJwtVersion":{"description":"The version of the JWT used, if applicable.","type":"integer","format":"int64","example":1},"organizationId":{"description":"The unique identifier of the organization.","type":"string","format":"uuid","example":"70a28a5f-9b46-481c-914c-b958d6a01d0c"},"dataSubjectIdentifierHash":{"description":"A hashed version of the data subject's identifier for secure reference.","type":"string","example":"28fe918b697f3f9b550bc485e6b61abd8f6890cd3b9c78337327d825f69af10ccd1f320102f32a22a6d921cfa8c8bb50bba2c620c3860340619f26246d8677c2"},"dataSubjectIdentifier":{"description":"The original data subject identifier.","type":"string","example":"example@otprovacy.com"},"collectionPointUUID":{"description":"The unique identifier of the collection point where the consent was captured.","type":"string","format":"uuid","example":"ec82c013-0d46-400c-b03c-f2ec239d3d36"},"collectionPointVersion":{"description":"The version of the collection point configuration.","type":"integer","format":"int64","example":1},"collectionPointName":{"description":"The name of the collection point.","type":"string","example":"API Collection Point"},"consentCreationDate":{"description":"The date and time when the consent was created.","type":"string","format":"date-time","example":"2025-09-11T14:32:45.123Z"},"customPayload":{"description":"A custom payload associated with the receipt (if applicable).","type":"string","example":{"payload1":"value1","payload2":"value2"}},"purposes":{"description":"An array of purposes for which the consent was provided.","type":"array","items":{"$ref":"#/components/schemas/ConsentAPI_PurposeInformationDtoV2"}},"test":{"description":"The flag that indicates if the receipt is part of a test.","type":"boolean","example":true},"origin":{"description":"The origin of the receipt, if specified.","type":"string","enum":["IMPORT","API","SDK","ONETRUST","PREFERENCE_CENTER","EMAIL_CLIENT_ONE_CLICK","HISTORIC_IMPORT"]},"doubleOptIn":{"description":"The flag that indicates if the consent was a double opt-in.","type":"boolean","example":true},"language":{"description":"The language in which the consent was recorded, if applicable.","type":"string","example":"en-us"},"collectionPointType":{"description":"The type of collection point.","type":"string","example":"API"},"isAnonymous":{"description":"The flag that indicates if the data subject is anonymous.","type":"boolean","example":true},"attributes":{"description":"Additional attributes related to the receipt.","type":"object","additionalProperties":{"type":"array","items":{"type":"object"}}},"interactionDate":{"description":"The date and time of the interaction.","type":"string","format":"date-time","example":"2025-09-18T10:15:30.000Z"},"dataElements":{"description":"The data elements tied to the receipt.","type":"object","additionalProperties":{"type":"object"}},"unsubscribeAll":{"description":"The flag that indicates if the data subject has unsubscribed from all communications.","type":"boolean","example":true},"geolocation":{"description":"The geolocation data associated with the consent, if available.","$ref":"#/components/schemas/ConsentAPI_DsGeolocation"},"ruleEvaluationResults":{"type":"array","items":{"$ref":"#/components/schemas/ConsentAPI_RuleEvaluationResult"}},"attachments":{"description":"The attachments tied to the receipt.","type":"array","items":{"$ref":"#/components/schemas/ConsentAPI_DsAttachments"}},"consentString":{"$ref":"#/components/schemas/ConsentAPI_ConsentString"},"source":{"description":"The source details of the consent interaction.","$ref":"#/components/schemas/ConsentAPI_Source"}}},"ConsentAPI_ReceiptInformationDetailSliceDto":{"type":"object","properties":{"content":{"items":{"$ref":"#/components/schemas/ConsentAPI_ReceiptInformationDetailDto"},"type":"array"},"pageable":{"$ref":"#/components/schemas/ConsentAPI_PageableObjectWithContinuationToken"},"first":{"type":"boolean"},"last":{"description":"Flag indicating whether this is the last page or not.","type":"boolean","example":false},"number":{"description":"The page number of the results.","type":"integer","format":"int32","example":1},"sort":{"$ref":"#/components/schemas/ConsentAPI_SortObject"},"size":{"description":"The number of results per page.","type":"integer","format":"int32","example":20},"numberOfElements":{"type":"integer","format":"int32"},"empty":{"type":"boolean"}}},"ConsentAPI_RuleActionResult":{"type":"object","properties":{"ruleAction":{"type":"string"},"ruleActionParameter":{"type":"string"},"ruleActionStatus":{"type":"string","enum":["COMPLETED","PARTIALLY_COMPLETED","NOT_INITIATED","FAILED"]},"downStreamRuleActions":{"type":"array","items":{"$ref":"#/components/schemas/ConsentAPI_DownStreamRuleAction"}}}},"ConsentAPI_RuleEvaluationResult":{"type":"object","properties":{"ruleId":{"description":"The unique identifier of the consent rule.","type":"string","format":"uuid","example":"a1a623ad-23f6-40c7-b079-46cc3adba518"},"ruleGroupId":{"description":"The unique identifier of the consent rule group.","type":"string","format":"uuid","example":"7751ec78-2d98-4aea-9bc5-09f78a57eaa6"},"consentRuleType":{"description":"The type of consent rule.","type":"string","enum":["CONSENT_INGEST"]},"evaluationResult":{"description":"The consent rule's result.","type":"boolean"},"actionResults":{"type":"array","items":{"$ref":"#/components/schemas/ConsentAPI_RuleActionResult"}},"resultData":{"type":"array","items":{"type":"object"}},"additionalParams":{"type":"object","additionalProperties":{"type":"object"}}}},"ConsentAPI_Source":{"type":"object","properties":{"type":{"description":"The type of source that captured the consent interaction.","type":"string"},"content":{"description":"The URL or identifier of the source where the consent interaction took place.","type":"string"},"purposeIds":{"description":"The unique identifiers of the purposes that the data subject must consent to in order for the source to be captured, such as the purpose ID for Advanced analytics or similar.","type":"array","items":{"type":"string","format":"uuid"},"uniqueItems":true}}},"ConsentAPI_TopicLanguageDtoV2":{"type":"object","properties":{"name":{"description":"The Topic name","type":"string"},"language":{"description":"The Topic content language code","type":"string"},"default":{"description":"Whether this language is the default one for the Topic","type":"boolean"}}},"ConsentAPI_ConsentGroupRequest":{"type":"object","properties":{"name":{"description":"The Consent Group name","type":"string","example":"OneTrust Atlanta","minLength":1},"description":{"description":"A description of the Consent Group","type":"string","example":"Consent for the company OneTrust, specifically for the Atlanta Office. Contains subsidiary data subjects representing OneTrust employees that work at this location."},"externalName":{"description":"The Consent Group's external name. If not provided, this will be generated based on the name","type":"string","example":"onetrust_atlanta"}}},"ConsentAPI_ConsentGroupDataSubjectsRequest":{"type":"object","properties":{"dataSubjects":{"description":"A list of Data Subjects to be added to a Consent Group, identified either by their id or their identifier value","type":"array","items":{"$ref":"#/components/schemas/ConsentAPI_DataSubjectInformation"},"maxItems":2147483647,"minItems":1}}},"ConsentAPI_DataSubjectInformation":{"type":"object","properties":{"id":{"description":"Unique Identifier identifying a Data Subject","type":"string","format":"uuid","example":"633ba071-61b0-485f-81a0-a2245777b432"},"identifier":{"description":"The Data Subject identifier value","type":"string","example":"example@otprivacy.com"}}},"ConsentAPI_ConsentGroupConsentGroupsRequest":{"type":"object","properties":{"consentGroupIds":{"description":"A list of Consent Groups to be added to a Consent Group as its children, identified by their ids","type":"array","items":{"type":"string","format":"uuid"},"example":["3b3ecf8f-afe5-4ff3-a621-5c519a385fae","fa3ecf8f-afe5-41f3-a621-5c519a38521e"],"maxItems":2147483647,"minItems":1}}},"ConsentAPI_EmailLinkTokenResponseDto":{"type":"object","properties":{"token":{"description":"The data subject link token. This token can be appended to the preference center URL to form the preference center magic link.","type":"string","example":"QFpXYCFOYUrFZfstplM5l1hjdLv4YlaQtkbYt7gpZUc="},"identifier":{"description":"The data subject identifier of the data subject.","type":"string","example":"example@otprivacy.com"},"createdDate":{"description":"The date and time that the data subject link token was created.","type":"string","format":"date-time","example":"2024-01-01T00:00:00.000"},"expiryDate":{"description":"The date and time that the data subject link token expires.","type":"string","format":"date-time","example":"2024-02-01T00:00:00.000"}}},"ConsentAPI_EmailLinkTokenSliceDto":{"type":"object","properties":{"content":{"items":{"$ref":"#/components/schemas/ConsentAPI_EmailLinkTokenResponseDto"},"type":"array"},"number":{"description":"The page number of the results.","type":"integer","format":"int32","example":1},"size":{"description":"The number of results per page.","type":"integer","format":"int32","example":20},"pageable":{"$ref":"#/components/schemas/ConsentAPI_PageableObject"},"last":{"description":"Flag indicating whether this is the last page or not.","type":"boolean","example":false},"sort":{"$ref":"#/components/schemas/ConsentAPI_SortObject"},"first":{"type":"boolean"},"numberOfElements":{"type":"integer","format":"int32"},"empty":{"type":"boolean"},"requestContinuation":{"description":"The token used to paginate a response if the number of records is more than a page.","type":"string","example":"{\\\"compositeToken\\\": \\\"jmxpAKZxe9nZkAoAAAAAAA==\\\"}"}}},"ConsentAPI_PageableObject":{"type":"object","properties":{"offset":{"type":"integer","format":"int64"},"sort":{"$ref":"#/components/schemas/ConsentAPI_SortObject"},"pageNumber":{"type":"integer","format":"int32"},"paged":{"type":"boolean"},"pageSize":{"type":"integer","format":"int32"},"unpaged":{"type":"boolean"}}},"ConsentAPI_LinkedIdentityGroupDto":{"type":"object","properties":{"id":{"description":"The unique identifier of the data subject group.","type":"string","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"name":{"description":"The name of the data subject group.","type":"string","example":"a2229953-b4b5-4042-8cb9-b78038cc4c41"},"identifier":{"description":"The data subject identifier of the data subject.","type":"string","example":"example@otprivacy.com"},"isPrimary":{"description":"This flag indicates whether the data subject identifier is the primary identifier associated with the data subject group.","type":"boolean","example":true},"addedDate":{"description":"The date and time that the data subject was added to the data subject group.","type":"string","format":"date-time","example":"2020-05-30T12:23:42.145Z"}}},"ConsentAPI_LinkedIdentityGroupDtoSliceDto":{"type":"object","properties":{"content":{"items":{"$ref":"#/components/schemas/ConsentAPI_LinkedIdentityGroupDto"},"type":"array"},"number":{"description":"The page number of the results.","type":"integer","format":"int32","example":1},"size":{"description":"The number of results per page.","type":"integer","format":"int32","example":20},"pageable":{"$ref":"#/components/schemas/ConsentAPI_PageableObject"},"last":{"description":"Flag indicating whether this is the last page or not.","type":"boolean","example":false},"sort":{"$ref":"#/components/schemas/ConsentAPI_SortObject"},"first":{"type":"boolean"},"numberOfElements":{"type":"integer","format":"int32"},"empty":{"type":"boolean"},"requestContinuation":{"description":"The token used to paginate a response if the number of records is more than a page.","type":"string","example":"{\\\"compositeToken\\\": \\\"jmxpAKZxe9nZkAoAAAAAAA==\\\"}"}}},"ConsentAPI_LinkedIdentityGroupPageItemDto":{"type":"object","properties":{"id":{"description":"The unique identifier for a data subject group.","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"name":{"description":"The unique name for a data subject group.","type":"string","example":"Marketing Data Subject Group"},"createdDate":{"description":"The date on which the data subject group was created.","type":"string","format":"date-time","example":"2020-05-30T12:23:42.145Z"},"lastModifiedDate":{"description":"The date on which the data subject group was last modified.","type":"string","format":"date-time","example":"2020-05-30T12:23:42.145Z"}}},"ConsentAPI_LinkedIdentityGroupPageItemSliceDto":{"type":"object","properties":{"content":{"items":{"$ref":"#/components/schemas/ConsentAPI_LinkedIdentityGroupPageItemDto"},"type":"array"},"number":{"description":"The page number of the results.","type":"integer","format":"int32","example":1},"size":{"description":"The number of results per page.","type":"integer","format":"int32","example":20},"pageable":{"$ref":"#/components/schemas/ConsentAPI_PageableObject"},"last":{"description":"Flag indicating whether this is the last page or not.","type":"boolean","example":false},"sort":{"$ref":"#/components/schemas/ConsentAPI_SortObject"},"first":{"type":"boolean"},"numberOfElements":{"type":"integer","format":"int32"},"empty":{"type":"boolean"},"requestContinuation":{"description":"The token used to paginate a response if the number of records is more than a page.","type":"string","example":"{\\\"compositeToken\\\": \\\"jmxpAKZxe9nZkAoAAAAAAA==\\\"}"}}},"ConsentAPI_DataSubjectAttachmentResponseDto":{"type":"object","properties":{"attachmentId":{"description":"The unique identifier of the file attached to the data subject record.","type":"string","format":"uuid","example":"25d9ccac-db88-4d34-849c-3d602a629961"},"fileName":{"description":"The name of the file attached to the data subject record.","type":"string","example":"policy.pdf"},"uploadedBy":{"description":"The name of the user who uploaded the file.","type":"string","example":"John Doe"},"uploadDate":{"description":"The date and time on which the file was uploaded.","type":"string","format":"date-time","example":"2024-01-01T00:00:00"}}},"ConsentAPI_DataSubjectElementResponseDto":{"type":"object","properties":{"name":{"description":"The name of the data element.","type":"string","example":"Work Email"},"value":{"description":"The value of the data element.","type":"object","example":"example@otprivacy.com, [Red, Blue]"},"doNotCall":{"description":"This flag indicates whether the data subject's phone number is on the Federal Trade Commissions (FTC's) Do Not Call list.","type":"boolean","example":true},"linked":{"description":"This flag indicates whether the data element is linked to the data subject.","type":"boolean"}}},"ConsentAPI_DataSubjectGeolocationResponseDto":{"type":"object","properties":{"dataSubjectId":{"description":"The unique identifier of the data subject.","type":"string","format":"uuid","example":"633ba071-61b0-485f-81a0-a2245777b432"},"receiptGuid":{"description":"The unique identifier of the consent receipt for which geolocation details were sent.","type":"string","format":"uuid","example":"633ba071-61b0-485f-81a0-a2245777b432"},"country":{"description":"The country where the consent interaction occurred.","type":"string","example":"US"},"state":{"description":"The state code where the consent interaction occurred.","type":"string","example":"GA"},"stateName":{"description":"The name of the state where the consent interaction occurred.","type":"string","example":"Georgia"}}},"ConsentAPI_DataSubjectResponseDto":{"type":"object","properties":{"identifier":{"description":"The data subject identifier of the data subject.","type":"string","example":"example@otprivacy.com"},"identifierType":{"description":"The type of data subject identifier used for the data subject's identifier.","type":"string","example":"Email"},"language":{"description":"The language set for the data subject.","type":"string","example":"en-us"},"createdDate":{"description":"The date and time that the data subject record was created.","type":"string","format":"date-time","example":"2020-01-12T16:11:25.479Z"},"lastTransactionDate":{"description":"The date and time that the last transaction for the data subject was written to the database.","type":"string","format":"date-time","example":"2020-01-12T16:11:25.479Z"},"lastReceiptGuid":{"description":"The unique identifier of the latest consent receipt for the data subject.","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"testDataSubject":{"description":"This flag indicates whether the data subject is used for testing purposes.","type":"boolean","example":true},"dataElements":{"description":"The additional information about the data subject.","type":"array","items":{"$ref":"#/components/schemas/ConsentAPI_DataSubjectElementResponseDto"}},"latestGeoLocation":{"description":"The geolocation details of the latest consent receipt.","$ref":"#/components/schemas/ConsentAPI_DataSubjectGeolocationResponseDto"},"consentGroups":{"description":"The list of data subject group identifiers to which the data subject belongs.","type":"array","items":{"type":"string","format":"uuid"},"example":"[633ba071-61b0-485f-81a0-a2245777b432, 25d9ccac-db88-4d34-849c-3d602a629961]"},"id":{"description":"Unique Identifier identifying a Data Subject","type":"string","format":"uuid","example":"633ba071-61b0-485f-81a0-a2245777b432"},"lastUpdatedDate":{"description":"The date that the Data Subject record was last updated on","type":"string","format":"date-time","example":"2020-01-12T16:11:25.479Z"},"doNotCall":{"description":"This attribute determines if a phone number is listed in FCCโs Do Not Call list","type":"boolean","example":true},"notices":{"description":"The Data Subject notices.","type":"array","items":{"$ref":"#/components/schemas/ConsentAPI_NoticeDetailResponseDto"}},"attachments":{"description":"Documents attached to Data Subject","type":"array","items":{"$ref":"#/components/schemas/ConsentAPI_DataSubjectAttachmentResponseDto"}}}},"ConsentAPI_DataSubjectResponseSliceDto":{"type":"object","properties":{"content":{"items":{"$ref":"#/components/schemas/ConsentAPI_DataSubjectResponseDto"},"type":"array"},"number":{"description":"The page number of the results.","type":"integer","format":"int32","example":1},"size":{"description":"The number of results per page.","type":"integer","format":"int32","example":20},"pageable":{"$ref":"#/components/schemas/ConsentAPI_PageableObject"},"last":{"description":"Flag indicating whether this is the last page or not.","type":"boolean","example":false},"sort":{"$ref":"#/components/schemas/ConsentAPI_SortObject"},"first":{"type":"boolean"},"numberOfElements":{"type":"integer","format":"int32"},"empty":{"type":"boolean"},"requestContinuation":{"description":"The token used to paginate a response if the number of records is more than a page.","type":"string","example":"{\\\"compositeToken\\\": \\\"jmxpAKZxe9nZkAoAAAAAAA==\\\"}"}}},"ConsentAPI_NameGuidPair":{"type":"object","properties":{"guid":{"description":"The unique identifier of the entity.","type":"string","format":"uuid","example":"15e30742-7e6c-4916-a5a1-7742a14ee284"},"name":{"description":"The name of the entity.","type":"string","example":"Marketing"}}},"ConsentAPI_NoticeDetailResponseDto":{"type":"object","properties":{"id":{"description":"The unique identifier of the collection point notice.","type":"string","format":"uuid","example":"05e30742-7e6c-4916-a5a1-7742a14ee984"},"name":{"description":"The name of the collection point notice.","type":"string","example":"Marketing Notice"},"url":{"description":"The URL where the collection point notice can be found.","type":"string","example":"www.onetrust.com"},"guid":{"description":"The unique identifier of a embedded privacy notice.","type":"string","format":"uuid","example":"1439b150-ef4c-444c-a20e-44622c8ccaf3"},"type":{"description":"The type of collection point notice.","type":"string","example":"EMBEDDED","enum":["LINKED","EMBEDDED"]},"purposes":{"description":"The details of the purposes linked to the collection point notice.","type":"array","items":{"$ref":"#/components/schemas/ConsentAPI_NameGuidPair"},"uniqueItems":true},"privacyNoticeVersion":{"description":"The version details of the collection point notice.","$ref":"#/components/schemas/ConsentAPI_VersionedEntity"},"collectionPoint":{"description":"The details of the collection point to which the privacy notice is linked.","$ref":"#/components/schemas/ConsentAPI_VersionedEntity"}}},"ConsentAPI_VersionedEntity":{"type":"object","properties":{"guid":{"description":"The unique identifier of the entity.","type":"string","format":"uuid","example":"15e30742-7e6c-4916-a5a1-7742a14ee284"},"name":{"description":"The name of the entity.","type":"string","example":"Marketing"},"version":{"description":"The version of the entity.","type":"integer","format":"int64","example":1},"minorVersion":{"description":"The minor version of the entity.","type":"integer","format":"int64","example":2}}},"ConsentAPI_DataSubjectProfileResponseDto":{"type":"object","properties":{"id":{"description":"Unique Identifier identifying a Purpose","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"identifier":{"description":"The data subject identifier of the data subject.","type":"string","example":"example@otprivacy.com"},"lastReceiptId":{"description":"Unique Identifier identifying a Receipt","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"name":{"description":"The Purpose name","type":"string","example":"Marketing Communications"},"version":{"description":"Version of the Purpose","type":"integer","format":"int64","example":2},"status":{"description":"The status of the purpose for the data subject.","type":"string","example":"ACTIVE"},"firstTransactionDate":{"description":"The date and time that the first transaction was written to the database.","type":"string","format":"date-time","example":"2020-01-05T11:34:30.974Z"},"lastTransactionDate":{"description":"The date and time that the last transaction was written to the database.","type":"string","format":"date-time","example":"2020-01-12T16:11:25.479Z"},"withdrawalDate":{"description":"The date and time that the data subject withdrew consent for the purpose.","type":"string","format":"date-time","example":"2020-01-12T16:11:25.479Z"},"consentDate":{"description":"The date and time that the data subject gave their last active consent.","type":"string","format":"date-time","example":"2020-01-07T13:18:23.123Z"},"expiryDate":{"description":"The explicit expiration date after which the purpose is no longer valid and no further consent is collected against it.","type":"string","format":"date-time","example":"2020-01-07T13:18:23.123Z"},"totalTransactionCount":{"description":"The total number of Transactions recorded against this Purpose","type":"integer","format":"int64","example":3},"topicsList":{"description":"The list of topics associated with the purpose.","type":"array","items":{"type":"string","format":"uuid"},"writeOnly":true},"topics":{"description":"The details of the topics for which transactions were recorded.","type":"array","items":{"$ref":"#/components/schemas/ConsentAPI_DataSubjectProfileTopicResponseDto"}},"customPreferencesMap":{"description":"The list of purpose preferences associated with the purpose.","type":"object","additionalProperties":{"type":"array","items":{"type":"string","format":"uuid"}},"writeOnly":true},"customPreferences":{"description":"The details of the purpose preferences for which transactions were recorded.","type":"array","items":{"$ref":"#/components/schemas/ConsentAPI_DsProfileCustomPreferenceResponseDto"}},"lastTransactionCollectionPointId":{"type":"string","format":"uuid"},"lastTransactionCollectionPointVersion":{"type":"integer","format":"int64"},"purposeNote":{"description":"The details of the reason template used to explain changes to the data subject's preferences.","$ref":"#/components/schemas/ConsentAPI_PurposeNoteResponseDto"},"lastUpdatedDate":{"description":"The date and time of the latest change to the data subject profile in the database.to any of: Purpose version, Purpose Status, or Topic/Custom Preference selections","type":"string","format":"date-time","example":"2020-01-05T11:34:30.974Z"},"lastInteractionDate":{"description":"The date and time of the data subject's last interaction with the purpose.","type":"string","format":"date-time","example":"2020-01-05T11:34:30.974Z"},"attributes":{"description":"The additional attributes associated with the purpose.","type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"geolocation":{"description":"The geolocation details of the consent interaction.","$ref":"#/components/schemas/ConsentAPI_DataSubjectGeolocationResponseDto"},"attachments":{"description":"Documents attached to Data Subject Profile","type":"array","items":{"$ref":"#/components/schemas/ConsentAPI_DataSubjectAttachmentResponseDto"}}}},"ConsentAPI_DataSubjectProfileResponseSliceDto":{"type":"object","properties":{"content":{"items":{"$ref":"#/components/schemas/ConsentAPI_DataSubjectProfileResponseDto"},"type":"array"},"number":{"description":"The page number of the results.","type":"integer","format":"int32","example":1},"size":{"description":"The number of results per page.","type":"integer","format":"int32","example":20},"pageable":{"$ref":"#/components/schemas/ConsentAPI_PageableObject"},"last":{"description":"Flag indicating whether this is the last page or not.","type":"boolean","example":false},"sort":{"$ref":"#/components/schemas/ConsentAPI_SortObject"},"first":{"type":"boolean"},"numberOfElements":{"type":"integer","format":"int32"},"empty":{"type":"boolean"},"requestContinuation":{"description":"The token used to paginate a response if the number of records is more than a page.","type":"string","example":"{\\\"compositeToken\\\": \\\"jmxpAKZxe9nZkAoAAAAAAA==\\\"}"}}},"ConsentAPI_DataSubjectProfileTopicResponseDto":{"type":"object","properties":{"id":{"description":"Unique Identifier identifying a Purpose Topic","type":"string","format":"uuid","example":"497c4383-2c61-4906-aed0-660e3fd03ef0"},"name":{"description":"The name of the topic.","type":"string","example":"Car Marketing"}}},"ConsentAPI_DsProfileCustomPreferenceOptionResponseDto":{"type":"object","properties":{"id":{"description":"The unique identifiers of the purpose preference options.","type":"string","format":"uuid","example":"ca0fc41b-b28a-4335-804c-44d1f0f782ed"},"name":{"description":"The name of the purpose preference options.","type":"string","example":"Weekly"}}},"ConsentAPI_DsProfileCustomPreferenceResponseDto":{"type":"object","properties":{"id":{"description":"The unique identifier of the purpose preference.","type":"string","format":"uuid","example":"c4a57a38-3774-45ad-9fa4-dbc545542232"},"name":{"description":"The name of the purpose preference.","type":"string","example":"Email Frequency"},"options":{"description":"List containing the Custom Preference's Options","type":"array","items":{"$ref":"#/components/schemas/ConsentAPI_DsProfileCustomPreferenceOptionResponseDto"}}}},"ConsentAPI_PurposeNoteResponseDto":{"type":"object","properties":{"noteId":{"description":"The unique identifier of the reason template.","type":"string","format":"uuid","example":"f312dd9b-58b4-4f34-b5ff-10b9b464bc4f"},"noteType":{"description":"The type of reason template.","type":"string","example":"UNSUBSCRIBE_REASON","enum":["UNSUBSCRIBE_REASON"]},"noteLanguage":{"description":"The ISO code for the language of the reason template.","type":"string","example":"en-us"},"noteText":{"description":"The text of the reason template.","type":"string","example":"I did not sign up for this."},"isValidNote":{"description":"This flag indicates whether the note is a valid reason template.","type":"boolean","example":true}}},"ConsentAPI_ConsentStringResponseDto":{"type":"object","properties":{"type":{"description":"The type of consent string.","type":"string","example":"GPP"},"content":{"description":"The content of the consent string.","example":"DBABMA~CQJ4dQAQJ4dQAPoABABGBUEAAAAAAAAAAAAAAAAAAAAA.QAAA.IAAA","type":"string"},"receivedDate":{"description":"The date and time that the consent string was received.","type":"string","format":"date-time","example":"2024-02-01T00:00:00.000"},"interactionDate":{"description":"The date and time of the last interaction with the consent string.","type":"string","format":"date-time","example":"2024-02-01T00:00:00.000"}}},"ConsentAPI_DataSubjectInformationResponseDto":{"type":"object","properties":{"identifier":{"description":"The data subject identifier of the data subject.","type":"string","example":"example@otprivacy.com"},"identifierType":{"description":"The type of data subject identifier used for the data subject's identifier.","type":"string","example":"Email"},"language":{"description":"The language set for the data subject.","type":"string","example":"en-us"},"createdDate":{"description":"The date and time that the data subject record was created.","type":"string","format":"date-time","example":"2020-01-12T16:11:25.479Z"},"lastTransactionDate":{"description":"The date and time that the last transaction for the data subject was written to the database.","type":"string","format":"date-time","example":"2020-01-12T16:11:25.479Z"},"lastReceiptGuid":{"description":"The unique identifier of the latest consent receipt for the data subject.","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"testDataSubject":{"description":"This flag indicates whether the data subject is used for testing purposes.","type":"boolean","example":true},"dataElements":{"description":"The additional information about the data subject.","type":"array","items":{"$ref":"#/components/schemas/ConsentAPI_DataSubjectElementResponseDto"}},"latestGeoLocation":{"description":"The geolocation details of the latest consent receipt.","$ref":"#/components/schemas/ConsentAPI_DataSubjectGeolocationResponseDto"},"consentGroups":{"description":"The list of data subject group identifiers to which the data subject belongs.","type":"array","items":{"type":"string","format":"uuid"},"example":"[633ba071-61b0-485f-81a0-a2245777b432, 25d9ccac-db88-4d34-849c-3d602a629961]"},"profiles":{"type":"array","items":{"$ref":"#/components/schemas/ConsentAPI_DataSubjectProfileResponseDto"}},"linkTokens":{"type":"array","items":{"$ref":"#/components/schemas/ConsentAPI_EmailLinkTokenResponseDto"}},"consentStrings":{"type":"array","items":{"$ref":"#/components/schemas/ConsentAPI_ConsentStringResponseDto"}},"id":{"description":"Unique Identifier identifying a Data Subject","type":"string","format":"uuid","example":"633ba071-61b0-485f-81a0-a2245777b432"},"lastUpdatedDate":{"description":"The date that the Data Subject record was last updated on","type":"string","format":"date-time","example":"2020-01-12T16:11:25.479Z"},"doNotCall":{"description":"This attribute determines if a phone number is listed in FCCโs Do Not Call list","type":"boolean","example":true},"notices":{"description":"The Data Subject notices.","type":"array","items":{"$ref":"#/components/schemas/ConsentAPI_NoticeDetailResponseDto"}},"attachments":{"description":"Documents attached to Data Subject","type":"array","items":{"$ref":"#/components/schemas/ConsentAPI_DataSubjectAttachmentResponseDto"}}}},"ConsentAPI_ConsentGroupListDto":{"type":"object","properties":{"consentGroupId":{"description":"Unique identifier identifying a Consent Group","type":"string","format":"uuid","example":"2a644966-fe93-4561-b71a-f0dda4396459"},"name":{"description":"The Consent Group name","type":"string","example":"OneTrust Atlanta","minLength":1},"externalName":{"description":"The Consent Group's external name. If not provided, this will be generated based on the name","type":"string","example":"onetrust_atlanta"}}},"ConsentAPI_PageConsentGroupListDto":{"type":"object","properties":{"content":{"description":"The list of items for the current page.","items":{"$ref":"#/components/schemas/ConsentAPI_ConsentGroupListDto"},"type":"array"},"empty":{"description":"The flag to check if the entity is empty or not.","type":"boolean","example":false},"first":{"description":"The flag to check if the entity is first entity or not.","type":"boolean","example":true},"last":{"description":"The flag to check if the entity is last entity or not.","type":"boolean","example":false},"number":{"description":"The number associated with the result.","type":"integer","format":"int32","example":0},"numberOfElements":{"description":"Total number of elements in the result.","type":"integer","format":"int32","example":20},"pageable":{"$ref":"#/components/schemas/ConsentAPI_PageableObject"},"sort":{"$ref":"#/components/schemas/ConsentAPI_SortObject"},"totalPages":{"description":"Total number of pages in the result list.","type":"integer","format":"int32","example":5},"totalElements":{"description":"Total number of elements in the result.","type":"integer","format":"int64","example":50},"size":{"description":"Size of the result list.","type":"integer","format":"int32","example":20}}},"ConsentAPI_DeletionCertificateResponseDto":{"type":"object","properties":{"objectId":{"description":"The unique identifier of the deleted object","type":"string","format":"uuid","example":"633ba071-61b0-485f-81a0-a2245777b432"},"objectType":{"description":"The type of the deleted object","type":"string","example":"DATA_SUBJECT","enum":["RECEIPT","DATA_SUBJECT","DATA_SUBJECT_PROFILE"]},"deleteTime":{"description":"The date and time when the object was marked for deletion","type":"string","format":"date-time","example":"2025-12-02T17:16:57.256567343"},"deleteType":{"description":"Indicates the source from which the delete request was initiated","type":"string","example":"RETENTION","enum":["RETENTION","API"]},"retentionPolicyRuleId":{"description":"The identifier of the retention policy rule associated with this deletion","type":"string","format":"uuid","example":"633ba071-61b0-485f-81a0-a2245777b432"}}},"ConsentAPI_DeletionCertificateSliceDto":{"type":"object","properties":{"content":{"items":{"$ref":"#/components/schemas/ConsentAPI_DeletionCertificateResponseDto"},"type":"array"},"number":{"description":"The page number of the results.","type":"integer","format":"int32","example":1},"size":{"description":"The number of results per page.","type":"integer","format":"int32","example":20},"pageable":{"$ref":"#/components/schemas/ConsentAPI_PageableObject"},"last":{"description":"Flag indicating whether this is the last page or not.","type":"boolean","example":false},"sort":{"$ref":"#/components/schemas/ConsentAPI_SortObject"},"first":{"type":"boolean"},"numberOfElements":{"type":"integer","format":"int32"},"empty":{"type":"boolean"},"requestContinuation":{"description":"The token used to paginate a response if the number of records is more than a page.","type":"string","example":"{\\\"compositeToken\\\": \\\"jmxpAKZxe9nZkAoAAAAAAA==\\\"}"}}},"ConsentAPI_DataSubjectDeleteRequestV4":{"type":"object","properties":{"identifier":{"description":"The data subject identifier of the data subject.","type":"string","example":"user-12345@ot.com"},"retainReceipts":{"description":"This flag indicates whether receipts will be retained while deleting data subjects. When set to `false`, receipts are removed from the database and no longer appear in the OneTrust Platform UI. However, these receipts are not permanently deleted and can still be retrieved using the [Get List of Receipts API](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/getreceiptlistdetailsusingpost).","type":"boolean","example":false}},"required":["identifier","retainReceipts"]},"ConsentAPI_DeletePurposeFromDataSubjectV4":{"type":"object","properties":{"purposes":{"description":"The unique identifiers of the purposes.","type":"array","items":{"type":"string","format":"uuid"},"example":["550e8400-e29b-41d4-a716-446655440000","550e8400-e29b-41d4-a716-446655440001"]},"identifier":{"description":"The data subject identifier of the data subject.","type":"string","example":"user-12345@ot.com"},"retainReceipts":{"description":"This flag indicates whether receipts will be retained while deleting purposes from data subjects. When set to `false`, receipts are removed from the database and no longer appear in the OneTrust Platform UI. However, these receipts are not permanently deleted and can still be retrieved using the [Get List of Receipts API](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/getreceiptlistdetailsusingpost).","type":"boolean","example":false}},"required":["identifier","purposes"]},"ConsentAPI_DataSubjectDeleteRequestV2":{"type":"object","properties":{"identifiers":{"description":"The list of data subject identifiers for the data subjects.","type":"array","items":{"type":"string"},"example":"user1@otprivacy.com"},"dataSubjectGuids":{"description":"The list of GUIDS for the data subject identifiers.","type":"array","items":{"type":"string","format":"uuid"},"example":"550e8400-e29b-41d4-a716-446655440000"},"fromCreatedDate":{"description":"The start of a date and time range for the data subject creation date.","type":"string","format":"date-time","example":"2022-02-01T12:33:40.000"},"toCreatedDate":{"description":"The end of a date and time range for the data subject creation date.","type":"string","format":"date-time","example":"2022-02-01T10:04:59.000"},"fromInteractionDate":{"description":"The start of a date and time range for the data subject interaction date.","type":"string","format":"date-time","example":"2022-02-01T08:10:11.000"},"toInteractionDate":{"description":"The end of a date and time range for the data subject interaction date.","type":"string","format":"date-time","example":"2022-02-02T08:10:11.000"},"retainReceiptsTransactions":{"description":"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](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/getreceiptlistdetailsusingpost).","type":"boolean","example":false},"removePIInfo":{"description":"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.","type":"boolean","example":false}}},"ConsentAPI_DeleteDataSubjectByPurposeRequest":{"type":"object","properties":{"jobGuid":{"description":"The UUID of the data exclusion job.","type":"string","format":"uuid","example":"fa0e8400-e29b-41d4-a716-446655441200"},"importId":{"description":"The import ID of the data exclusion job.","type":"string","example":"101"},"retainTransactions":{"description":"This flag indicates whether transactions will be retained while deleting purposes from data subjects. When set to `false`, transactions are removed from the database and no longer appear in the OneTrust Platform UI. However, these transactions are not permanently deleted and can still be retrieved using the [Get List of Receipts API](https://developer-onetrust-com.surrey.idm.oclc.org/onetrust/reference/getreceiptlistdetailsusingpost).","type":"boolean","example":false,"default":"false"},"deletePurposeFromAllDataSubjects":{"description":"This flag indicates whether the purpose should be deleted from all data subjects.","type":"boolean","example":false,"default":"false"}}},"ConsentAPI_CrossDeviceConsentDeleteRequest":{"type":"object","properties":{"identifiers":{"description":"A list of data subject identifiers for which the deletion of both the receipt and the cross-device consent is required.","type":"array","items":{"type":"string"},"example":["c4a57a38-3774-45ad-9fa4-dbc545542232","550e8400-e29b-41d4-a716-446655440001"],"maxItems":1000,"minItems":1}}},"DSPreferneceCache_UploadDataDto":{"type":"object","properties":{"refId":{"description":"Reference ID for the uploaded file.","type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"},"filename":{"description":"Original name of the uploaded file.","type":"string","example":"consent_form.pdf"},"fileSize":{"description":"Size of the uploaded file in bytes.","type":"integer","format":"int64","example":1024},"contentType":{"description":"MIME type of the uploaded file.","type":"string","example":"application/pdf"},"qualifiedName":{"description":"Fully qualified name/path of the uploaded file in storage.","type":"string","example":"tenant123/attachments/consent_form.pdf"}}},"DSPreferneceCache_CollectionPointNoticeWithVersionDtoV1":{"type":"object","properties":{"Id":{"description":"The collection point notice unique identifier","type":"string","format":"uuid","example":"05e30742-7e6c-4916-a5a1-7742a14ee984"},"Name":{"description":"The collection point notice name","type":"string","example":"Marketing Notice"},"Url":{"description":"The url to a linked privacy notice","type":"string","example":"www.onetrust.com"},"Guid":{"description":"The unique identifier of a embedded privacy notice","type":"string","format":"uuid","example":"1439b150-ef4c-444c-a20e-44622c8ccaf3"},"Type":{"description":"The type of the collection point notice","type":"string","example":"EMBEDDED","enum":["LINKED","EMBEDDED"]},"Purposes":{"description":"The set of purposes linked to the collection point notice","type":"array","items":{"$ref":"#/components/schemas/DSPreferneceCache_PurposeSimpleDetailsDtoV1"},"uniqueItems":true},"PrivacyNoticeVersion":{"description":"The active version of this collection point notice","$ref":"#/components/schemas/DSPreferneceCache_SimpleNameVersionDtoV1"},"CollectionPoint":{"description":"The collection point this notice is attached to","$ref":"#/components/schemas/DSPreferneceCache_SimpleNameVersionDtoV1"}}},"DSPreferneceCache_CosmosDsAttachment":{"type":"object","properties":{"attachmentId":{"type":"string","format":"uuid"},"fileName":{"type":"string"},"uploadedBy":{"type":"string"},"uploadDate":{"type":"string","format":"date-time"}}},"DSPreferneceCache_DataSubjectElementDto":{"type":"object","properties":{"name":{"description":"The Data Element name.","type":"string","example":"Work Email"},"value":{"description":"The Data Element value.","type":"object","example":"example@otprivacy.com, [Red, Blue]"},"doNotCall":{"description":"This attribute determines if a phone number is listed in FCCโs Do Not Call list.","type":"boolean","example":true}}},"DSPreferneceCache_DataSubjectGeolocation":{"type":"object","properties":{"dataSubjectId":{"type":"string","format":"uuid"},"country":{"type":"string"},"state":{"type":"string"},"stateName":{"type":"string"},"receiptGuid":{"type":"string","format":"uuid"}}},"DSPreferneceCache_DataSubjectProfileCustomPreferenceDto":{"type":"object","properties":{"id":{"description":"Unique Identifier identifying the Custom Preference.","type":"string","format":"uuid","example":"c4a57a38-3774-45ad-9fa4-dbc545542232"},"name":{"description":"The Custom Preference name.","type":"string","example":"Email Frequency"},"options":{"description":"List containing the Custom Preference's Options.","type":"array","items":{"$ref":"#/components/schemas/DSPreferneceCache_DataSubjectProfileCustomPreferenceOptionDto"}}}},"DSPreferneceCache_DataSubjectProfileCustomPreferenceOptionDto":{"type":"object","properties":{"Id":{"description":"Unique Identifier identifying a Custom Preference Option","type":"string","format":"uuid","example":"ca0fc41b-b28a-4335-804c-44d1f0f782ed"},"name":{"description":"The Option name","type":"string","example":"Weekly"}}},"DSPreferneceCache_DataSubjectProfileDto":{"type":"object","properties":{"id":{"description":"Unique Identifier identifying a Data Subject","type":"string","format":"uuid","example":"1b1f53d3-dc40-4288-abf1-74a4a4c33510"},"language":{"description":"The preferred language for the Data Subject","type":"string","example":"en-us"},"identifier":{"description":"The Data Subject identifier value","type":"string","example":"example@otprivacy.com"},"linkToken":{"description":"The Data Subject magic link token","type":"string","example":"jNJW2e8vm8eWb6DlWyGbZ/7PsfC+AHFN8JqvZHPGzJQ="},"lastUpdatedDate":{"description":"The date that the Data Subject record was last updated on","type":"string","format":"date-time","example":"2020-01-12T16:11:25.479Z"},"createdDate":{"description":"The date when the Data Subject record was created","type":"string","format":"date-time","example":"2020-01-12T16:11:25.479Z"},"dataElements":{"description":"The Data Subject's data elements","type":"array","items":{"$ref":"#/components/schemas/DSPreferneceCache_DataSubjectElementDto"}},"purposes":{"description":"The Data Subject's profile Purposes","type":"array","items":{"$ref":"#/components/schemas/DSPreferneceCache_DataSubjectProfilePurposeDto"}},"Notices":{"description":"The Data Subject's profile notices","type":"array","items":{"$ref":"#/components/schemas/DSPreferneceCache_CollectionPointNoticeWithVersionDtoV1"}},"testDataSubject":{"description":"Flag indicating if Data Subject is a test Data Subject","type":"boolean","example":true},"instantLinkTokens":{"description":"Instant access link tokens","type":"array","items":{"$ref":"#/components/schemas/DSPreferneceCache_LinkToken"}},"dsAttachments":{"description":"Documents attached to Data Subject","type":"array","items":{"$ref":"#/components/schemas/DSPreferneceCache_CosmosDsAttachment"}},"doNotCall":{"description":"This attribute determines if a phone number is listed in FCCโs Do Not Call list","type":"boolean","example":true},"latestGeolocation":{"description":"Latest Geolocation parameters of the DataSubject","$ref":"#/components/schemas/DSPreferneceCache_DataSubjectGeolocation"},"additionalIdentifierInstantLinkTokens":{"description":"Instant access link tokens for additional identifiers","type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}},"DSPreferneceCache_DataSubjectProfilePurposeDto":{"type":"object","properties":{"id":{"description":"Unique Identifier identifying a Purpose","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"lastReceiptId":{"description":"Unique Identifier identifying a Receipt","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"name":{"description":"The Purpose name","type":"string","example":"Marketing Communications"},"version":{"description":"Version of the Purpose","type":"integer","format":"int64","example":2},"status":{"description":"Status of the Purpose","type":"string","example":"ACTIVE"},"firstTransactionDate":{"description":"The Date the first transaction was recorded against this Purpose","type":"string","format":"date-time","example":"2020-01-05T11:34:30.974Z"},"lastTransactionDate":{"description":"The Date the last transaction was recorded against this Purpose","type":"string","format":"date-time","example":"2020-01-12T16:11:25.479Z"},"withdrawalDate":{"description":"The Date the withdrawal transaction was recorded against this Purpose","type":"string","format":"date-time","example":"2020-01-12T16:11:25.479Z"},"consentDate":{"description":"The Date the Data Subject consented to this Purpose","type":"string","format":"date-time","example":"2020-01-07T13:18:23.123Z"},"expiryDate":{"description":"The Date the Data Subject's consent expires for this Purpose","type":"string","format":"date-time","example":"2020-01-07T13:18:23.123Z"},"totalTransactionCount":{"description":"The total number of Transactions recorded against this Purpose","type":"integer","format":"int64","example":3},"topics":{"description":"A list containing the Purpose's Topics","type":"array","items":{"$ref":"#/components/schemas/DSPreferneceCache_DataSubjectProfileTopic"}},"customPreferences":{"description":"A list containing the Purpose's Custom Preferences","type":"array","items":{"$ref":"#/components/schemas/DSPreferneceCache_DataSubjectProfileCustomPreferenceDto"}},"lastTransactionCollectionPointId":{"type":"string","format":"uuid"},"lastTransactionCollectionPointVersion":{"type":"integer","format":"int64"},"purposeNote":{"description":"Note for a purpose","$ref":"#/components/schemas/DSPreferneceCache_PurposeNoteDto"},"groupEffectiveStatus":{"description":"A List of Effective Status of all purposes in consent group reference","type":"array","items":{"$ref":"#/components/schemas/DSPreferneceCache_PurposesGroupEffectiveStatusDto"}},"lastUpdatedDate":{"description":"Date/Time of the most recent interaction that resulted in an update for this Purpose to any of: Purpose version, Purpose Status, or Topic/Custom Preference selections","type":"string","format":"date-time","example":"2020-01-05T11:34:30.974Z"},"lastInteractionDate":{"description":"Date/Time of the most recent Data Subject interaction for this Purpose Receipt API","type":"string","format":"date-time","example":"2020-01-05T11:34:30.974Z"},"attributes":{"description":"Attributes attached to the purpose","type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"purposeAttachments":{"description":"Documents attached to Purpose","type":"array","items":{"$ref":"#/components/schemas/DSPreferneceCache_CosmosDsAttachment"}},"geolocation":{"description":"Geolocation parameters of the DataSubject received for this Purpose","$ref":"#/components/schemas/DSPreferneceCache_DataSubjectGeolocation"}}},"DSPreferneceCache_DataSubjectProfileTopic":{"type":"object","properties":{"id":{"description":"Unique Identifier identifying a Purpose Topic","type":"string","format":"uuid","example":"497c4383-2c61-4906-aed0-660e3fd03ef0"},"name":{"description":"The Topic name","type":"string","example":"Car Marketing"}}},"DSPreferneceCache_LinkToken":{"type":"object","properties":{"instantLinkToken":{"type":"string"}}},"DSPreferneceCache_PurposeNoteDto":{"type":"object","properties":{"noteId":{"description":"Unique identifier of the reason template","type":"string","format":"uuid"},"noteType":{"description":"The type of the note","type":"string","enum":["UNSUBSCRIBE_REASON"]},"noteLanguage":{"description":"The language of the note","type":"string"},"noteText":{"description":"The actual text of the note","type":"string"},"isValidNote":{"description":"Flag indicating if the note is a valid reason template","type":"boolean"}}},"DSPreferneceCache_PurposeSimpleDetailsDtoV1":{"type":"object","properties":{"Id":{"description":"The unique identifier of the purpose","type":"string","format":"uuid","example":"cbac5669-1445-4520-ba15-b1993902b295"},"Name":{"description":"The name of the purpose","type":"string","example":"Entity Name"}}},"DSPreferneceCache_PurposesGroupEffectiveStatusDto":{"type":"object","properties":{"groupId":{"description":"Unique identifier for identifying a Consent group","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"effectiveStatus":{"description":"Purpose status in a Consent Group","type":"string","example":"ACTIVE"}}},"DSPreferneceCache_SimpleNameVersionDtoV1":{"type":"object","properties":{"Id":{"description":"The unique identifier of the entity","type":"string","format":"uuid","example":"fcfe3c5e-6b1d-4eac-a5a4-aa7c8719b279"},"Name":{"description":"The name of the entity","type":"string","example":"Entity Name"},"Version":{"description":"The version of the entity","type":"integer","format":"int64","example":1},"MinorVersion":{"description":"The version of the entity","type":"integer","format":"int64","example":1}}},"DSPreferneceCache_CollectionPointNoticeProfilesDto":{"type":"object","properties":{"id":{"description":"The collection point notice unique identifier","type":"string","format":"uuid","example":"05e30742-7e6c-4916-a5a1-7742a14ee984"},"name":{"description":"The collection point notice name","type":"string","example":"Marketing Notice"},"url":{"description":"The url to a linked privacy notice","type":"string","example":"www.onetrust.com"},"privacyNoticeGuid":{"description":"The unique identifier of a embedded privacy notice","type":"string","format":"uuid","example":"1439b150-ef4c-444c-a20e-44622c8ccaf3"},"type":{"description":"The type of the collection point notice","type":"string","example":"EMBEDDED","enum":["LINKED","EMBEDDED"]},"purposes":{"description":"The set of purposes linked to the collection point notice","type":"array","items":{"$ref":"#/components/schemas/DSPreferneceCache_PurposeSimpleDetailsDto"},"uniqueItems":true},"privacyNoticeVersion":{"description":"The active version of this collection point notice","$ref":"#/components/schemas/DSPreferneceCache_SimpleNameVersionDto"},"collectionPoint":{"description":"The collection point this notice is attached to","$ref":"#/components/schemas/DSPreferneceCache_SimpleNameVersionDto"}}},"DSPreferneceCache_DataSubjectProfilesDto":{"type":"object","properties":{"id":{"description":"Unique Identifier identifying a Data Subject","type":"string","format":"uuid","example":"1b1f53d3-dc40-4288-abf1-74a4a4c33510"},"language":{"description":"The preferred language for the Data Subject","type":"string","example":"en-us"},"identifier":{"description":"The Data Subject identifier value","type":"string","example":"example@otprivacy.com"},"lastUpdatedDate":{"description":"The date that the Data Subject record was last updated on","type":"string","format":"date-time","example":"2020-01-12T16:11:25.479Z"},"createdDate":{"description":"The date when the Data Subject record was created","type":"string","format":"date-time","example":"2020-01-12T16:11:25.479Z"},"dataElements":{"description":"The Data Subject's data elements","type":"array","items":{"$ref":"#/components/schemas/DSPreferneceCache_DataSubjectElementDto"}},"purposes":{"description":"The Data Subject's profile Purposes","type":"array","items":{"$ref":"#/components/schemas/DSPreferneceCache_DataSubjectProfilesPurposeDto"}},"notices":{"description":"The Data Subject's profile notices","type":"array","items":{"$ref":"#/components/schemas/DSPreferneceCache_CollectionPointNoticeProfilesDto"}},"testDataSubject":{"description":"Flag indicating if Data Subject is a test Data Subject","type":"boolean","example":true},"dsAttachments":{"description":"Documents attached to Data Subject","type":"array","items":{"$ref":"#/components/schemas/DSPreferneceCache_CosmosDsAttachment"}},"LinkToken":{"description":"The Data Subject magic link token","type":"string","example":"jNJW2e8vm8eWb6DlWyGbZ/7PsfC+AHFN8JqvZHPGzJQ="},"latestGeoLocation":{"description":"Latest Geolocation parameters of the DataSubject","$ref":"#/components/schemas/DSPreferneceCache_DataSubjectGeolocation"}}},"DSPreferneceCache_DataSubjectProfilesPurposeDto":{"type":"object","properties":{"id":{"description":"Unique Identifier identifying a Purpose","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"lastReceiptId":{"description":"Unique Identifier identifying a Receipt","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"name":{"description":"The Purpose name","type":"string","example":"Marketing Communications"},"version":{"description":"Version of the Purpose","type":"integer","format":"int64","example":2},"status":{"description":"Status of the Purpose","type":"string","example":"ACTIVE"},"firstTransactionDate":{"description":"The Date the first transaction was recorded against this Purpose","type":"string","format":"date-time","example":"2020-01-05T11:34:30.974Z"},"lastTransactionDate":{"description":"The Date the last transaction was recorded against this Purpose","type":"string","format":"date-time","example":"2020-01-12T16:11:25.479Z"},"withdrawalDate":{"description":"The Date the withdrawal transaction was recorded against this Purpose","type":"string","format":"date-time","example":"2020-01-12T16:11:25.479Z"},"consentDate":{"description":"The Date the Data Subject consented to this Purpose","type":"string","format":"date-time","example":"2020-01-07T13:18:23.123Z"},"expiryDate":{"description":"The Date the Data Subject's consent expires for this Purpose","type":"string","format":"date-time","example":"2020-01-07T13:18:23.123Z"},"totalTransactionCount":{"description":"The total number of Transactions recorded against this Purpose","type":"integer","format":"int64","example":3},"preferences":{"description":"A list containing the Purpose's Topics","type":"array","items":{"type":"string","format":"uuid"},"writeOnly":true},"topics":{"description":"A list containing the Purpose's Topics","type":"array","items":{"$ref":"#/components/schemas/DSPreferneceCache_DataSubjectProfileTopic"}},"Preferences":{"description":"A list containing the Purpose's Custom Preferences","type":"object","additionalProperties":{"type":"array","items":{"type":"string","format":"uuid"}},"writeOnly":true},"customPreferences":{"description":"A list containing the Purpose's Custom Preferences","type":"array","items":{"$ref":"#/components/schemas/DSPreferneceCache_DataSubjectProfileCustomPreferenceDto"}},"lastTransactionCollectionPointId":{"type":"string","format":"uuid"},"lastTransactionCollectionPointVersion":{"type":"integer","format":"int64"},"purposeNote":{"description":"Note for a purpose","$ref":"#/components/schemas/DSPreferneceCache_PurposeNoteDto"},"lastUpdatedDate":{"description":"Date/Time of the most recent interaction that resulted in an update for this Purpose to any of: Purpose version, Purpose Status, or Topic/Custom Preference selections","type":"string","format":"date-time","example":"2020-01-05T11:34:30.974Z"},"lastInteractionDate":{"description":"Date/Time of the most recent Data Subject interaction for this Purpose Receipt API","type":"string","format":"date-time","example":"2020-01-05T11:34:30.974Z"},"attributes":{"description":"Attributes attached to the purpose","type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"purposeAttachments":{"description":"Documents attached to Purpose","type":"array","items":{"$ref":"#/components/schemas/DSPreferneceCache_CosmosDsAttachment"}},"geolocation":{"description":"Geolocation parameters of the DataSubject received for this Purpose","$ref":"#/components/schemas/DSPreferneceCache_DataSubjectGeolocation"}}},"DSPreferneceCache_DataSubjectProfilesSliceDto":{"type":"object","properties":{"content":{"items":{"$ref":"#/components/schemas/DSPreferneceCache_DataSubjectProfilesDto"},"type":"array"},"number":{"description":"The page number of the results.","type":"integer","format":"int32","example":1},"size":{"description":"The number of results per page.","type":"integer","format":"int32","example":20},"pageable":{"$ref":"#/components/schemas/DSPreferneceCache_PageableObject"},"last":{"description":"Flag indicating whether this is the last page or not.","type":"boolean","example":false},"sort":{"$ref":"#/components/schemas/DSPreferneceCache_SortObject"},"first":{"type":"boolean"},"numberOfElements":{"type":"integer","format":"int32"},"empty":{"type":"boolean"}}},"DSPreferneceCache_PageableObject":{"type":"object","properties":{"offset":{"type":"integer","format":"int64"},"sort":{"$ref":"#/components/schemas/DSPreferneceCache_SortObject"},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"unpaged":{"type":"boolean"},"paged":{"type":"boolean"}}},"DSPreferneceCache_PurposeSimpleDetailsDto":{"type":"object","properties":{"guid":{"description":"The unique identifier of the purpose","type":"string","format":"uuid","example":"cbac5669-1445-4520-ba15-b1993902b295"},"name":{"description":"The name of the purpose","type":"string","example":"Entity Name"}}},"DSPreferneceCache_SimpleNameVersionDto":{"type":"object","properties":{"guid":{"description":"The unique identifier of the entity","type":"string","format":"uuid","example":"fcfe3c5e-6b1d-4eac-a5a4-aa7c8719b279"},"name":{"description":"The name of the entity","type":"string","example":"Entity Name"},"version":{"description":"The version of the entity","type":"integer","format":"int64","example":1}}},"DSPreferneceCache_SortObject":{"type":"object","properties":{"empty":{"type":"boolean"},"unsorted":{"type":"boolean"},"sorted":{"type":"boolean"}}},"DSPreferneceCache_ConsentAttachmentReferencesResponse":{"type":"object","properties":{"identifier":{"description":"Identifier of the data subject","type":"string","example":"user@example.com"},"statusMessage":{"description":"Status message describing the result of the operation","type":"string","example":"Attachment references deletion Request has been accepted for processing"}}}},"securitySchemes":{"ConsentPreferences-UniversalConsentPreferenceManag_OAUTH2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{hostname}/api/access/v1/oauth/token","scopes":{"CONSENT":"Consent Scope gives the user access to read/write operations","CONSENT_READ":"Consent Read Scope gives the user read-only access"}}}},"ConsentAPI_OAUTH2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{hostname}/api/access/v1/oauth/token","scopes":{"CONSENT":"Consent Scope gives the user access to read/write operations","CONSENT_READ":"Consent Read Scope gives the user read-only access"}}}},"DSPreferneceCache_OAUTH2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{hostname}/api/access/v1/oauth/token","scopes":{"CONSENT":"Consent Scope gives the user access to read/write operations","CONSENT_READ":"Consent Read Scope gives the user read-only access"}}}}}}}