We've detected that you are using the Brave browser. This site does not display correctly when the Brave Shields are enabled. Please set your Shields to Down.
For AI agents: visit https://developer-onetrust-com.easyaccess1.lib.cuhk.edu.hk/onetrust/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
Jump to Content
OneTrust Developer PortalmyOneTrustDeveloper ForumTechnology Partners
SDK ReferenceRecipesAPI ReferenceChangelog
myOneTrustDeveloper ForumTechnology PartnersSubscribe via RSSOneTrust Developer Portal
API Reference
Subscribe via RSS
SDK ReferenceRecipesAPI ReferenceChangelog
  • OneTrust API Reference
  • Quick Start Guide: APIs
  • Environment URLs
  • OAuth 2.0
    • OAuth 2.0 Scopes
    • Managing OAuth 2.0 API Keys
    • Managing OAuth 2.0 Client Credentials
  • MCP Server
  • LLMs.txt
  • Rate Limits
  • Languages
  • Sunset & Deprecation
    • Deprecated APIs List
  • Pagination
  • System Status
  • API Guides
    • Consent Management Platform (CMP)
      • Automating CMP Operations Using OneTrust APIs
      • Creating a New Cookie Runner Script
      • CMP API Service Level Objectives
    • Data Discovery
      • Custom Scan using Worker Node APIs
    • Integrations
      • Integrating with Webhooks
    • IT & Security Risk Management
      • Updating a Control Implementation
      • Updating Risk Details
    • PIA & DPIA Automation
      • Importing GDPR Transfer Impact Assessment Template into the OneTrust Application
    • Policy & Notice Management
      • Managing Policies and Notices
    • SCIM User Provisioning
      • Updating a User's Role & Organization
      • Managing Users
      • Managing Organizations
    • OneTrust Platform
      • Bulk Export Demo Videos
      • Embedding the Trust Center on an existing webpage
    • Universal Consent & Preference Management
      • API Use Cases & Best Practices
      • API Service Level Objectives
      • Enabling iFraming of a OneTrust Preference Center
      • Implementing the Collection Point with REST API
      • Retrieving Client-Side Consent Preferences using the Preferences API
      • Using Consent Groups to Alter a Data Subject's Consent Status
      • Using the Preference Center Schema to Build Multi Page Preference Centers
      • Using the Preference Center Schema to Build Original or Enhanced Preference Centers
      • Welcome to the V4 APIs
      • Introducing the V4 Data Subjects APIs
      • V1 to V4 Migration Guide
  • Audit Records
    • Get Audit Records for Login Historyget
    • Get Audit Records for User's Profileget
  • OAuth Token
    • Generate Access Tokenpost
  • Organizations
    • Get List of Organizationsget
    • Create Organizationpost
    • Delete Organizationdel
    • Update Organizationput
  • User Groups
    • Get List of User Groupsget
    • Create User Grouppost
    • Delete User Groupdel
    • Update User Groupput
    • Remove Members from User Groupdel
    • Get User Group Membersget
    • Add Members to User Grouppost
  • User Groups V2
    • Get List of User Groupsget
    • Create User Grouppost
    • Get User Groupget
    • Update User Groupput
    • Delete User Groupdel
    • Get User Group Rolesget
    • Update User Group Rolesput
    • Add User Group Rolespost
    • Remove User Group Rolesdel
    • Get List of Users in User Groupget
    • Add Multiple Users to User Grouppost
    • Remove Multiple Users from User Groupdel
    • Add User to User Grouppost
    • Remove User from User Groupdel
  • Users V2
    • Get List of Usersget
    • Create Userpost
    • Get Userget
    • Update Userput
    • Get User Rolesget
    • Add User Rolepost
    • Remove User Roledel
    • Modify User Default Organizationpatch
  • Bulk Export
    • Get List of Bulk Exportsget
    • Create Bulk Exportpost
    • Get Bulk Export Credit Detailsget
    • Get Bulk Export Statusget
    • Cancel Bulk Exportdel
    • Get Bulk Export Download Detailsget
    • Get List of Bulk Export Download Detailsget
  • Attachments
    • Get File Locationget
    • Upload Filepost
  • Attachments V4
    • Get Download Tokenget
  • Document Gateway
    • Download Documentget
  • System Credentials
    • Create System Credentialpost
    • Update System Credentialput
  • Workflows V2
    • Export Workflowget
    • Import Workflowpost
  • Inventory Relationships V2
    • Get List of Relationshipspost
    • Update Relationship by Type Nameput
    • Link or Unlink Personal Data to Relationship by Type Nameput
    • Get Personal Data for Relationship by Type Namepost
    • Update Relationship by Type IDput
    • Link or Unlink Personal Data to Relationship by Type IDput
    • Get Personal Data for Relationship by Type IDpost
    • Create Relationshippost
    • Get Relationship by Type Nameget
    • Delete Relationship by Type Namedel
    • Get Relationship by Type IDget
    • Delete Relationship by Type IDdel
  • Relationship Management
    • Create Relationshippost
  • Model Management
    • Create Model Objectpost
    • Get Basic Model Object Detailspost
    • Get Model Object Detailspost
    • Get Model Objectget
    • Modify Model Objectput
    • Delete Model Objectdel
  • Object Attribute Management
    • Add Options to Attributepost
    • Add Attribute to Schemapost
    • Disable Attributeput
    • Enable Attributeput
  • Object Management
    • Create Objectpost
    • Get Full Object Detailspost
    • Delete Objectdel
    • Get Objectget
    • Modify Objectpatch
    • Get Basic Object Detailspost
  • Object Relationship Management
    • Create Relationship Record between Objectspost
    • Remove Relationship Recorddel
    • Get Relationship Recordget
  • Object Relationship Type Management
    • Create Relationship Type between Objectspost
    • Get List of Relationship Link Typespost
    • Get Relationship Typeget
  • Object Task Management
    • Create Taskpost
    • Get Taskget
    • Update Taskput
  • Object Type Management
    • Get List of Object Typespost
    • Get Object Type by Nameget
    • Modify Custom Object Type by Namepatch
    • Enable Custom Object Type by Nameput
    • Get Object Type by IDget
    • Modify Custom Object Type by IDpatch
    • Enable Custom Object Type by IDput
  • Project Management
    • Create Project Objectpost
    • Get Basic Project Object Detailspost
    • Get Project Object Detailspost
    • Get Project Objectget
    • Modify Project Objectput
    • Delete Project Objectdel
  • Tasks
    • Create Taskpost
    • Get Taskget
    • Update Taskput
  • Groups V2
    • Get List of Groupsget
    • Get Groupget
    • Update Groupput
    • Modify Grouppatch
  • Resources V3
    • Get Supported Resourcesget
    • Get Supported Resource Typesget
  • SCIM Schemas V3
    • Get List of Supported SCIM Schemasget
    • Get SCIM Schemaget
  • Service Provider V3
    • Get Service Provider Configurationget
  • User Groups V3
    • Get List of User Groupsget
    • Create User Grouppost
    • Delete User Groupdel
    • Get User Groupget
    • Update User Groupput
    • Modify User Grouppatch
  • Users V2
    • Get List of Usersget
    • Create Userpost
    • Get Userget
    • Update Userput
    • Delete Userdel
    • Modify Userpatch
  • Users V3
    • Get List of Usersget
    • Create Userpost
    • Get Userget
    • Update Userput
    • Modify Userpatch
  • Attribute Management
    • Add Options to Attributepost
    • Add Attribute to Schemapost
    • Disable Attributeput
    • Enable Attributeput
    • Get List of Schemasget
    • Get Attribute by IDget
    • Get List of Schema Attributesget
    • Get List of Schema Attribute Optionspost
  • Entity Management
    • Create Entitypost
    • Get Full Entity Detailspost
    • Get Entityget
    • Delete Entitydel
    • Modify Entitypatch
    • Get Basic Entity Detailspost
  • Entity Type Management
    • Get List of Entity Typespost
    • Get Entity Typeget
  • Entity Workflow Management
    • Update Entity Workflow Stagepost
  • Relationship Management
    • Get List of Relationship Records by Entitypost
    • Create Relationship Record between Entitiespost
    • Get Relationship Recordget
    • Remove Relationship Recorddel
  • Task Management
    • Create Taskpost
    • Get Taskget
    • Update Taskput
  • Applications
    • Create Applicationpost
    • Scan Applicationput
    • Get Branding Attributes for Applicationget
    • Update Branding Attributes for Applicationput
    • Get List of Applicationsget
    • Get List of Application Scansget
    • Get Application Scanget
    • Get List of Scan Permissionsget
    • Get Scan Privacy Manifestget
    • Get Privacy Manifest Data Typeget
    • Get List of Scan SDKsget
    • Get Scan SDKget
  • Cookies
    • Get Categorized Cookiespost
    • Edit Cookiesput
    • Add Cookiespost
    • Delete Cookiesdel
    • Get List of Cookies by Criteriapost
    • Recategorize Cookiesput
  • Domains
    • Delete Domaindel
    • Create or Update Domain Grouppost
    • Get Branding Attributes for Domainget
    • Update Branding Attributes for Domainput
    • Schedule Website Scanspost
    • Cancel Scheduled Website Scanspost
  • Geolocation Rules
    • Get List of Geolocation Rule Groupsget
    • Get Geolocation Rule Groupget
    • Assign Geolocation Rule Groupput
  • Scans
    • Get List of Websitesget
    • Scan Websitespost
    • Archive Scanspost
    • Get List of Scans by Domainget
    • Get List of Added or Removed Cookiesget
    • Get Scan Resultsget
    • Get Scan Result Summaryget
    • Get Scan Statusespost
    • Cancel Scanput
  • Scripts
    • Publish Application SDKput
    • Get Script for Applicationget
    • Publish Script to Websiteput
    • Get Script for Websiteget
    • Get Script for Domainget
    • Download Script Fileget
  • Templates
    • Get List of Templatesget
    • Get Template Detailsget
  • Categorizations
    • Categorize Cookies by Domainpost
    • Categorize Cookies by Domain and Cookie IDpost
  • Cookies
    • Create Cookiepost
    • Update Cookieput
    • Get List of Cookies by Criteriapost
  • Domains
    • Create or Update Domain Grouppost
  • Websites V2
    • Add Websites to Scanpost
    • Get List of Websitesget
  • Scripts
    • Download Script Fileget
    • Get Script for Websiteget
    • Publish Script to Websiteput
  • Domain Data
    • Get Domain Dataget
  • Preferences V2
    • Get Data Subject's Preferencesget
  • Banner
    • Get Banner Dataget
  • Data Subject Access Request (DSAR)
    • Submit Global Opt-Out Requestpost
  • Log Consent
    • Log Consentpost
  • Preference Center
    • Get Preference Center Dataget
  • UC Purposes
    • Get Universal Consent Purposesget
  • Vendors
    • Get IAB and Google Vendorsget
  • Consent Receipts
    • Create Consent Receiptspost
    • Create Consent Receipts in Bulkpost
    • Create Identified Consent Receiptspost
  • Preferences
    • Get Data Subject's Preferencesget
  • Mobile App Data
    • Get SDK Configurationget
  • Privacy Notice V2
    • Get List of Privacy Noticesget
    • Get List of Privacy Notice Versionsget
    • Get Privacy Notice Versionget
  • Collection Points
    • Get List of Collection Pointsget
    • Create Collection Pointpost
    • Get Collection Point Tokenget
    • Update Existing Collection Pointput
    • Update Collection Point Statusput
  • Collection Points V2
    • Get List of Collection Pointsget
    • Create New Collection Point Versionpost
  • Consent Attachments
    • Upload Consent Attachmentpost
    • Download Consent Attachmentget
    • Remove Consent Attachmentdel
    • Remove All Consent Attachmentsdel
    • Download All Consent Attachmentsget
  • Consent Groups
    • Get List of Consent Groupsget
    • Create Consent Grouppost
    • Get Priority Scores for Purpose Statusesget
    • Update Priority Scores for Purpose Statusesput
    • Get Consent Groupget
    • Add Consent Groups to Parent Consent Grouppost
    • Remove Consent Groups from Parent Consent Groupdel
    • Add Data Subjects to Parent Consent Grouppost
    • Remove Data Subject from Parent Consent Groupdel
    • Update Consent Group Purpose Ruleput
    • Add Purpose Rules to Consent Grouppost
    • Remove Purpose Rule from Consent Groupdel
  • Consent Rate Optimization
    • Delete Cross Device Consents and Receiptsdel
  • Custom Index Management
    • Create Custom Indexpost
    • Get Index Creation Statusget
  • Data Subject Groups
    • Get List of Data Subject Groupsget
    • Create Data Subject Grouppost
    • Get Data Subject Groupget
    • Update Data Subject Groupput
    • Delete Data Subject Groupdel
  • Data Subject Groups V4
    • Get List of Data Subject Group Associations by Data Subjectget
    • Get List of Data Subject Group Membersget
    • Create Data Subject Grouppost
    • Update Data Subject Groupput
    • Get List of Data Subject Groupsget
  • Data Subjects
    • Update Data Subject's Data Elementspost
    • Deduplicate Data Subjectsput
    • Get List of Data Subjectsget
    • Get List of Purposes for a Data Subjectget
  • Data Subjects V2
    • Get List of Data Subjectsget
    • Delete Purposes from Data Subjectdel
    • Search Data Subjectspost
    • Delete Purpose from Data Subjectsdel
    • Delete Data Subjectsdel
  • Data Subjects V3
    • Get List of Data Subjectsget
    • Get Data Subjectget
  • Data Subjects V4
    • Get List of Data Subjectsget
    • Get Data Subjectget
    • Get Data Subject Detailsget
    • Get List of All Purpose Details by Data Subjectget
    • Get List of All Purpose Details for All Data Subjectsget
    • Get Purpose Details by Data Subjectget
    • Get Optimized List of All Purpose Details for All Data Subjectsget
    • Get Optimized List of Data Subjectsget
    • Delete Data Subject del
    • Delete Purposes from Data Subjectsdel
    • Search Data Subjects by Data Elementpost
  • Deduplicate Data Subjects
    • Deduplicate Data Subjectspost
    • Generate Export of Duplicate Data Subjectsget
    • Get List of Scheduled Exportsget
    • Create Scheduled Export of Duplicate Data Subjectspost
    • Get Scheduled Exportget
    • Delete Scheduled Exportdel
  • Deletion Certificates
    • Get List of Deletion Certificatesget
  • Jobs
    • Create Jobpost
  • Magic Link Tokens
    • Get List of Data Subject Tokensget
  • Magic Link Tokens V4
    • Get Data Subject Tokenget
    • Get List of Data Subject Tokensget
  • Preference Centers
    • Get Data Subject's Preferences in a Preference Centerget
    • Update Data Subject's Preferences in a Preference Centerput
    • Withdraw Data Subject's Consent for All Purposes in a Preference Centerdel
    • Get Preference Center Schemaget
  • Preference Centers V2
    • Get Preference Center Page Schemaget
    • Get List of Preference Centersget
    • Get Preference Center Root Schemaget
  • Purpose Preferences
    • Get List of Purpose Preferencesget
    • Create Purpose Preferencepost
    • Update Purpose Preferenceput
    • Get Purpose Preferenceget
  • Purposes
    • Get List of Purposesget
    • Create Purposepost
    • Create New Purpose Versionpost
    • Update Purposeput
    • Get List of Data Subjects by Purposeget
    • Publish Purposeput
    • Retire Purposeput
  • Purposes V2
    • Get List of Purpose Versionsget
    • Get Purposeget
  • Receipts
    • Get List of Receipts by Data Subjectget
    • Get List of Receipt Details by Data Subjectget
    • Get Receiptget
  • Receipts V2
    • Get List of Receiptspost
  • Transactions
    • Withdraw Consent on Behalf of a Data Subjectput
    • Withdraw Data Subject's Consentget
  • Transactions V2
    • Get List of Transactionspost
  • Catalog Search V1
    • Get Catalog Search Resultspost
    • Get Search Fieldsget
  • Catalog Search V2
    • Get Catalog Search Resultspost
  • Data Asset Attributes
    • Get Data Asset Attributeget
    • Get List of Data Asset Attributesget
  • Data Asset Management
    • Delete Multiple Data Asset Tag Associationspost
    • Delete Multiple Data Asset Term Associationspost
  • Data Assets
    • Create Data Assetpost
    • Get Data Assetget
    • Delete Data Assetdel
    • Modify Data Assetpatch
    • Create Tag Associationspost
    • Create Term Associationspost
  • Glossaries
    • Get List of Glossariesget
    • Get Glossaryget
  • Tags
    • Get List of Tagsget
    • Get Tagget
    • Create Tagpost
  • Terms
    • Get List of Termsget
    • Get Term Attributeget
    • Get List of Term Attributesget
    • Get Termget
    • Get List of Term Namesget
    • Create Termpost
  • Classification
    • Get List of Custom Classifiersget
    • Create Custom Classifierpost
    • Get Custom Classifierget
    • Update Custom Classifierput
    • Delete Custom Classifierdel
  • Credentials
    • Get List of Credentialsget
    • Update Credentialput
    • Create Credentialpost
    • Get Credentialget
    • Delete Credentialdel
  • Data Sources
    • Get List of Data Sourcesget
    • Create or Update Data Sourceput
    • Delete Data Sourcedel
    • Get Data Sourceget
  • Installer
    • Get List of Image tagsget
  • Scan Jobs
    • Create Scan Jobpost
    • Get List of Scan Jobsget
    • Get Scan Jobget
    • Cancel Scan Jobpatch
    • Get Scan Jobget
    • Cancel Scan Jobpatch
  • Scan Profiles
    • Get List of Scan Profilesget
    • Create Scan Profilepost
    • Update Scan Profileput
    • Delete Scan Profiledel
    • Get Scan Profileget
  • Custom Scan
    • Get List of Scan Jobsget
    • Update Scan Job Statusput
    • Submit Data to Classifypost
    • Submit Data to Catalogpost
  • Assessment Actions
    • Launch Assessmentpost
    • Launch Assessments in Bulkpost
    • Launch Assessmentpost
    • Reassign Assessmentput
    • Create Assessment Taskpost
    • Reassess Assessmentpost
    • Reopen Assessmentpost
    • Send Back Assessmentpost
    • Approve Assessmentpost
    • Complete Assessmentpost
    • Submit Responsespost
    • Create Assessment Riskpost
    • Submit Assessmentpost
  • Assessment Management
    • Archive Assessmentput
    • Link Assessmentspost
    • Set Primary Recordput
    • Modify Assessmentpatch
    • Unarchive Assessmentput
    • Move Assessment to Recycle Binput
    • Update Assessment Tagsput
  • Assessments
    • Get List of Assessment Tagsget
    • Get List of Assessmentsget
    • Export Deleted Assessment Audit Logget
    • Get List of Assessment Resultsget
    • Get List of Linked Assessmentsget
    • Get Assessmentget
    • Get Assessment Workflow Stagesget
    • Get List of Assessments by Criteriapost
    • Get Assessment Recordget
    • Get Assessment Score Profilesget
    • Get Assessment Commentsget
    • Create Assessment Commentpost
  • Template
    • Get List of Templatesget
    • Import Templatepost
    • Delete Templatedel
    • Export Templateget
  • Inventory
    • Get List of Inventoriesget
    • Get List of Inventories by Criteriapost
    • Get Inventory by External IDget
    • Get Inventory by IDget
    • Update Inventory by IDput
    • Create Inventorypost
    • Update Inventory by External IDput
    • Delete Inventorydel
    • Copy Inventorypost
    • Update Inventory Statusput
  • Inventory Hierarchies
    • Set Inventory as Parentput
    • Unset Inventory as Parentput
    • Add Asset Inventory as Child to Parent Inventorypost
    • Add Legal Entity Inventory as Child to Parent Inventorypost
    • Add Processing Activity Inventory as Child to Parent Inventorypost
    • Add Vendor Inventory as Child to Parent Inventorypost
    • Remove Child Inventory from Root Inventorydel
    • Get List of Child Inventories by Root Inventoryget
  • Inventory Relationships V1
    • Update Advanced Attributes for Personal Data Associationput
    • Update Inventory Linkput
    • Link Inventoryput
    • Delete Inventory Linkdel
    • Link Inventorypost
    • Get Inventory Linksget