You're reading version 2025-01-01, which is not the latest. The latest is 2026-04-01: see this page in 2026-04-01.

Changelog

2026-11-16

Api-Version replaces Insurely-Version

  • The API version is now sent in the Api-Version header, for example Api-Version: 2026-04-01. It takes the same values as Insurely-Version and selects the version in the same way.
  • Insurely-Version keeps working for API versions up to and including 2026-04-01, so existing integrations do not need to change straight away.
  • Versions after 2026-04-01 accept only Api-Version. A request that sends Insurely-Version with a later version returns 400.
  • Send only one of the two headers. A request that sends both returns 400.

Action: rename the header to Api-Version in your requests. Nothing else about the request or the response changes.

2026-11-12

Changes made to BuyTransaction, SellTransaction, RedemptionTransaction and DividendTransaction

  • exchangeRate has been added. It is the exchange rate the bank used for the transaction, from the instrument's currency (the currency of dividendPerUnit on a dividend) to the currency of amount. For example 9.81 when a USD share is bought from a SEK account (1 USD = 9.81 SEK).

The field is absent when the provider does not supply a rate, and when the currencies are the same.

2026-11-11

Financial products

  • servicingBank has been added to the investment, pension, KF, general savings and loan products. Swedbank and the savings banks (sparbanker) share a platform, so a collection from se-swedbank can contain products from Swedbank as well as from one or more savings banks, depending on which banks the user is a customer of. servicingBank tells which bank the product comes from, for example { "id": "se-sparbanken-skane", "name": "Sparbanken Skåne" }. It is only populated for products collected from se-swedbank. The possible ids are listed on Wealth.ServicingBank. New ids can be added when savings banks join or merge, so don't treat the list as fixed.

2026-11-10

Changes made to TransactionInstrument

  • priceInInstrumentCurrency has been added. It is the price of the instrument in the currency it trades in, for example USD for a US share bought from a SEK account.

Changes made to DividendTransaction

  • quantity has been added. It is the number of units the dividend was paid on.
  • dividendPerUnit has been added. It is the dividend per unit, in the currency the dividend is declared in.

The new fields are absent when the provider does not supply them.

2026-10-29

Changes made to Holder

  • type has been added. It is PERSON or ORGANIZATION and tells whether a person or an organization owns the financial product. A sole proprietorship (enskild firma) is PERSON. The field is absent when the type could not be determined, and is currently only provided for capital insurances (KF).

2025-10-02

Changes made to FinancialProduct

2025-01-01

Changes made to endpoints

The endpoint to provide contact form input to a collection has been removed. Instead the contact form values should be provided as a CollectionInput to the /wealth/collection/{collectionId}/supplement-info endpoint.

Changes made to API responses

CollectionStatus

The status ACCOUNT_TEMPORARILY_LOCKED has been added. This status indicates that the end user's access has been temporarily blocked but will be able to access their data after some time. The exact time varies for different companies but a guideline would be to try again after 15 minutes.

Holding

ETF has been added as a possible type of holding.

TransactionInstrument

ETF has been added as a possible type of instrument.

Migration from Pension API

This section summarizes the Wealth API 2024-06-01 changelog to simplify a migration from the pension API to the Wealth API 2025-01-01.

Changes made to endpoints

  • The endpoint to initiate a wealth data collection has been renamed to POST /wealth/collection.
  • The endpoint for getting current status from a data collection has been renamed to GET /wealth/collection/{collectionId}/status.
  • The endpoint for getting wealth data from a collection has been renamed to GET /wealth/collection/{collectionId}/data.
  • The endpoint for adding supplemental information to the collection has been renamed to POST /wealth/collection/{collectionId}/supplement-info. The collectionId is now passed as a path parameter and the request body is SupplementInformation
  • The endpoint for adding contact form input to a collection has been renamed to POST /wealth/collection/{collectionId}/add-contact-form-input.
  • New endpoint" added for deleting collection data.

