Objects

CTO

French Securities Account (CTO)

accountInformationFrench.AccountInformation

Account details such as available balance and interest rate.

changeValueMonetaryAmount

Change in value since previous period.

companystring

Company where the financial product has been collected from. Examples: fr-hello-bank.

companyDisplayNamestring

Display name of the company for user-friendly presentation.

Financial details of the product, like value, performance etc.

Information about the owner of the financial product.

List of holdings within the financial product.

idstring

Insurely-generated unique identifier for this collection of the financial product. Randomly generated and not stable across collections — a new id is issued each time the product is collected, even for the same underlying account. Use this only as a handle within a single collection (e.g., to correlate holdings and transactions). Do not use it to recognize the same product over time; use the stable institution-assigned identifier on this product (e.g., productNumber, accountNumber, or loanId) for that.

productNamestring

Name of the financial product.

productNumberstring

The product number assigned by the source financial institution (e.g., ISK account number, policy number, mortgage number). This is the most stable identifier for the product over time and across collections, and is suitable for matching the same product between repeated collections. Note that stability is best-effort and depends on what the institution exposes; it may occasionally change if the institution restructures or reissues the product.

transactionsArray<Transaction>

Transaction history for the last 12 months.

startDatestring

Contract start date (format YYYY-MM-DD)

dataSourcestring

Indicates how the account data was obtained. AUTOMATIC means the data was collected via an aggregator connection. MANUAL means the account was added manually by the user. Defaults to AUTOMATIC.

Possible Enum values are AUTOMATIC or MANUAL.
typestring

Type of the financial product.

Possible Enum values are CTO.
Example
{  "accountInformation": {    "cashValue": {      "amount": 4514.27,      "currency": "EUR"    },    "interestRate": 0.0025,    "cashAccountNumber": "FR1234567"  },  "company": "fr-hello-bank",  "companyDisplayName": "Hello Bank",  "financialInformation": {    "currentValue": {      "amount": 26982.66,      "currency": "EUR"    }  },  "changeValue": {    "currency": "EUR",    "amount": 150.25  },  "holder": {    "name": "Jean Dupont"  },  "holdings": [    {      "isin": "FR0010315770",      "name": "AMUNDI ETF CAC 40",      "quantity": 54.076858,      "type": "FUND",      "value": {        "amount": 22468.39,        "currency": "EUR"      },      "acquisitionValue": {        "amount": 18883.51,        "currency": "EUR"      }    }  ],  "transactions": [    {      "amount": {        "amount": 10.32,        "currency": "EUR"      },      "description": "Versement",      "settlementDate": "2024-01-01",      "type": "DEPOSIT"    }  ],  "id": "df2e7a28-d871-45c1-a01e-515b7aeaf7da",  "productName": "Mon Compte Titres",  "productNumber": "FR987654321",  "type": "CTO"}