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.

German Pension

German Pension. Example: DE_PENSION

activePaymentboolean

Whether contributions are currently being paid into the pension.

activePayoutboolean

Whether the pension is currently being paid out.

ageAtEndOfSavingsPeriodinteger[int32]

Age of the policy holder at the end of the savings period.

agreedRegularContributionMonetaryAmount

The agreed regular contribution.

classificationstring

Classification of the pension.

Possible Enum values are RIESTER, BAV, ALTERSVORSORGE, ALTERSVORSORGEDEPOT or GENERIC.

companystring

Company where the financial product has been collected from. Example: de-rv-versicherung.

companyDisplayNamestring

Display name of the company for user-friendly presentation.

contractNumberstring

Contract number assigned by the provider.

contributionsMadeCurrentYearMonetaryAmount

Contributions made during the current year.

dataSourcestring

Indicates how the account data was obtained. AUTOMATIC means the data was collected via an aggregator connection. MANUAL means the account was added manually by the user. Defaults to AUTOMATIC.

Possible Enum values are AUTOMATIC or MANUAL.

financialInformationDe.ProductFinancialInformation

holdingsArray<Wealth.Holding>

List of holdings within the pension.

idstring

Insurely-generated unique identifier for this collection of the financial product. Randomly generated and not stable across collections — a new id is issued each time the product is collected, even for the same underlying account. Use this only as a handle within a single collection (e.g., to correlate holdings and transactions). Do not use it to recognize the same product over time; use the stable institution-assigned identifier on this product (e.g., productNumber, accountNumber, or loanId) for that.

policyHolderNamestring

Name of the policy holder.

premiumGuaranteeMonetaryAmount

The guaranteed minimum value at the end of the savings period.

productNamestring

Name of the pension product.

productNumberstring

The product number assigned by the source financial institution (e.g., ISK account number, policy number, mortgage number). This is the most stable identifier for the product over time and across collections, and is suitable for matching the same product between repeated collections. Note that stability is best-effort and depends on what the institution exposes; it may occasionally change if the institution restructures or reissues the product.

startDatestring

Start date of the pension contract.

stateAllowanceDe.StateAllowance

transactionsArray<Transaction>

Transactions on the pension over the last 12 months.

typestring

Type of the financial product.

Possible Enum values are DEPOT_ACCOUNT or DE_PENSION.

Example

{
  "activePayment": true,
  "activePayout": false,
  "ageAtEndOfSavingsPeriod": 67,
  "agreedRegularContribution": {
    "amount": 175,
    "currency": "EUR"
  },
  "classification": "RIESTER",
  "company": "de-rv-versicherung",
  "contractNumber": "1234567890",
  "contributionsMadeCurrentYear": {
    "amount": 2100,
    "currency": "EUR"
  },
  "financialInformation": {
    "changeValue": {
      "amount": 320.24,
      "currency": "EUR"
    },
    "currentValue": {
      "amount": 17402.02,
      "currency": "EUR"
    }
  },
  "holdings": [
    {
      "isin": "IE00B4L5Y983",
      "name": "iShares Core MSCI World UCITS ETF",
      "quantity": 54.076858,
      "type": "ETF",
      "value": {
        "amount": 22468.39,
        "currency": "EUR"
      }
    }
  ],
  "id": "b4c1ec96-182b-4533-98e1-7060d9643928",
  "policyHolderName": "Max Mustermann",
  "premiumGuarantee": {
    "amount": 12000,
    "currency": "EUR"
  },
  "productName": "RiesterRente Klassik",
  "productNumber": "PRM00321-1131",
  "startDate": "2021-06-15",
  "stateAllowance": {
    "base": {
      "amount": 175,
      "currency": "EUR"
    },
    "child": {
      "amount": 300,
      "currency": "EUR"
    },
    "nonRecurringExtra": {
      "amount": 0,
      "currency": "EUR"
    },
    "receivedCurrentYear": {
      "amount": 475,
      "currency": "EUR"
    }
  },
  "transactions": [
    {
      "amount": {
        "amount": 175,
        "currency": "EUR"
      },
      "description": "Beitrag",
      "settlementDate": "2024-01-01",
      "type": "DEPOSIT"
    }
  ],
  "type": "DE_PENSION"
}

{  "activePayment": true,  "activePayout": false,  "ageAtEndOfSavingsPeriod": 67,  "agreedRegularContribution": {    "amount": 175,    "currency": "EUR"  },  "classification": "RIESTER",  "company": "de-rv-versicherung",  "contractNumber": "1234567890",  "contributionsMadeCurrentYear": {    "amount": 2100,    "currency": "EUR"  },  "financialInformation": {    "changeValue": {      "amount": 320.24,      "currency": "EUR"    },    "currentValue": {      "amount": 17402.02,      "currency": "EUR"    }  },  "holdings": [    {      "isin": "IE00B4L5Y983",      "name": "iShares Core MSCI World UCITS ETF",      "quantity": 54.076858,      "type": "ETF",      "value": {        "amount": 22468.39,        "currency": "EUR"      }    }  ],  "id": "b4c1ec96-182b-4533-98e1-7060d9643928",  "policyHolderName": "Max Mustermann",  "premiumGuarantee": {    "amount": 12000,    "currency": "EUR"  },  "productName": "RiesterRente Klassik",  "productNumber": "PRM00321-1131",  "startDate": "2021-06-15",  "stateAllowance": {    "base": {      "amount": 175,      "currency": "EUR"    },    "child": {      "amount": 300,      "currency": "EUR"    },    "nonRecurringExtra": {      "amount": 0,      "currency": "EUR"    },    "receivedCurrentYear": {      "amount": 475,      "currency": "EUR"    }  },  "transactions": [    {      "amount": {        "amount": 175,        "currency": "EUR"      },      "description": "Beitrag",      "settlementDate": "2024-01-01",      "type": "DEPOSIT"    }  ],  "type": "DE_PENSION"}