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.
Migration guide
Collections are now a top-level resource (from 2025-01-01)
In 2025-01-01 a wealth collection lived under the product namespace: it was created at POST /wealth/collection and read under /wealth/collection/{collectionId}/.... In 2026-04-01 collections become a single shared, top-level resource. A collection is created at POST /collections regardless of product, and the wealth data is read from a product sub-path — /collections/{collectionId}/wealth/data.
Endpoint mapping
2025-01-01 (wealth) | 2026-04-01 |
|---|---|
POST /wealth/collection | POST /collections (shared across products) |
GET /wealth/collection/{collectionId}/status | GET /collections/{collectionId}/status |
GET /wealth/collection/{collectionId}/data | GET /collections/{collectionId}/wealth/data |
POST /wealth/collection/{collectionId}/supplement-info | POST /collections/{collectionId}/supplement-info |
| — | GET /collections — new: list the collections for the authenticated user |
| — | POST /collections/{collectionId}/skip — new: skip a pending collection |
GET /companies/availability and GET /companies/supported-products are unchanged.
Typed request parameters
POST /collections replaces the 2025-01-01 request body — a loginMethod plus an input map keyed by uppercase strings, with separate top-level consents and filter fields — with a typed parameters array on InitiateCollectionRequest. Each entry carries a type discriminator and its own named fields. The German Wealth API defines:
- LoginMethodParameter — selects which login method the collector should trigger.
- SessionMetadataParameter — arbitrary key/value attributes used for correlation.
Additional input requested during a running collection is still supplied through POST /collections/{collectionId}/supplement-info when the collection status reports it is pending input.
Financial products are unchanged
The German financial product schemas — GermanDepotAccount and DePension — carry the same fields as in 2025-01-01, read from GET /collections/{collectionId}/wealth/data.
Collection statuses
AUTHENTICATION_ERROR and LOGIN_METHOD_NOT_APPLICABLE have been added to CollectionStatus. No statuses have been removed.