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.

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-04-01

Collections API

Changes made to CollectionStatus

The following statuses have been added. No statuses have been removed.

  • AUTHENTICATION_ERROR — returned when authentication fails for a reason other than incorrect credentials.
  • LOGIN_METHOD_NOT_APPLICABLE — returned when the requested loginMethod cannot be used for the company.

Changes made to DePension

  • New field continuousRequestAvailable on De.StateAllowance — whether a continuous allowance request (Dauerzulageantrag) is available on the contract, as reported by the provider.
  • New object De.AnnualCertificate on annualCertificate — figures from the latest annual certificate under § 92 EStG: statementDate, contractNumber, allowanceNumber (Zulagenummer), totalContributions, totalAllowances, accumulatedCapital and housingPromotionBalance (Wohnförderkonto). Cumulative amounts are as of statementDate; fields are absent when the provider's annual statement is unavailable.

2025-01-01

Initial release of the Wealth API for Germany, covering German custody depots (GermanDepotAccount) and German pensions (DePension) including Riester classification and state allowances (Zulagen).