Changes made to CollectionStatus

  • The field insuranceCompany has been renamed to company.

  • The following changes has been made to the extraInformation field:

    • [REMOVED] DANISH_NEM_ID_CARD_CODE_LOOKUP: No longer used since NemID has been replaced by MitID in Denmark.
    • [REMOVED] AUTOSTART_TOKEN: The autostart token for Swedish mobile bankID is provided through SWEDISH_MOBILE_BANKID_AUTOSTART_TOKEN. The AUTOSTART_TOKEN value was a precompiled app-link with the redirect url already set.
    • [RENAMED] requiredInputTypes: Has been renamed to REQUIRED_INPUT_TYPES for consistency.
  • The following changes has been made to the status field:

    • Type has been changed from string to string enum. With this change the status names have changed to an enum format using underscore instead of space as delimiter, i.e. COMPLETED EMPTY is now COMPLETED_EMPTY.
    • [RENAMED] WAITING FOR AUTHENTICATION: Has been renamed to AUTHENTICATION_TIMEOUT to clarify the outcome of the authentication.
    • [ADDED] THIRD_PARTY_ERROR: Returned when the collection fails due to an error that we know is on the company's end, e.g. we encounter unexpected downtime.
    • [ADDED] WAITING_FOR_USER_ACTION: Returned when the user needs to take action in order for the authentication process to continue, e.g. signing in an authenticator app such as BankID in Sweden.

Migration guide from Pension API to Wealth API

  • This table provides an overview of the fields that have been changed, such as renamed, moved, deleted, or if there are no changes that have been made.
