This is a preview version of the API intended for early testing and integration. Preview versions are not stable and may include breaking changes before general availability.

Stocks and Shares ISA

A Stocks and Shares ISA for tax-efficient investing in the UK market.

accountInformationAccountInformation

Account details such as available balance and interest rate.

companystring

Company where the financial product has been collected from. Examples: se-folksam, se-lansforsakringar, se-avanza, se-movestic, se-spp, se-nordea, se-amf, se-seb, se-alecta, se-nordnet, se-handelsbanken, se-futur, se-swedbank, se-skandia, se-ica-bank, se-danske-bank.

companyDisplayNamestring

Display name of the company for user-friendly presentation.

financialInformationProductFinancialInformation

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

holderHolder

Information about the owner of the financial product.

holdingsArray<Wealth.Holding>

List of holdings within the ISA.

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.

monthlySavingsAmountMonetaryAmount

Monthly savings amount associated with the financial product.

personalInformationPersonalInformation

Personal information about the person who initiated the data collection.

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.

typestring

Type of the financial product.

Possible Enum values are GIA, STOCK_AND_SHARE_ISA, CASH_ISA, SELF_INVESTED_PERSONAL_PENSION, LIFETIME_ISA, FIXED_RATE_ISA or UK_OCCUPATIONAL_PENSION.

Example

{
  "accountInformation": {
    "cashAccountNumber": "123456789",
    "cashValue": {},
    "hasExclusiveOwnership": true,
    "interestRate": 0.0375
  },
  "company": "se-company",
  "companyDisplayName": "Company",
  "financialInformation": {
    "currentValue": {},
    "performanceSinceStart": 0.2533,
    "totalDeposits": {}
  },
  "holder": {
    "name": "Bolagsnamn AB",
    "organization": {},
    "organizationSuggestions": {}
  },
  "holdings": [],
  "id": "6a7c135e-3a56-44ae-bc53-1d0d5321f552",
  "monthlySavingsAmount": {
    "amount": 10.32,
    "currency": "EUR"
  },
  "personalInformation": {
    "personalNumber": "199001011234"
  },
  "productName": "Stocks and Shares ISA",
  "productNumber": "ISA-987654321",
  "transactions": [],
  "type": "ISK"
}

{  "accountInformation": {    "cashAccountNumber": "123456789",    "cashValue": {},    "hasExclusiveOwnership": true,    "interestRate": 0.0375  },  "company": "se-company",  "companyDisplayName": "Company",  "financialInformation": {    "currentValue": {},    "performanceSinceStart": 0.2533,    "totalDeposits": {}  },  "holder": {    "name": "Bolagsnamn AB",    "organization": {},    "organizationSuggestions": {}  },  "holdings": [],  "id": "6a7c135e-3a56-44ae-bc53-1d0d5321f552",  "monthlySavingsAmount": {    "amount": 10.32,    "currency": "EUR"  },  "personalInformation": {    "personalNumber": "199001011234"  },  "productName": "Stocks and Shares ISA",  "productNumber": "ISA-987654321",  "transactions": [],  "type": "ISK"}