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-04-01
Collections API
- Collections are now a top-level
/collectionsresource (breaking) — collection endpoints no longer live under the product namespace.POST /wealth/collectionbecomesPOST /collections(shared across products), and the wealth data is read fromGET /collections/{collectionId}/wealth/data. See the migration guide for the full endpoint mapping. - Typed request parameters (breaking) — the untyped
inputmap, together with the top-levelconsentsandfilterfields, is replaced by a typedparametersarray on InitiateCollectionRequest. Each entry carries atypediscriminator; the German Wealth API defines LoginMethodParameter and SessionMetadataParameter. - GET /collections has been added, returning all collections for the authenticated user within the client scope.
- POST /collections/{collectionId}/skip has been added, allowing a pending collection to be skipped.
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 requestedloginMethodcannot be used for the company.
Changes made to DePension
- New field
continuousRequestAvailableon 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,accumulatedCapitalandhousingPromotionBalance(Wohnförderkonto). Cumulative amounts are as ofstatementDate; 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).