Get all user accounts

Use the GET /v3/connected-accounts endpoint to retrieve all bank accounts associated with a data connection.

The endpoint returns all account details for a specific data connection, including:

account type
currency
account identifiers (such as sort code and account number or IBAN)
account holder names (when available from the bank).

Authentication

This endpoint requires two authentication components:

A bearer access token. This must come from the OAuth2 client_credentials flow, with the data scope.
A Connection-Id header obtained from creating a data connection, with the accounts scope.

You may also want to provide the IP address of the end user as a header. This confirms that your user is present when the request is made, enabling you to bypass rate limiting.

Make a GET request to the endpoint with these headers to retrieve all accounts associated with the connection ID that you provided.

Response

A successful response returns a paginated list of all accounts associated with the connection.

Field	Required?	What it means
`id`	Yes	The UUID associated with the account.
`account_type`	Yes	The type of bank account. Can be `current` or `savings`.
`customer_segment`	Yes	The type of customer that this bank account serves. Can be `retail` or `business`.
`currency`	Yes	The currency that the account is in. Can be `GBP` or `EUR`.
`account_identifiers`	Yes	An object containing account details. This object can include multiple sets of account details (for example: sort code and account number, or IBAN)
`account_identifiers.type`	Yes	Indicates whether the account identifiers are sort code and account number or IBAN.
`bic`	No	The BIC associated with the account.
`account_holder_names`	Yes	Any names associated with the account (this may be more than one name, if the account is a joint account).

An example response looks like this:

{
  "items": [
    {
      "id": "56c7b029e0f8ec5a2334fb0ffc2fface",
      "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"
  }
}