Changelog

2025-10-02

GeneralSavingsAccount has been added as a possible type of financial product.
GeneralSavingsAccountFixedPeriod has been added as a possible type of financial product.

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 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[].result`	`movability.evaluatedRules[].result`	No changes
`movability.evaluatedRules[].rule`	`movability.evaluatedRules[].rule`	No changes
`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 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.