Consent Management v2 API references

The OneWelcome Identity Platform provides access to the following Consent Management v2 APIs:

• Configuration API

• Runtime API

• Ledger API

The Consent Management v2 service is a multi-tenant service that streamlines communication between the Consent UI and the backend database.

API categories

Configuration API

The Configuration API allows platform administrators to manage the consent configuration:

• Tenant Management: Configure tenant-level settings.
• Document Definition Management: Create and manage consent document definitions.
• Document Version Management: Manage versions of consent documents.
• Document Localization Management: Manage language-specific localizations of consent documents.

Runtime API

The Runtime API allows applications to interact with user consents at runtime:

• User Consent Management: Register user consents and query outstanding consent documents that require user action.

Ledger API

The Ledger API provides audit and reporting capabilities:

• Consent Ledger: Query the historical consent ledger for audit and compliance purposes.

Authentication and authorization

All Consent Management v2 APIs are protected by OAuth2 Bearer JWT tokens. Two authentication flows are supported:

• Client Credentials (S2S): For server-to-server integrations using OAuth2 scopes for authorization.
• Authorization Code: For user-facing applications where the user is authenticated. Authorization is based on DABP roles retrieved from the user info endpoint.