Skip to navigation
Fetching the resultsFinancial Data

Investment accounts

View as Markdown

Securities accounts — the wrappers your customer’s investments sit in.

Each one carries its identifiers, its currency and its valuation, and is the parent the stocks, funds and pension plans of the same execution hang from. Field by field in Investments.

This endpoint returns the containers, not the holdings. What is inside them comes from Stocks, Funds and Pension plans, each behind its own feature — asking for the accounts alone gives you the wrappers and nothing in them.

Requires the investment_accounts_read feature

Features are chosen when the execution starts, not here. An execution that did not ask for investment_accounts_read answers 204, and the only way to get the data is to run another one.

StatusMeaning
200The investment accounts.
202feature_not_ready — investment_accounts_read is still running. Only this family waits: the ones that already closed answer now.
204The execution never asked for investment_accounts_read. No body.
404No execution with that id for your application, or it has been deleted.

Server to server only. This call is authorised with your application secret: it belongs in your backend, never in a browser, a mobile app or anything your customer can read.

Authentication

X-APP-SECRETstring
Application Secret

Path parameters

execution_idstringRequiredformat: "object-id"
The execution, as the acceptance response returned it.

Response

200 OK
The securities accounts themselves — the containers. What is held inside them is read from stocks, funds and pension plans, each with its own feature.

An empty list is an answer, not a gap: the feature ran and the source reported none.

idstringformat: "object-id"

Product ID for the current execution. Note: it may change between executions.

product"financial_account"
sub_family"financial_account:investments"
fetch_datestringformat: "datetime"
Date this product was fetched
data_enrichmentenum
Data enrichment status. Indicates whether the product has been enriched with additional data. If not, the product will be filled with generic data.
Allowed values:
identifierobject
Account identifier
customer_segmentenum
product_namestring
Product name
product_aliasstringOptional
Product alias
product_descriptionstringOptional
Product Description
opening_datedateOptional
Account opening date
valuation_datedateOptional
Valuation date
valuationobjectOptional

Valuation of the assets held in the account. (Deprecated, use balance instead)

appreciationobjectOptional
Monetary appreciation of the assets held in the account
performanceobjectOptional
Account performance

Errors

404
Not Found Error
422
Unprocessable Entity Error