TRtruelayer
Accounts

Get Connected Accounts

Lists all connected accounts.

This API must be called using a client_credentials bearer token.

The endpoint returns a maximum of 50 items. Pagination will be supported in the future.

Items are ordered by type ascending, then id ascending.

get/v3/connected-accounts

Request

  • Base URL
    https://api.truelayer-sandbox.com
  • URL
    https://api.truelayer-sandbox.com/v3/connected-accounts
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://auth.truelayer.com/connect/token scopes: data

Query parameters

cursorstring

Cursor used for pagination purposes that represents the first item of the page. Returned as next_cursor in the response payload of endpoints supporting pagination. Not required to access the first page of items.

Example:bWFuZGF0ZXM6MmUwNDk0MTMK

Cursor used for pagination. Pass the next_cursor value from a previous response to retrieve the next page of results. Note: cursor-based pagination is not yet active; this parameter is accepted but has no effect in the initial release.

type'account' | 'card'

Filters results by resource type. Valid values are account and card.

Headers

Connection-Idstring required

The unique identifier of the data connection.

Tl-User-IPstring

Used to collect and record the end-user's IP address. The first IP address in the list will be used as the end-user IP address. Necessary to overcome 4 calls per day rate limits.

Response

Accounts

Example response

{
  "items": [
    {
      "id": "56c7b029e0f8ec5a2334fb0ffc2fface",
      "type": "account",
      "account_type": "current",
      "customer_segment": "retail",
      "currency": "GBP",
      "account_identifiers": [
        {
          "type": "sort_code_account_number",
          "sort_code": "560029",
          "account_number": "26207729"
        },
        {
          "type": "iban",
          "iban": "GB32CLRB04066800012315"
        }
      ],
      "bic": "MONZGB2LXXX",
      "account_holder_names": [
        "John Smith"
      ]
    }
  ],
  "pagination": {
    "next_cursor": "bWFuZGF0ZXM6MmUwNDk0MTMK"
  }
}

Changes

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