v1

latestOpenAPI 3.0.02026-07-2412592575.3 KB
consent-history

Retrieve consent history for a user

Retrieves the consent history for the authenticated user. Requires consent_history:read scope.

get/consent-history

Query parameters

userIdstring

The ID of the user to filter transactions on

Response

Successful Consent History Response

Example response

{
  "data": [
    {
      "userId": "68a875392bcdf2f9b497e615",
      "bankId": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
      "consents": [
        {
          "authorizationRequestId": "099dc850-c84e-4e33-b4ba-3f949b5ba0fb",
          "consentId": "consent-12345",
          "consentType": "accounts",
          "consentStatus": "active",
          "consentTo": "2025-11-24T10:14:56.024Z",
          "consentFrom": "2023-08-26T10:19:55.000Z",
          "grantedAt": "2023-08-26T10:20:00.000Z",
          "permissions": [
            "ReadAccountsDetail",
            "ReadBalances",
            "ReadTransactionsCredits",
            "ReadTransactionsDebits",
            "ReadTransactionsDetail",
            "ReadProducts"
          ],
          "createdAt": "2025-08-26T10:14:56.027Z",
          "expiresAt": "2025-09-25T10:14:56.027Z",
          "connectionId": "1ffe704d39629a929c8e293880fb449a:48315090-b022-4716-8c08-5ba176f8fa5a",
          "accountDetails": [
            {
              "schemeName": "UK.OBIE.SortCodeAccountNumber",
              "identification": "80055100813796",
              "accountType": "cash:current"
            }
          ],
          "vrpDetails": {
            "accountTo": "12345678 12-34-56",
            "accountFrom": "87654321 65-43-21"
          }
        }
      ]
    }
  ]
}