How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

OneTrust Data Subjects V4 API

The Data Subjects V4 APIs are used to manage data subject information, preferences, and consent records.

OneTrust Data Subjects V4 API is one of 138 APIs that OneTrust publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Data Subjects V4. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 11 operations across 11 paths, and defines 28 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://{hostname}.

11 operations 11 paths 28 schemas 2 DELETE8 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://app.onetrust.com
Authentication
OAuth 2.0, OAuth 2.0, OAuth 2.0
License
Resource Areas
1

Authentication & Security 3

OneTrust Data Subjects V4 API declares 3 security schemes for authenticating requests. It supports OAuth 2.0 (ConsentPreferences-UniversalConsentPreferenceManag_OAUTH2) using the clientCredentials flow, exposing 2 scopes. It supports OAuth 2.0 (ConsentAPI_OAUTH2) using the clientCredentials flow, exposing 2 scopes. It supports OAuth 2.0 (DSPreferneceCache_OAUTH2) using the clientCredentials flow, exposing 2 scopes.

Paths & Operations 11

Across 11 paths, the API surfaces 11 operations — 2 DELETE, 8 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Data Subjects V4 11

The Data Subjects V4 APIs are used to manage data subject information, preferences, and consent records.

DELETE
/rest/api/consent/v4/data-subjects
Delete Data Subject
deleteDataSubjectUsingTTL body → 200400401403404422429500
DELETE
/rest/api/consent/v4/data-subjects/profiles
Delete Purposes from Data Subjects
deletePurposeFromDataSubjectsUsingTTL body → 200400401403404422429500
GET
/rest/api/consent/v4/datasubjects
Get List of Data Subjects
getDataSubjectsV4 7 params → 200400401403404429500
GET
/rest/api/consent/v4/datasubjects/basic-details
Get Data Subject
getDataSubjectBasicDetailsV4 2 params → 200400401403404429500
GET
/rest/api/consent/v4/datasubjects/details
Get Data Subject Details
getDataSubjectDetailsV4 6 params → 200400401403404429500
GET
/rest/api/consent/v4/datasubjects/ds-profiles
Get List of All Purpose Details by Data Subject
getAllProfilesByDataSubjectV4 5 params → 200400401403404429500
GET
/rest/api/consent/v4/datasubjects/profiles
Get List of All Purpose Details for All Data Subjects
getDataSubjectProfilesV4 9 params → 200400401403404429500
GET
/rest/api/consent/v4/datasubjects/profiles/unordered
Get Optimized List of All Purpose Details for All Data Subjects
getDataSubjectProfilesUnorderedV4 8 params → 200400401403404429500
GET
/rest/api/consent/v4/datasubjects/profiles/{purposeGuid}
Get Purpose Details by Data Subject
getDataSubjectProfileV4 2 params → 200400401403404429500
POST
/rest/api/consent/v4/datasubjects/search-by-element
Search Data Subjects by Data Element
searchDataSubjectsByElementV4 body → 200400401403422429500
GET
/rest/api/consent/v4/datasubjects/unordered
Get Optimized List of Data Subjects
getDataSubjectsUnorderedV4 5 params → 200400401403404429500

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are ConsentAPI_DataSubjectProfileResponseDto (26 properties), ConsentAPI_DataSubjectInformationResponseDto (19 properties), ConsentAPI_DataSubjectProfilePurposeDto (16 properties), ConsentAPI_DataSubjectResponseDto (16 properties). Each schema is shown below with its type and property counts.

ConsentAPI_DsProfileCustomPreferenceResponseDto
object
3 properties
ConsentAPI_DataSubjectInformationResponseDto
object
19 properties
ConsentAPI_ConsentStringResponseDto
object
4 properties
ConsentAPI_DataSubjectAttachmentResponseDto
object
4 properties
ConsentAPI_DataSubjectElementDto
object
3 properties 1 required
ConsentAPI_SortObject
object
3 properties
ConsentAPI_DataSubjectResponseSliceDto
object
10 properties
ConsentAPI_PageableObject
object
6 properties
ConsentAPI_VersionedEntity
object
4 properties
ConsentAPI_DataSubjectSearchResponse
object
2 properties
ConsentAPI_PurposeNoteResponseDto
object
5 properties
ConsentAPI_NameGuidPair
object
2 properties
ConsentAPI_DataSubjectProfilePurposeDto
object
16 properties
ConsentAPI_DataSubjectSourceResponseDto
object
4 properties
ConsentAPI_DsProfileCustomPreferenceOptionResponseDto
object
2 properties
ConsentAPI_NoticeDetailResponseDto
object
8 properties
ConsentAPI_DataSubjectProfileResponseSliceDto
object
10 properties
ConsentAPI_DeletePurposeFromDataSubjectV4
object
3 properties 2 required
ConsentAPI_EmailLinkTokenResponseDto
object
4 properties
ConsentAPI_DataSubjectElementResponseDto
object
4 properties
ConsentAPI_DataSubjectResponseDto
object
16 properties
ConsentAPI_DataSubjectGeolocationResponseDto
object
5 properties
ConsentAPI_DataSubjectSearchByElementRequest
object
3 properties
ConsentAPI_DataSubjectProfileResponseDto
object
26 properties
ConsentAPI_DataSubjectDeleteRequestV4
object
2 properties 2 required
ConsentAPI_PurposeNoteDto
object
4 properties
ConsentAPI_DataSubjectProfileTopicResponseDto
object
2 properties
ConsentAPI_DataSubjectProfileDto
object
9 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

onetrust-data-subjects-v4-api-openapi.yml Raw ↑

Other APIs OneTrust publishes across the network.

OneTrust Activity Log API
OneTrust Applications API
OneTrust Assessment Actions API
OneTrust Assessment Management API
OneTrust Assessments API
OneTrust Attachments API
OneTrust Attachments V4 API
OneTrust Attribute Management API
OneTrust Audit Records API
OneTrust Audits API
OneTrust Banner API
OneTrust Bulk Export API
Where this information came from

This is an independent, third-party profile of OneTrust Data Subjects V4 API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.