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-Versionheader, for exampleApi-Version: 2026-04-01. It takes the same values asInsurely-Versionand selects the version in the same way. Insurely-Versionkeeps working for API versions up to and including2026-04-01, so existing integrations do not need to change straight away.- Versions after
2026-04-01accept onlyApi-Version. A request that sendsInsurely-Versionwith a later version returns400. - 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
exchangeRatehas been added. It is the exchange rate the bank used for the transaction, from the instrument's currency (the currency ofdividendPerUniton a dividend) to the currency ofamount. For example9.81when 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
servicingBankhas been added to the investment, pension, KF, general savings and loan products. Swedbank and the savings banks (sparbanker) share a platform, so a collection fromse-swedbankcan contain products from Swedbank as well as from one or more savings banks, depending on which banks the user is a customer of.servicingBanktells which bank the product comes from, for example{ "id": "se-sparbanken-skane", "name": "Sparbanken Skåne" }. It is only populated for products collected fromse-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
priceInInstrumentCurrencyhas 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
quantityhas been added. It is the number of units the dividend was paid on.dividendPerUnithas 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
typehas been added. It isPERSONorORGANIZATIONand tells whether a person or an organization owns the financial product. A sole proprietorship (enskild firma) isPERSON. 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
- GeneralSavingsAccount has been added as a possible type of financial product.
- GeneralSavingsAccountFixedPeriod has been added as a possible type of financial product.
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
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.
ETF has been added as a possible type of holding.
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
insuranceCompanyhas been renamed tocompany. -
The following changes has been made to the
extraInformationfield:- [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 throughSWEDISH_MOBILE_BANKID_AUTOSTART_TOKEN. TheAUTOSTART_TOKENvalue was a precompiled app-link with the redirect url already set. - [RENAMED]
requiredInputTypes: Has been renamed toREQUIRED_INPUT_TYPESfor consistency.
- [REMOVED]
-
The following changes has been made to the
statusfield:- 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 EMPTYis nowCOMPLETED_EMPTY. - [RENAMED]
WAITING FOR AUTHENTICATION: Has been renamed toAUTHENTICATION_TIMEOUTto 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.
- 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.
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 field | New field | Changes |
|---|---|---|
externalId | id | Renamed |
insuranceCompany | company | Renamed |
insuranceCompanyDisplayName | companyDisplayName | Renamed |
insuranceName | productName | Renamed |
insuranceNumber | productNumber | Renamed |
pensionType | type | Renamed |
pensionClassification | classification | Renamed |
activePayout | activePayout | No changes |
activePayment | activePayment | No changes |
startDate | startDate | No changes |
traditionallyManaged | traditionallyManaged | No changes |
currentValue | financialInformation.currentValue | Grouped into ProductFinancialInformation and changed to MonetaryAmount |
totalPaid | financialInformation.totalDeposits | Grouped into ProductFinancialInformation, changed to MonetaryAmount and renamed |
feeFixed | fees.feeFixed | Grouped into Fees and changed to MonetaryAmount |
feeVariable | fees.feeVariable | Grouped into Fees |
feesCollected | fees.feesCollected | Grouped into Fees |
feesPreviousYear | fees.feesPreviousYear | Grouped into Fees and changed to MonetaryAmount |
holding[].isin | holdings[].isin | Renamed to holdings |
holding[].name | holdings[].name | Renamed to holdings |
holding[].currencyCode | Deleted | |
holding[].feeVariable | holdings[].feeVariable | Renamed to holdings |
holding[].feeFixed | Deleted | |
holding[].shareCount | holdings[].quantity | Renamed to holdings and quantity |
holding[].value | holdings[].value | Renamed to holdings and changed to MonetaryAmount |
holding[].valueInPercent | Deleted | |
holdings[].type | New field | |
holdings[].acquisitionValue | New field | |
hasSurvivorsProtection | insurance.survivorsProtection | Grouped into Insurance and renamed |
insuranceBeneficiaryName | Deleted | |
insuredPersonName | insurance.insuredPersonName | Grouped into Insurance |
movability.evaluatedRules | Removed. The evaluatedRules array is no longer part of the Movability object. Only movability.result is returned. | |
movability.managementInstitutions[].name | managementInstitutions[].name | Moved 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[].url | managementInstitutions[].url | Moved 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.result | movability.result | No changes |
payoutDetails[].active | pension.payoutDetails[].active | No changes |
payoutDetails[].amount | payoutDetails[].amount | Changed to MonetaryAmount |
payoutDetails[].lifelongPayout | payoutDetails[].lifelongPayout | No changes |
payoutDetails[].period.startDate | payoutDetails[].period.startDate | No changes |
payoutDetails[].period.endDate | payoutDetails[].period.endDate | No changes |
payoutDetails[].period.startAge | payoutDetails[].period.startAge | No changes |
payoutDetails[].period.endAge | payoutDetails[].period.endAge | No changes |
payoutDetails[].period.type | payoutDetails[].period.type | No changes |
insuranceHolderName | holder.name | Grouped into Holder and renamed |
organizationAlternatives[].orgCity | Deleted | |
organizationAlternatives[].orgName | Deleted | |
organizationAlternatives[].orgNumber | Deleted | |
organizationAlternatives[].orgTurnover | Deleted | |
organizationAlternatives[].organizationalInformation.city | holder.organizationSuggestions[].city | Grouped into Holder |
organizationAlternatives[].organizationalInformation.name | holder.organizationSuggestions[].name | Grouped into Holder |
organizationAlternatives[].organizationalInformation.organizationNumber | holder.organizationSuggestions[].number | Grouped into Holder and renamed |
organizationAlternatives[].organizationalInformation.financialInformation.employeeCount | holder.organizationSuggestions[].financialInformation.employeeCount | Grouped into Holder |
organizationAlternatives[].organizationalInformation.financialInformation.netIncome | holder.organizationSuggestions[].financialInformation.netIncome | Grouped into Holder and changed to MonetaryAmount |
organizationAlternatives[].organizationalInformation.financialInformation.shareCapital | holder.organizationSuggestions[].financialInformation.shareCapital | Grouped into Holder |
organizationAlternatives[].organizationalInformation.financialInformation.timePeriod | holder.organizationSuggestions[].financialInformation.financialPeriod | Grouped into Holder and renamed |
organizationAlternatives[].organizationalInformation.financialInformation.turnover | holder.organizationSuggestions[].financialInformation.turnover | Grouped into Holder and changed to MonetaryAmount |
insuranceHolderOrgNumber | Deleted | |
insuranceHolderOrgTurnover | Deleted | |
insuranceHolderOrganization.city | holder.organization.city | Grouped into Holder |
insuranceHolderOrganization.name | holder.organization.name | Grouped into Holder |
insuranceHolderOrganization.organizationalNumber | holder.organization.number | Grouped into Holder and renamed |
insuranceHolderOrganization.financialInformation.employeeCount | holder.organization.financialInformation.employeeCount | Grouped into Holder |
insuranceHolderOrganization.financialInformation.netIncome | holder.organization.financialInformation.netIncome | Grouped into Holder and changed to MonetaryAmount |
insuranceHolderOrganization.financialInformation.shareCapital | holder.organization.financialInformation.shareCapital | Grouped into Holder |
insuranceHolderOrganization.financialInformation.timePeriod | holder.organization.financialInformation.financialPeriod | Grouped into Holder and renamed |
insuranceHolderOrganization.financialInformation.turnover | holder.organization.financialInformation.turnover | Grouped into Holder and changed to MonetaryAmount |
New fields for investment products
- New field
performanceSinceStartin ProductFinancialInformation, containing performance of the portfolio as a percentage. - New field
cashValuein AccountInformation, containing the value of cash holdings. - New field
interestRatein AccountInformation, containing the interest rate of the cash account. - New field
cashAccountNumberin AccountInformation, containing account number of cash account. - New field
hasExclusiveOwnershipin 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
marketIdentifierCodeadded to holdings of typeEQUITY. - New field
transactionswith 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.