List accounts

Returns the list of every account found in a connection, including inactive portfolios.

List accounts for the given connection

Retrieve every account for the given connection

GEThttps://api.finlink.vumi.io/api/v1/queries/connections/{token}/accounts

Authorization

bearerAuth

Path parameters

token*string

Token to identify the connection

Response

200401404500

Successfully retrieved all accounts

Body

application/json

idstring (uuid)

The account ID

portfoliostring (uuid)

The portfolio to which the account belongs. Only available in BROKER entities

ibanstring

The account IBAN if applicable

typeenum

The account type

CASH_ACCOUNTOTHER

aliasstring

The alias for the account if applicable

balancenumber

The account balance at the updatedAt timestamp

currencystring

The account currency following the ISO 4217

Example: "EUR"

updatedAtstring (date-time)

Timestamp in UTC at which the portfolio information was last updated

createdAtstring (date-time)

Timestamp in UTC at which the portfolio was created

ownersarray of string

A list of unique account owners

Request

JavaScriptCurlPython

const response = await fetch('https://api.finlink.vumi.io/api/v1/queries/connections/{token}/accounts', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200404

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "portfolio": "123e4567-e89b-12d3-a456-426614174000",
    "iban": "text",
    "type": "CASH_ACCOUNT",
    "alias": "text",
    "balance": 0,
    "currency": "EUR",
    "updatedAt": "2024-10-16T00:27:07.666Z",
    "createdAt": "2024-10-16T00:27:07.666Z",
    "owners": [
      "CARLOS MATA GARCIA",
      "OSCAR MENDEZ VALLADARES"
    ]
  }
]

Account types

You will find the following account types when using our API:

Type	Description
CASH_ACCOUNT*	Accounts which purpose is not strictly related to investing. They typically can have payments associated to them or other types of bank products.
OTHER	Accounts directly associated to portfolios. These accounts exist just to hold information about the liquidity in a portfolio. We only return these type of accounts when the entity is of type BROKER.

*Cash accounts are currently not returned unless you have a valid License with Banco de España. We are actively requesting ours and should be ready early 2025.