Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Transactions V2

Get List of Transactions

Use this API to retrieve a list of all consent transactions. The response will include information about each transaction, the corresponding consent date, and details of the Purposes and the associated Purpose Preferences that the data subject has interacted with.

🗒 Things to Know

  • The timespan for the fromDate and toDate values must be 24 hours or less.
  • The collectionPointAttributes parameter will be returned as null when left blank during normal ingestion (API collection point, webform) and as {} when left blank during bulk import.
post/api/consent/v2/transactions

Query parameters

fromDatestring date-time

Retrieve transactions recorded after the specified date. Formats accepted: YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS

toDatestring date-time

Retrieve transactions recorded up to the specified date. Formats accepted: YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS

collectionPointGuidstring uuid

UUID of the Collection Point

pageinteger

Results page to be retrieved (0..N).

sizeinteger

Number of records per page (1..50).

sort'consentCreationDate,asc' | 'consentCreationDate,desc'
Example:consentCreationDate,desc

Sorting criteria in the format: property,direction (where direction is asc or desc). Supported properties: consentCreationDate.

Request body

requestContinuationstring

Request continuation token used to paginate. If the number of records in the response is more than a page, it returns a requestContinuation token in the response. This requestContinuation token should be passed to the next request's body to paginate.

nextMarkerstring

Request continuation token used to paginate over historical receipts

Example request

{
  "nextMarker": "TGp8AqS3Gfnzwc5srJKeaA=="
}

Response

Successfully retrieved list of transactions

firstboolean
lastboolean

Flag indicating whether this is the last page or not.

numberinteger

The page number of the results.

sizeinteger

The number of results per page.

numberOfElementsinteger
emptyboolean

Example response

{
  "content": [
    {
      "receiptId": "51a3384e-46d5-43ec-8d88-d7a4b95c7e3e",
      "collectionPointUUID": "eb27838a-1ce2-4438-9601-82d88ade6af1",
      "identifier": "example@otprivacy.com",
      "consentCreationDate": "2024-01-01T00:00:00.000",
      "interactionDate": "2022-10-01T00:00:00.000",
      "transactionGuid": "2f726312-73b8-4d17-90d1-0c9bb1f09f0f",
      "guid": "0e7ed8b7-a64d-4e38-a7ea-7c28dbdd5869",
      "purposeGuid": "0e7ed8b7-a64d-4e38-a7ea-7c28dbdd5869",
      "purposeVersion": 2,
      "expiryDate": "2024-01-01T00:00:00.000",
      "removeExpiry": true,
      "topics": [
        {
          "topicId": "8b2cbb9f-c567-4872-b063-139d0b64cb1c",
          "transactionType": "OPT_IN"
        }
      ],
      "customPreferences": [
        {
          "id": "3f6b0b58-1c9e-4f65-92b6-8e5c0cb9a1d2",
          "options": [
            "8f3c2a47-6b2d-4b9d-9d8b-1b5f3c8f1a23",
            "f1d24c56-9873-4c43-84af-2c94a7f9b11d"
          ],
          "choices": [
            {
              "optionId": "8f3c2a47-6b2d-4b9d-9d8b-1b5f3c8f1a23",
              "transactionType": "OPT_IN"
            }
          ]
        }
      ],
      "purposeNote": {
        "noteId": "d1a8f6f2-781a-4b2b-b1db-07e25f1c9a94",
        "noteLanguage": "en-us",
        "noteText": "0e7ed8b7-a64d-4e38-a7ea-7c28dbdd5869"
      },
      "purposeAttachments": [
        {
          "id": "3f6b0b58-1c9e-4f65-92b6-8e5c0cb9a1d2"
        }
      ],
      "consentDate": "2025-01-15T00:00:00.000",
      "issueDate": "2025-01-15T10:46:05Z",
      "withdrawalDate": "2025-03-02T14:22:10Z",
      "activationDate": "2025-01-15T11:00:00Z",
      "createdBy": "d72b29b1-5b0c-4c07-b09c-0e71f48bbdde",
      "withdrawnBy": "51a3384e-46d5-43ec-8d88-d7a4b95c7e3e",
      "doubleOptIn": true,
      "purposePrivacyNotices": [
        {
          "id": "a1b2c3d4-e5f6-7a89-b0c1-d2e3f4a5b6c7",
          "version": 3,
          "minorVersion": 2
        }
      ],
      "collectionPointPrivacyNotices": [
        {
          "id": "a1b2c3d4-e5f6-7a89-b0c1-d2e3f4a5b6c7",
          "version": 3,
          "minorVersion": 2
        }
      ]
    }
  ],
  "number": 1,
  "size": 20
}