Creating Custom API Collection Points

You can create Custom API type Collection Points to record consent using OneTrust APIs. OneTrust APIs can be found in the OneTrust Developer Portal.

Note:

To access the Universal Consent & Preference Management APIs, see the OneTrust Developer Portal.

To create a Custom API Collection Point

  1. On the Universal Consent & Preference Management menu, select Interfaces > Collection Points. The Collection Points screen appears.

  2. Click the Add New button. The Create New Collection Point screen appears.

  3. Click the Custom API tile. The Define Collection Point screen appears.

  4. Complete the fields, as necessary. For more information, see Define Collection Point Screen Reference.

    In the Configuration section, create as many Purposes, Data Subject Identifiers, and Data Elements as needed clicking the Create New button in the corresponding fields.



  5. Click the Create Collection Point button. A Collection Point is created in Draft status.
    Note:

    Once the Collection Point is published, Purposes created from the Purposes field will be published as well. For more information, see Previewing and Publishing Collection Points.

Define Collection Point Screen Reference



Note:

Once the Collection Point has been created, you can easily identify Purposes capturing the data subject's location. Hover over the Geolocation icon or the Info icon for more details about how to enable/disable geolocation settings.

For more information, see Configuring Geolocation Capture.

View after clicking the Create New Version button.



View after clicking the Publish button.



Section

Field

Description

Overview

Name

Enter a unique name for the Collection Point.

Description

Enter a brief description of the Collection Point.

Organization

Select the organizational group that will be responsible for the Collection Point and the data collected through it.

Responsible User (Optional)

Select the user that will be responsible for the Collection Point.

Configuration

Allow Dynamic Configuration

Enable this setting to set up the Custom API type Collection Point without having to define the Purposes, Data Subject Identifier, or Data Elements in the configuration. Once enabled, the Purpose, Data Subject Identifier, and Data Elements fields will disappear. You will then be able to dynamically send these values in the API payload for the Collection Point.

This setting provides a more flexible way of using the Collection Points to meet multiple different use cases and reduces the need to create new versions of the Collection Point when changes are required.

Enable Parent-child relationship on this collection point

Enable this setting to allow parental consent on behalf of child data subjects on the Collection Point. When this setting is enabled, the Parent Identifier field appears, where you can select the data element to be used as the parent data subject identifier.

For more information, see Managing Parental Consent on Behalf of Child Data Subjects.

Allow Multiple Identifiers

Enable this setting to allow data subjects that interact with your Collection Point to provide more than one option for identification.

For more information, see Allowing Multiple Data Subject Identifiers on Collection Points.

Purposes

Select the Purposes of processing to include in the Collection Point.

Data Subject Identifier

Select the data element type that will be used to uniquely identify data subjects that interact with the Collection Point. You can configure what data element types can be used as identifiers on Collection Points using the Data Elements screen.

If you want to track data subject consent preferences across multiple Collection Points, ensure you use the same data subject identifier in each Collection Point.

Note:

The user identifier value supplied by the data subject is passed through to our systems as consent records are created.

To protect our service, we operate a safelist of accepted keyboard characters.  This includes all letters and numbers plus a select set of additional characters: \/-@.*#() _',:;+~{}|`^?=!$%()\\[]

If any identifier values are submitted with characters outside of this set, they will be rejected and no consent record will be generated.

If you expect valid user identifiers that contain characters outside of these, please contact OneTrust Support to have the safelist updated.

Parent Identifier

Select the data element to be used as the parent data subject identifier. This field appears if the Enable Parent-child relationship on this collection point setting is enabled for the collection point.

Data Elements (Optional)

Select additional data elements to collect from the data subject when interacting with the Collection Point.