ONonetrust
Magic Link Tokens V4

Get Data Subject Token

Use this API to retrieve the link token for a specific data subject.

get/rest/api/consent/v4/datasubjects/linktokens

Request

  • Base URL
    https://hostname
  • URL
    https://hostname/rest/api/consent/v4/datasubjects/linktokens
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://{hostname}/api/access/v1/oauth/token scopes: CONSENT

Headers

identifierstring required

The data subject identifier of the data subject.

Response

OK

tokenstring

The data subject link token. This token can be appended to the preference center URL to form the preference center magic link.

identifierstring

The data subject identifier of the data subject.

createdDatestring date-time

The date and time that the data subject link token was created.

expiryDatestring date-time

The date and time that the data subject link token expires.

Example response

{
  "token": "QFpXYCFOYUrFZfstplM5l1hjdLv4YlaQtkbYt7gpZUc=",
  "identifier": "example@otprivacy.com",
  "createdDate": "2024-01-01T00:00:00.000",
  "expiryDate": "2024-02-01T00:00:00.000"
}

Changes

No recorded changes to this operation across all 1 revision of this API.