Response Fields

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.

Institution

The identifying information of the institution that you’re connecting to in order to retrieve investment data.

NAME	DESCRIPTION	SCHEMA
Name	Name of the institution.	string
Id	Unique identifier for the institution within the Flinks system.	string
Accounts	See below	n/a

Account

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.	enum (cash, chequing, tfsa, rrsp, fhsa, resp, rdsp, margin, short, long, lira, lrsp, rlsp, rrif, lif, lrif, prif, rpp, ipp, dpsp, spp, ndcp, nrsp, epsp, espp, esop, vrsp, unknown)
Registered	Whether or not this is a registered account.	boolean
Currency	The investment account settlement currency.	enum (aud, btc, cad, chf, cny, dkk, eur, gbp, hkd, inr, jpy, mxn, nok, nzd, sek, sgd, twd, usd, vnd)
Cash	The amount of cash in the investment account, in the account settlement currency.	decimal
AccountValue	The value of the account including cash and securities at market value.	decimal
CurrencyValue	The value of the account in the account currency including cash and securities at market value.	decimal
Positions	See below	n/a
Transactions	See below	n/a

Positions

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.	string
Category	The position category.	string
Class	The position class.	enum (equity, fixed_income, cash_equivalent, tangible_asset, other)
BookValue	The book value of the position (the acquisition price).	decimal
Quantity	The quantity of the security in the position.	decimal
MarketValue	The market value of the position, in the security’s currency.	decimal
GainAmount	The current gain amount of the position, in the security’s currency.	decimal
GainCurrencyAmount	The current gain amount in the account currency of the position.	decimal
GainPercent	The current gain percent of the position.	decimal
Currency	The investment account currency.	string
SecurityId	See below	string

Transactions

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.	decimal
Fee	Transaction fee amount, if applicable.	decimal
SecurityId	Related Security object.	string

Security

The security object contains descriptive information about the underlying asset of the portfolio.

NAME	DESCRIPTION	SCHEMA
Id	ID of the security within the Flinks system.	string
Name	Name of the security.	string
ISIN	A 12-character globally unique securities identifier.	string (null if not matched)
CUSIP	A 9-character identifier for North American securities.	string (null if not matched)
Currency	The currency in which the security is denominated.	string
Price	The price of the security at the associated date.	decimal
Date	The date and time the price was updated.	datetime
Type	The security type.	string
Symbol	Ticker symbol of the security.	string
Aliases	Alternative names for the security.	string

API Reference

Auth

Connect

Enrich

Outbound

Pay

Upload

Utilities

Institution

Account

Positions

Transactions

Security

​Institution

​Account

​Positions

​Transactions

​Security

Institution

Account

Positions

Transactions

Security