Old fieldNew fieldChanges
externalIdidRenamed
insuranceCompanycompanyRenamed
insuranceCompanyDisplayNamecompanyDisplayNameRenamed
insuranceNameproductNameRenamed
insuranceNumberproductNumberRenamed
pensionTypetypeRenamed
pensionClassificationclassificationRenamed
activePayoutactivePayoutNo changes
activePaymentactivePaymentNo changes
startDatestartDateNo changes
traditionallyManagedtraditionallyManagedNo changes
currentValuefinancialInformation.currentValueGrouped into ProductFinancialInformation and changed to MonetaryAmount
totalPaidfinancialInformation.totalDepositsGrouped into ProductFinancialInformation, changed to MonetaryAmount and renamed
feeFixedfees.feeFixedGrouped into Fees and changed to MonetaryAmount
feeVariablefees.feeVariableGrouped into Fees
feesCollectedfees.feesCollectedGrouped into Fees
feesPreviousYearfees.feesPreviousYearGrouped into Fees and changed to MonetaryAmount
holding[].isinholdings[].isinRenamed to holdings
holding[].nameholdings[].nameRenamed to holdings
holding[].currencyCodeDeleted
holding[].feeVariableholdings[].feeVariableRenamed to holdings
holding[].feeFixedDeleted
holding[].shareCountholdings[].quantityRenamed to holdings and quantity
holding[].valueholdings[].valueRenamed to holdings and changed to MonetaryAmount
holding[].valueInPercentDeleted
holdings[].typeNew field
holdings[].acquisitionValueNew field
hasSurvivorsProtectioninsurance.survivorsProtectionGrouped into Insurance and renamed
insuranceBeneficiaryNameDeleted
insuredPersonNameinsurance.insuredPersonNameGrouped into Insurance
movability.evaluatedRulesRemoved. The evaluatedRules array is no longer part of the Movability object. Only movability.result is returned.
movability.managementInstitutions[].namemanagementInstitutions[].nameMoved out of Movability. Previously only included when a pension is movable. Now included for all pensions of type COLLECTIVE_OCCUPATIONAL_PENSION with a known classification.
movability.managementInstitutions[].urlmanagementInstitutions[].urlMoved out of Movability. Previously only included when a pension is movable. Now included for all pensions of type COLLECTIVE_OCCUPATIONAL_PENSION with a known classification.
movability.resultmovability.resultNo changes
payoutDetails[].activepension.payoutDetails[].activeNo changes
payoutDetails[].amountpayoutDetails[].amountChanged to MonetaryAmount
payoutDetails[].lifelongPayoutpayoutDetails[].lifelongPayoutNo changes
payoutDetails[].period.startDatepayoutDetails[].period.startDateNo changes
payoutDetails[].period.endDatepayoutDetails[].period.endDateNo changes
payoutDetails[].period.startAgepayoutDetails[].period.startAgeNo changes
payoutDetails[].period.endAgepayoutDetails[].period.endAgeNo changes
payoutDetails[].period.typepayoutDetails[].period.typeNo changes
insuranceHolderNameholder.nameGrouped into Holder and renamed
organizationAlternatives[].orgCityDeleted
organizationAlternatives[].orgNameDeleted
organizationAlternatives[].orgNumberDeleted
organizationAlternatives[].orgTurnoverDeleted
organizationAlternatives[].organizationalInformation.cityholder.organizationSuggestions[].cityGrouped into Holder
organizationAlternatives[].organizationalInformation.nameholder.organizationSuggestions[].nameGrouped into Holder
organizationAlternatives[].organizationalInformation.organizationNumberholder.organizationSuggestions[].numberGrouped into Holder and renamed
organizationAlternatives[].organizationalInformation.financialInformation.employeeCountholder.organizationSuggestions[].financialInformation.employeeCountGrouped into Holder
organizationAlternatives[].organizationalInformation.financialInformation.netIncomeholder.organizationSuggestions[].financialInformation.netIncomeGrouped into Holder and changed to MonetaryAmount
organizationAlternatives[].organizationalInformation.financialInformation.shareCapitalholder.organizationSuggestions[].financialInformation.shareCapitalGrouped into Holder
organizationAlternatives[].organizationalInformation.financialInformation.timePeriodholder.organizationSuggestions[].financialInformation.financialPeriodGrouped into Holder and renamed
organizationAlternatives[].organizationalInformation.financialInformation.turnoverholder.organizationSuggestions[].financialInformation.turnoverGrouped into Holder and changed to MonetaryAmount
insuranceHolderOrgNumberDeleted
insuranceHolderOrgTurnoverDeleted
insuranceHolderOrganization.cityholder.organization.cityGrouped into Holder
insuranceHolderOrganization.nameholder.organization.nameGrouped into Holder
insuranceHolderOrganization.organizationalNumberholder.organization.numberGrouped into Holder and renamed
insuranceHolderOrganization.financialInformation.employeeCountholder.organization.financialInformation.employeeCountGrouped into Holder
insuranceHolderOrganization.financialInformation.netIncomeholder.organization.financialInformation.netIncomeGrouped into Holder and changed to MonetaryAmount
insuranceHolderOrganization.financialInformation.shareCapitalholder.organization.financialInformation.shareCapitalGrouped into Holder
insuranceHolderOrganization.financialInformation.timePeriodholder.organization.financialInformation.financialPeriodGrouped into Holder and renamed
insuranceHolderOrganization.financialInformation.turnoverholder.organization.financialInformation.turnoverGrouped into Holder and changed to MonetaryAmount

New fields for investment products

  • New field performanceSinceStart in ProductFinancialInformation, containing performance of the portfolio as a percentage.
  • New field cashValue in AccountInformation, containing the value of cash holdings.
  • New field interestRate in AccountInformation, containing the interest rate of the cash account.
  • New field cashAccountNumber in AccountInformation, containing account number of cash account.
  • New field hasExclusiveOwnership in AccountInformation. This flag indicates whether or not the current user is the sole owner and proprietor of an ISK or CustodyAccount or not.
  • New field marketIdentifierCode added to holdings of type EQUITY.
  • New field transactions with a list of Transaction objects added to ISK accounts, custody accounts, and unknonwn savings accounts.
  • New field monthlySavingsAmount, containing monthly savings amount associated with the financial product.