Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Receipts

Get Receipt

❗️ End of Support Notification

As of September 1, 2024, these APIs are now deprecated. Any customers leveraging these APIs are encouraged to migrate to the Receipts V2 API. For more information, see OneTrust API Sunsetting & Deprecation Guidelines.

Use this API to retrieve a single receipt by its unique identifier. The response will return information such as the receipt interaction date along with details of the Purposes that the data subject has interacted with, and their corresponding statuses.

get/api/consentmanager/v1/receipts/{id}

Path parameters

idstring uuid required
Example:97a87bf2-d84d-428d-9e3a-703f33ff8f6a

The unique identifier of the receipt.

Query parameters

includeNotgivenboolean

If true, the response will include Non Given transactions.

includeConsentStringsboolean

If true, the response will include consent strings.

Response

OK - Successfully retrieved receipt.

idstring uuid required

The unique identifier for the receipt

otJwtVersioninteger

Version of the JWT token used for the receipt

dataSubjectIdentifierHashstring

Hashed value of the data subject's identifier for privacy protection

dataSubjectIdentifierstring

The actual identifier of the data subject (e.g., email, user ID)

collectionPointUUIDstring uuid

Unique identifier of the collection point that generated this receipt

collectionPointVersioninteger

Version number of the collection point

collectionPointNamestring

Human-readable name of the collection point

consentCreationDatestring date-time

Timestamp when the consent was created

receiptJwtstring required

JWT token containing the receipt information

customPayloadstring

Custom JSON payload included with the receipt

testboolean

Indicates if this receipt was created in test mode

origin'IMPORT' | 'API' | 'SDK' | 'ONETRUST' | 'PREFERENCE_CENTER' | 'EMAIL_CLIENT_ONE_CLICK' | 'HISTORIC_IMPORT'

Source origin of the consent request

doubleOptInboolean

Indicates if double opt-in was required for this consent

languagestring

Language code for the consent interaction

collectionPointTypestring

Type of the collection point

isAnonymousboolean

Indicates if the consent was given anonymously

attributesobject

Additional attributes associated with the receipt

interactionDatestring date-time

Timestamp of the user interaction that generated this receipt

dsDataElementsobject

Data subject related data elements

unsubscribeAllboolean

Indicates if the user opted to unsubscribe from all communications

additionalIdentifiersobject

Additional identifiers for the data subject

Example response

{
  "id": "09ccd1b9-84a0-4bcb-a167-f761391ebffa",
  "otJwtVersion": 1,
  "dataSubjectIdentifierHash": "ee26b0dd4af7e749aa1a8ee3c10ae9923f618980772e473f8819a5d4940e0db27ac185f8a0e1d5f84f88bc887fd67b143732c304cc5fa9ad8e6f57f50028a8ff",
  "dataSubjectIdentifier": "user@example.com",
  "collectionPointUUID": "25d9ccac-db88-4d34-849c-3d602a629961",
  "collectionPointVersion": 2,
  "collectionPointName": "Website Signup Form",
  "consentCreationDate": "2023-10-08T12:00:00Z",
  "receiptJwt": "AABmODM2OGM0ZC1mMmUwLTQ2MGYtYjQyOC03ZTQyZjQ1MWI3MGVJovwdqc7MU+49lOy",
  "customPayload": "{\"payload1\":\"value1\",\"payload2\":\"value2\"}",
  "purposes": [
    {
      "id": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
      "name": "Marketing Communications",
      "description": "Collect customer emails for marketing purposes",
      "status": "ACTIVE",
      "version": 2,
      "purposeType": "STANDARD",
      "consentLifeSpan": 7889238,
      "transactionType": "CONFIRMED",
      "topics": [
        {
          "id": "497c4383-2c61-4906-aed0-660e3fd03ef0",
          "transactionType": "OPT_IN",
          "name": "Car Marketing",
          "integrationKey": "Marketing-Communications_Car-Marketing",
          "canDelete": true
        }
      ],
      "customPreferences": [
        {
          "id": "c4a57a38-3774-45ad-9fa4-dbc545542232",
          "name": "Email Frequency",
          "displayAs": "BUTTONS"
        }
      ]
    }
  ],
  "doubleOptIn": true,
  "language": "en-US",
  "collectionPointType": "WEB_FORM",
  "geolocation": {
    "country": "US",
    "state": "GA",
    "stateName": "Georgia"
  },
  "consentStringDto": {
    "type": "IAB_TCF_V2",
    "content": "COzQOA8O1zG3YCABBDEA0CsAP_AAH_AAAAAI6td_H__bX9j-em_6bftr9Bf7a_9tfuA0mGcc1ZcnAkigTgQhRfmkfbO2JwY6D5Y6G1AAQhoQHtH6EGAAaEBAgIAAoACAIQAgQAgACBAAAAA"
  },
  "source": {
    "type": "WEB",
    "content": "https://example.com/consent"
  }
}