This document provides essential guidance for using OneTrust Universal Consent & Preference Management APIs effectively, offering a breakdown of common use cases, recommended actions, and practices to avoid. Use this guide as a starting point to ensure optimal performance and efficiency when implementing Universal Consent & Preference Management APIs. Dive into the detailed use cases in the table below to get started!
Please, review the following documentation before proceeding with the implementation:
| Business Use Case | Do | Don’t | Why | Details |
|---|---|---|---|---|
| Bulk Import | Use the Stream Consent Receipts bulk import template. | Do not repeatedly call consent receipts. | Stream Consent Receipts processes faster with no message throttling and a dedicated lane. | Using the Stream Consent Receipts Import Template |
| User Login / UI | Use the v1/preferences API. | Do not use the V1, V2, V3, or V4 Data Subject APIs. | The v1/preferences API offers a performance of <=100ms and supports up to 3k calls per minute without degrading performance. | Get Data Subject's Preferences API |
| On-demand Integrations / Ad-hoc / Point Reading | Use the Data Subject APIs. Continue to use v1/datasubjects if you have not migrated to v4/datasubjects. | Do not use v3/datasubjects if you have not migrated yet. | The Data Subject APIs allow on-demand fetching of data subject details. Response times may vary. | - v1/datasubjects - v2/datasubjects - v3/datasubjects - v4/datasubjects |
| Large Queries, List Queries, and Integrations (File-based) | Use Bulk Export. | Do not recursively call the V1, V2, V3, or V4 Data Subject APIs. | Bulk Export is designed for large queries, supporting multiple filters and file-based integrations. | Create Bulk Export API Bulk Export Demo Videos |
For more information on OneTrust’s Universal Consent & Preference Management, visit our Knowledge Base. We recommend reviewing the following articles: