The Investments product will be retired on April 30, 2026. New integrations are not supported, and existing integrations will stop working after this date.
On this page, you will find a breakdown of Response Fields for Institution, Account, Positions, Transactions, and Security.
A single institution may have one or many accounts contained within it to it. The fields within this object give an understanding of the overall state of that particular account at a given period of time.
NAME
DESCRIPTION
SCHEMA
Id
A unique identifier for the investment account within the Flinks system.
string
FullAccountId
Full account information (as presented by the financial institution) associated with this specific investment account. Normally includes name of account, account ID, and currency.
string
AccountId
Cleansed account ID/number associated with this specific investment account. Can be used for account transfer purposes.
string
Name
Name of the investment.
string
Type
The investment account type. An investment may be reported as type unknown for some special investment accounts or when the institution does not provide sufficient information.
The positions show the composition of the individual securities (types of investment products) within each account and how those securities have changed in value over time.
NAME
DESCRIPTION
SCHEMA
Id
A unique identifier for the position within the Flinks system.
The transactions object contains a series of actions and events that occurred in order to construct the portfolio. You can think of this as an activity log or the story of how your end user got to where they are today.
NAME
DESCRIPTION
SCHEMA
Id
ID of the transaction within the Flinks system.
string
Date
The date when the transaction occurred.
timestamp
Type
The transaction type (deposit, withdrawal, transfer, interest, dividend, distribution, roc, reinvest, tax, fee, sell, buy, income, unknown).
enum
Description
The transaction description. This is taken from the institution’s website.
string
Amount
The transaction amount, converted to the account settlement currency.
decimal
Quantity
The quantity of securities involved in the transaction.
