{
"components": {
"schemas": {
"AffordabilityAmountTti": {
"properties": {
"amount": {
"description": "Total amount",
"examples": [
19.89,
-34.51
],
"title": "Amount",
"type": "number"
},
"tagTreeItem": {
"$ref": "#/components/schemas/TagTreeItem",
"description": "Expected average monthly income/expenses based on irregular/regular transactions for each tag tree item."
}
},
"required": [
"amount",
"tagTreeItem"
],
"title": "AffordabilityAmountTti",
"type": "object"
},
"AffordabilityExpenses": {
"properties": {
"amount": {
"description": "Total amount",
"examples": [
-34.4,
-146.34
],
"title": "Amount",
"type": "number"
},
"luxuries": {
"anyOf": [
{
"$ref": "#/components/schemas/AffordabilityRegularIrregular"
},
{
"type": "null"
}
],
"description": "Expected average monthly expenses for luxuries based on regularly recurring payments including contract payments (e.g. for streaming services) and irregular payments (e.g. travel costs)."
},
"necessities": {
"anyOf": [
{
"$ref": "#/components/schemas/AffordabilityRegularIrregular"
},
{
"type": "null"
}
],
"description": "Expected average monthly expenses for necessities based on regularly recurring payments including contract payments and irregular payments for living costs such as groceries."
}
},
"required": [
"amount"
],
"title": "AffordabilityExpenses",
"type": "object"
},
"AffordabilityRegularIrregular": {
"properties": {
"amount": {
"description": "Total amount",
"examples": [
24.7,
-58.91
],
"title": "Amount",
"type": "number"
},
"irregular": {
"anyOf": [
{
"$ref": "#/components/schemas/AffordabilityRegularOrIrregular"
},
{
"type": "null"
}
],
"description": "Expected average monthly expenses for luxuries based on regularly recurring payments including contract payments (e.g. for streaming services) and irregular payments (e.g. travel costs)."
},
"regular": {
"anyOf": [
{
"$ref": "#/components/schemas/AffordabilityRegularOrIrregular"
},
{
"type": "null"
}
],
"description": "Expected average monthly expenses for necessities based on regularly recurring payments including contract payments and irregular payments for living costs such as groceries."
}
},
"required": [
"amount"
],
"title": "AffordabilityRegularIrregular",
"type": "object"
},
"AffordabilityRegularOrIrregular": {
"properties": {
"amount": {
"description": "Total amount",
"examples": [
56.11,
-12.99
],
"title": "Amount",
"type": "number"
},
"amountsPerTagTreeItem": {
"description": "Expected average monthly income/expenses based on irregularl/regular transactions for each tag tree item.",
"items": {
"$ref": "#/components/schemas/AffordabilityAmountTti"
},
"title": "Amountspertagtreeitem",
"type": "array"
}
},
"required": [
"amount",
"amountsPerTagTreeItem"
],
"title": "AffordabilityRegularOrIrregular",
"type": "object"
},
"AffordabilityTagInstance": {
"properties": {
"details": {
"anyOf": [
{
"$ref": "#/components/schemas/AffordabilityTagInstanceDetails"
},
{
"type": "null"
}
]
},
"entity": {
"$ref": "#/components/schemas/Entity"
},
"id": {
"description": "Unique Universal Identifier (UUID)",
"examples": [
"956ca508-c0e2-52c5-3202-8de20e7ed12b",
"1728219d-383c-48af-a8c7-f31ea61381df"
],
"title": "Id",
"type": "string"
},
"relations": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/Relation"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "List of relations",
"title": "Relations"
},
"tagTreeItem": {
"$ref": "#/components/schemas/TagTreeItem"
}
},
"required": [
"id",
"tagTreeItem",
"entity"
],
"title": "AffordabilityTagInstance",
"type": "object"
},
"AffordabilityTagInstanceDetails": {
"properties": {
"creditCards": {
"description": "Number of existing credit cards.",
"examples": [
3,
0,
1
],
"minimum": 0.0,
"title": "Creditcards",
"type": "integer"
},
"debtCollectionPayments": {
"description": "Whether reminder charges transactions exist in the recent past.",
"examples": [
false,
true
],
"title": "Debtcollectionpayments",
"type": "boolean"
},
"discretionary": {
"description": "Expected amount available monthly to spend on luxuries. Calculation based on expected necessity expenses and expected income.",
"examples": [
459.4,
2402.29
],
"title": "Discretionary",
"type": "number"
},
"discretionaryForIrregularLuxuries": {
"description": "Expected amount available monthly to spend on luxuries besides existing regularly recurring expenses including contracts. Calculation based on expected necessity expenses and income (discretionary) as well as expected regularly recurring expenses for luxury including contracts.",
"examples": [
345.36,
964.12
],
"title": "Discretionaryforirregularluxuries",
"type": "number"
},
"existingLoans": {
"description": "Whether active loans exist or not.",
"examples": [
false,
true
],
"title": "Existingloans",
"type": "boolean"
},
"expenses": {
"anyOf": [
{
"$ref": "#/components/schemas/AffordabilityExpenses"
},
{
"type": "null"
}
],
"description": "Expected average monthly expenses."
},
"financialLiteracy": {
"description": "The user has knowledge of various financial skills. Computation takes, among other things, the number of banking products, investments and insurances into account.",
"examples": [
"neutral",
"high",
"low"
],
"title": "Financialliteracy",
"type": "string"
},
"gambling": {
"description": "Expected amount spend for gambling activities.",
"examples": [
34.4,
0.0
],
"minimum": 0.0,
"title": "Gambling",
"type": "number"
},
"income": {
"anyOf": [
{
"$ref": "#/components/schemas/AffordabilityRegularIrregular"
},
{
"type": "null"
}
],
"description": "Expected average monthly income."
},
"mortgagePayments": {
"description": "Whether at least one transaction related to a mortgage in the recent past exists or not.",
"examples": [
false,
true
],
"title": "Mortgagepayments",
"type": "boolean"
},
"mostRecentRentalPayment": {
"anyOf": [
{
"format": "date",
"type": "string"
},
{
"type": "null"
}
],
"description": "Date of the most recent rental payment of an active rental contract. Returned if rentalPayments is True.",
"examples": [
"2024-05-01",
"2023-12-02"
],
"title": "Mostrecentrentalpayment"
},
"ratioExpensesToIncome": {
"description": "Ratio of expenses to income.",
"examples": [
0.8,
1.18,
0.97
],
"minimum": 0.0,
"title": "Ratioexpensestoincome",
"type": "number"
},
"ratioGamblingToDiscretionaryForIrregularLuxuries": {
"description": "Ratio of gambling expenses to discretionary for irregular luxuries. Regular gambling expenses are currently included in the computation of discretionary for irregular luxuries here. This might lead to a low ratio even though gambling expenses are high.",
"examples": [
0.27,
0.21
],
"title": "Ratiogamblingtodiscretionaryforirregularluxuries",
"type": "number"
},
"ratioLuxuriesToExpenses": {
"description": "Ratio of expenses for luxuries to total expenses.",
"examples": [
0.39,
0.09,
0.62
],
"maximum": 1.0,
"minimum": 0.0,
"title": "Ratioluxuriestoexpenses",
"type": "number"
},
"ratioLuxuriesToIncome": {
"description": "Ratio of expenses for luxuries to income.",
"examples": [
0.14,
0.09,
0.31
],
"minimum": 0.0,
"title": "Ratioluxuriestoincome",
"type": "number"
},
"ratioNecessitiesToExpenses": {
"description": "Ratio of expenses for necessities to total expenses.",
"examples": [
0.61,
0.91,
0.38
],
"maximum": 1.0,
"minimum": 0.0,
"title": "Rationecessitiestoexpenses",
"type": "number"
},
"ratioNecessitiesToIncome": {
"description": "Ratio of expenses for necessities to income.",
"examples": [
0.59,
0.41,
0.2
],
"minimum": 0.0,
"title": "Rationecessitiestoincome",
"type": "number"
},
"reminderCharges": {
"description": "Whether reminder charges transactions exist in the recent past.",
"examples": [
false,
true
],
"title": "Remindercharges",
"type": "boolean"
},
"rentalPayments": {
"description": "Whether an active rental contract exists or not.",
"examples": [
false,
true
],
"title": "Rentalpayments",
"type": "boolean"
},
"returnDebits": {
"description": "Whether return debit transaction exist in the recent past or not.",
"examples": [
false,
true
],
"title": "Returndebits",
"type": "boolean"
},
"savings": {
"description": "Expected amount left monthly. Calculation based on total expected expenses and expected income.",
"examples": [
105.4,
369.12
],
"title": "Savings",
"type": "number"
},
"seizurePayments": {
"description": "Whether reminder charges transactions exist in the recent past.",
"examples": [
false,
true
],
"title": "Seizurepayments",
"type": "boolean"
}
},
"required": [
"discretionary",
"discretionaryForIrregularLuxuries",
"savings",
"gambling",
"existingLoans",
"mortgagePayments",
"rentalPayments",
"returnDebits",
"reminderCharges",
"seizurePayments",
"debtCollectionPayments",
"creditCards",
"financialLiteracy",
"ratioLuxuriesToExpenses",
"ratioNecessitiesToExpenses",
"ratioLuxuriesToIncome",
"ratioNecessitiesToIncome",
"ratioExpensesToIncome",
"ratioGamblingToDiscretionaryForIrregularLuxuries"
],
"title": "AffordabilityTagInstanceDetails",
"type": "object"
},
"AiConnectRule": {
"properties": {
"counterpartyIban": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": "",
"description": "IBAN of the counterparty",
"examples": [
"DE75512108001245126199",
"DE62500105175823116368"
],
"title": "Counterpartyiban"
},
"counterpartyName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": "",
"description": "Name of the counterparty",
"examples": [
"Deutsche Kreditbank",
"Allianz"
],
"title": "Counterpartyname"
},
"tagTreeItem": {
"$ref": "#/components/schemas/TagTreeItemInput",
"description": "tag tree item to use for categorization rule"
}
},
"required": [
"tagTreeItem"
],
"title": "AiConnectRule",
"type": "object"
},
"AiConnectTransaction": {
"properties": {
"betrag": {
"description": "Amount in Euros",
"examples": [
-5.67,
100.0
],
"title": "Betrag",
"type": "number"
},
"buchungsdatum": {
"description": "Date the transaction was initiated in yyyy-mm-dd HH:MM:SS format",
"examples": [
"2020-01-15 09:00:00",
"2023-10-14 14:00:00"
],
"format": "date-time",
"title": "Buchungsdatum",
"type": "string"
},
"buchungstext": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Posting text of the transaction",
"examples": [
"Lastschrift"
],
"title": "Buchungstext"
},
"gegenkontoBic": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "BIC of the counterparty",
"examples": [
"PBNKDEFF",
"BYLADEM1001"
],
"title": "Gegenkontobic"
},
"gegenkontoIban": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "IBAN of the counterparty",
"examples": [
"DE75512108001245126199",
"DE60500105173329447776"
],
"title": "Gegenkontoiban"
},
"gegenkontoInhaber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Name of the counterparty",
"examples": [
"Erika Musterfrau",
"Allianz AG"
],
"title": "Gegenkontoinhaber"
},
"gegenkontoInhaberAbweichend": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Name of the ultimate counterparty",
"examples": [
"REWE"
],
"title": "Gegenkontoinhaberabweichend"
},
"gvCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "SEPA GV Code (Gesch\u00e4ftsvorfallcode)",
"examples": [
"082"
],
"title": "Gvcode"
},
"hash": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Hash value for historical ordering",
"examples": [
"956ca508-c0e2-52c5-3202-8de20e7ed12b",
"f252ff12-30e1-4abb-a182-29285ac35868"
],
"title": "Hash"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "ID of the transaction",
"examples": [
"57624057-11bf-4087-b16a-dc1a7525d3b5",
"462f527c-f70c-4e85-9cec-ef35a88ad39a"
],
"title": "Id"
},
"primanotaNummer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Id used by the bank",
"examples": [
"999001"
],
"title": "Primanotanummer"
},
"product": {
"description": "ID of the banking product to which the transaction belongs",
"examples": [
"30cc4587-7e5f-450f-bb51-dc3829f67db4",
"51823731-a3f1-40bb-bb03-a3ae0fb1cd32"
],
"title": "Product",
"type": "string"
},
"provider": {
"description": "ID of the bank/service provider to which the transaction belongs",
"examples": [
"23d67ff8-ff6a-44ff-93da-f2af835394e4",
"b97f5b7b-7ff6-4c5e-a4e5-349090302ae5"
],
"title": "Provider",
"type": "string"
},
"tags": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/CategoriesTagInstance-Input"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "List of tags of the transaction",
"title": "Tags"
},
"tenant": {
"description": "ID of the tenant to which the transaction belongs",
"examples": [
"1bcb487e-f409-4438-a358-d8d128581761",
"cc88b350-b073-4fed-8e37-9f7ef77f783f"
],
"title": "Tenant",
"type": "string"
},
"user": {
"description": "ID of the user to whom the transaction belongs",
"examples": [
"624ca509-b0f2-42f6-b202-8de20e9ed12a",
"b23b86a8-3c49-47d3-ad38-89d7db9d8350"
],
"title": "User",
"type": "string"
},
"verwendungszweck": {
"description": "Text entered during posting",
"examples": [
"CRED DE07ZZZ00000063475 Beitrag Lebensvers 2020 01 SEPA BASISLASTSCHRIFT wiederholend",
"Vielen Dank f\u00fcr Ihren Einkauf"
],
"title": "Verwendungszweck",
"type": "string"
},
"waehrung": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Name of the currency in alphabetic ISO 4217 format",
"examples": [
"EUR",
"USD"
],
"title": "Waehrung"
},
"wertstellungsdatum": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Date the transaction was booked in yyyy-mm-dd HH:MM:SS format",
"examples": [
"2020-01-15 09:00:00",
"2023-10-14 14:00:00"
],
"title": "Wertstellungsdatum"
}
},
"required": [
"buchungsdatum",
"betrag",
"verwendungszweck",
"user",
"provider",
"product",
"tenant"
],
"title": "AiConnectTransaction",
"type": "object"
},
"AiConnectTransactionPut": {
"properties": {
"tags": {
"$ref": "#/components/schemas/TagTreeItemInput",
"description": "Tag tree item to use for re-categorization"
}
},
"title": "AiConnectTransactionPut",
"type": "object"
},
"Balance-Output": {
"properties": {
"balance": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Balance/value of bank product",
"examples": [
-1493.0,
177.59
],
"title": "Balance"
},
"balanceDate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Balance date as reported by the provider",
"examples": [
"2025-09-23 11:37:00"
],
"title": "Balancedate"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Currency in which the bank product is valued (Alphabetic Code ISO 4217)",
"examples": [
"EUR",
"USD",
"JPY",
"CHF"
],
"title": "Currency"
}
},
"title": "Balance",
"type": "object"
},
"BankProduct-Output": {
"properties": {
"accountNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The account or credit card number. The credit card number may not be issued completely, but with a star e.g. '3223 ****** 4554'",
"examples": [
"0123456789"
],
"title": "Accountnumber"
},
"balance": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Balance of the bank product",
"examples": [
-1593.2,
12675.48
],
"title": "Balance"
},
"balanceDataSource": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The source of the data for this depots balance. Only for products of type depot.",
"examples": [
"SWIFTMSG",
"SONSTIGE"
],
"title": "Balancedatasource"
},
"balanceDate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Balance date as reported by the provider",
"examples": [
"2016-05-23 13:37:00"
],
"title": "Balancedate"
},
"balances": {
"anyOf": [
{
"additionalProperties": {
"$ref": "#/components/schemas/Balance-Output"
},
"type": "object"
},
{
"type": "null"
}
],
"description": "A map where the key is the currency and the value is a Balance object. This field is only returned for multicurrency accounts.",
"examples": [
{
"EUR": {
"balance": 20000.13,
"balanceDate": "2023-08-15 00:00:00",
"currency": "EUR"
},
"USD": {
"balance": 5000.01,
"balanceDate": "2023-08-15 00:00:00",
"currency": "USD"
}
}
],
"title": "Balances"
},
"bankCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The (state local) bank code",
"examples": [
"12345678"
],
"title": "Bankcode"
},
"bic": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "BIC (Bank Identifier Code)",
"examples": [
"DEUTDEFFXXX"
],
"title": "Bic"
},
"bulkTransferSupport": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Indicates if bulk transfers are supported for this bank product or not.",
"examples": [
true,
false
],
"title": "Bulktransfersupport"
},
"contractAmount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "The contract amount for home savings contracts.",
"examples": [
50000.0,
15000.0
],
"title": "Contractamount"
},
"contractDate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The date of a home savings contract.",
"examples": [
"2023-01-15 00:00:00",
"2024-03-22 00:00:00"
],
"title": "Contractdate"
},
"contractNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The contract number for home savings contracts.",
"examples": [
"001178142200206",
"5015242048-Sparkonto-CLASSIC"
],
"title": "Contractnumber"
},
"contractStatus": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The current state of a home savings contract.",
"examples": [
"Sparphase",
"Sparkonto",
"Bausparvertrag Darlehensphase"
],
"title": "Contractstatus"
},
"contractType": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The type of home savings contract.",
"examples": [
"CLASSIC",
"Vario T2",
"Xtra Comfort"
],
"title": "Contracttype"
},
"creditDrawn": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Amount of credit already extended for the bank product",
"examples": [
1243.48
],
"title": "Creditdrawn"
},
"creditLimit": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Maximum amount of credit extended for the bank product",
"examples": [
2000.0
],
"title": "Creditlimit"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Currency in which the bank product is valued/managed",
"examples": [
"EUR",
"USD",
"JPY",
"CHF"
],
"title": "Currency"
},
"debtInterestRate": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "The debt interest rate of a home savings contract.",
"examples": [
0.81,
4.75,
3.8
],
"title": "Debtinterestrate"
},
"iban": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "IBAN (International Bank Account Number)",
"examples": [
"DE61500105173126617266"
],
"title": "Iban"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "ID of the bank product",
"examples": [
"57624057-11bf-4087-b16a-dc1a7525d3b5"
],
"title": "Id"
},
"lastUpdated": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Date of the last product update at the bank/service provider in yyyy-mm-dd HH:MM:SS format",
"examples": [
"2020-01-15 09:34:46"
],
"title": "Lastupdated"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Name of the bank product according to bank/service provider",
"examples": [
"Girokonto",
"Sichteinlagen",
"Extra-Konto",
"PremiumKonto"
],
"title": "Name"
},
"overdraftLimit": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Maximum amount by which the bank product can be overdrawn",
"examples": [
5000.0,
2500.0,
0.0
],
"title": "Overdraftlimit"
},
"owner": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Name of the owner",
"examples": [
"Erika Mustermann",
"Jane Doe"
],
"title": "Owner"
},
"providerId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "UUID of the bank/service provider",
"examples": [
"7721443a-30ab-4fb7-8919-4bee0e963019"
],
"title": "Providerid"
},
"providerName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Name of the bank/service provider",
"examples": [
"Deutsche Bank"
],
"title": "Providername"
},
"rating": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Rating",
"examples": [
2.917,
195.652,
80.0,
0.0
],
"title": "Rating"
},
"savingsProgress": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Savings progress percentage",
"examples": [
12.549,
78.2,
92.125
],
"title": "Savingsprogress"
},
"savingsRate": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "The savings rate of a home savings contract.",
"examples": [
0.5,
1.8,
3.0
],
"title": "Savingsrate"
},
"savingsState": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Shows if the home savings contract is currently in saving state (true) or not (false)",
"examples": [
true,
false
],
"title": "Savingsstate"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Retrieval status for the bank product data",
"examples": [
"VOLLSTAENDIG",
"INTERAKTION"
],
"title": "Status"
},
"transferSupport": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Indicates if transfers are supported for this bank product or not.",
"examples": [
true,
false
],
"title": "Transfersupport"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Type of the bank product",
"examples": [
"GIROKONTO",
"SPARKONTO",
"SONSTIGESKONTO"
],
"title": "Type"
}
},
"title": "BankProduct",
"type": "object"
},
"BusinessPartnersTagInstance": {
"properties": {
"details": {
"anyOf": [
{
"$ref": "#/components/schemas/BusinessPartnersTagInstanceDetails"
},
{
"type": "null"
}
]
},
"entity": {
"$ref": "#/components/schemas/Entity"
},
"id": {
"description": "Unique Universal Identifier (UUID)",
"examples": [
"956ca508-c0e2-52c5-3202-8de20e7ed12b",
"27e4cd99-b2c7-4a97-8d65-a965f9bcc0c6"
],
"title": "Id",
"type": "string"
},
"relations": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/Relation"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "List of relations",
"title": "Relations"
},
"tagTreeItem": {
"$ref": "#/components/schemas/BusinessPartnersTagTreeItem"
}
},
"required": [
"id",
"tagTreeItem",
"entity"
],
"title": "BusinessPartnersTagInstance",
"type": "object"
},
"BusinessPartnersTagInstanceDetails": {
"properties": {
"customName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Custom business partner (not in database)",
"examples": [
"Tante-Emma-Laden M\u00fcnchen Schwabing",
"Luna Lovegood",
"Peter Pettigrew"
],
"title": "Customname"
}
},
"title": "BusinessPartnersTagInstanceDetails",
"type": "object"
},
"BusinessPartnersTagTreeItem": {
"properties": {
"addressCity": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Address city of the business partner",
"examples": [
"M\u00fcnchen",
"Berlin"
],
"title": "Addresscity"
},
"addressCountry": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Address country of the business partner",
"examples": [
"Deutschland",
"Italien"
],
"title": "Addresscountry"
},
"addressStreet": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Address street incl. number of the business partner",
"examples": [
"Lyonel-Feininger-Stra\u00dfe 28",
"Hauptstr. 12"
],
"title": "Addressstreet"
},
"addressZip": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Address zip/postal code of the business partner",
"examples": [
"80807",
"10557"
],
"title": "Addresszip"
},
"categories": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "Categories the business partner belongs to.",
"examples": [
[
"BANKFINANCE",
"BANKFINANCE_INVESTMENT",
"BANKFINANCE_OTHER",
"SERVICES",
"SERVICES_PROFESSIONAL",
"SERVICES_ONLINE"
]
],
"title": "Categories"
},
"creditorId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "creditor id of the business partner",
"examples": [
"DE23ZZZ00000063478",
"DE93ZZZ00000078611"
],
"title": "Creditorid"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Gives a description of the tagTreeItem",
"examples": [
"Expenses from daily grocery purchases"
],
"title": "Description"
},
"displayName": {
"description": "User-friendly name shown to the end-users",
"examples": [
"BANKSapi",
"Allianz"
],
"title": "Displayname",
"type": "string"
},
"group": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Group the business partner belongs to.",
"examples": [
"Finconomy AG",
"Allianz"
],
"title": "Group"
},
"systemId": {
"description": "Unique internal id of the tag tree item",
"examples": [
262,
8,
2405
],
"title": "Systemid",
"type": "integer"
},
"systemName": {
"description": "Unique name of the tag tree item",
"examples": [
"BANKSapi Technology GmbH",
"Allianz Versicherungs-Aktiengesellschaft"
],
"title": "Systemname",
"type": "string"
},
"tagTree": {
"$ref": "#/components/schemas/TagTree",
"description": "tagTree that the tagTreeItem belongs to"
},
"telephone": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Telephone of the business partner",
"examples": [
"+49 (0)89 121 408 82",
"089-3838-1010"
],
"title": "Telephone"
},
"website": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Website of the business partner",
"examples": [
"www.banksapi.de",
"www.allianz.de"
],
"title": "Website"
}
},
"required": [
"systemId",
"systemName",
"displayName",
"tagTree"
],
"title": "BusinessPartnersTagTreeItem",
"type": "object"
},
"CashflowStatsPreds": {
"properties": {
"cashflow": {
"description": "cashflow amount in Euros",
"examples": [
-23.1,
8.99
],
"title": "Cashflow",
"type": "number"
},
"tagTreeItem": {
"anyOf": [
{
"$ref": "#/components/schemas/TagTreeItem"
},
{
"type": "null"
}
]
},
"total": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "total amount",
"examples": [
"EXPENSES",
"INCOME"
],
"title": "Total"
}
},
"title": "CashflowStatsPreds",
"type": "object"
},
"CashflowTagInstance": {
"properties": {
"details": {
"anyOf": [
{
"$ref": "#/components/schemas/CashflowTagInstanceDetails"
},
{
"type": "null"
}
]
},
"entity": {
"$ref": "#/components/schemas/Entity"
},
"id": {
"description": "Unique Universal Identifier (UUID)",
"examples": [
"956ca508-c0e2-52c5-3202-8de20e7ed12b",
"1728219d-383c-48af-a8c7-f31ea61381df"
],
"title": "Id",
"type": "string"
},
"relations": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/Relation"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "List of relations",
"title": "Relations"
},
"tagTreeItem": {
"$ref": "#/components/schemas/TagTreeItem"
}
},
"required": [
"id",
"tagTreeItem",
"entity"
],
"title": "CashflowTagInstance",
"type": "object"
},
"CashflowTagInstanceDetails": {
"properties": {
"predictions": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/CashflowStatsPreds"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "cashflow predictions",
"title": "Predictions"
},
"statistics": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/CashflowStatsPreds"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "cashflow statistics",
"title": "Statistics"
}
},
"title": "CashflowTagInstanceDetails",
"type": "object"
},
"CategoriesTagInstance-Input": {
"properties": {
"details": {
"anyOf": [
{
"$ref": "#/components/schemas/CategoriesTagInstanceDetails"
},
{
"type": "null"
}
]
},
"entity": {
"$ref": "#/components/schemas/Entity"
},
"id": {
"description": "Unique Universal Identifier (UUID)",
"examples": [
"956ca508-c0e2-52c5-3202-8de20e7ed12b",
"1728219d-383c-48af-a8c7-f31ea61381df"
],
"title": "Id",
"type": "string"
},
"relations": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/Relation"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "List of relations",
"title": "Relations"
},
"tagTreeItem": {
"$ref": "#/components/schemas/TagTreeItem"
}
},
"required": [
"id",
"tagTreeItem",
"entity"
],
"title": "CategoriesTagInstance",
"type": "object"
},
"CategoriesTagInstance-Output": {
"properties": {
"details": {
"anyOf": [
{
"$ref": "#/components/schemas/CategoriesTagInstanceDetails"
},
{
"type": "null"
}
]
},
"entity": {
"$ref": "#/components/schemas/Entity"
},
"id": {
"description": "Unique Universal Identifier (UUID)",
"examples": [
"956ca508-c0e2-52c5-3202-8de20e7ed12b",
"1728219d-383c-48af-a8c7-f31ea61381df"
],
"title": "Id",
"type": "string"
},
"relations": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/Relation"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "List of relations",
"title": "Relations"
},
"tagTreeItem": {
"$ref": "#/components/schemas/TagTreeItem"
}
},
"required": [
"id",
"tagTreeItem",
"entity"
],
"title": "CategoriesTagInstance",
"type": "object"
},
"CategoriesTagInstanceDetails": {
"properties": {
"confidenceLevel": {
"anyOf": [
{
"maximum": 1.0,
"minimum": 0.0,
"type": "number"
},
{
"type": "null"
}
],
"description": "Confidence level between 0 and 1",
"examples": [
0.94,
0.82
],
"title": "Confidencelevel"
}
},
"title": "CategoriesTagInstanceDetails",
"type": "object"
},
"ContractsTagInstance": {
"properties": {
"details": {
"anyOf": [
{
"$ref": "#/components/schemas/ContractsTagInstanceDetails"
},
{
"type": "null"
}
]
},
"entity": {
"$ref": "#/components/schemas/Entity"
},
"id": {
"description": "Unique Universal Identifier (UUID)",
"examples": [
"956ca508-c0e2-52c5-3202-8de20e7ed12b",
"2a7e60c4-652d-4224-a997-2e4a6395869f"
],
"title": "Id",
"type": "string"
},
"relations": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/Relation"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "List of relations",
"title": "Relations"
},
"tagTreeItemBusinessPartner": {
"$ref": "#/components/schemas/BusinessPartnersTagTreeItem"
},
"tagTreeItemCategory": {
"$ref": "#/components/schemas/TagTreeItem"
},
"tagTreeItemInsuranceType": {
"anyOf": [
{
"$ref": "#/components/schemas/TagTreeItem"
},
{
"type": "null"
}
]
},
"tagTreeItemPeriod": {
"anyOf": [
{
"$ref": "#/components/schemas/TagTreeItem"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"entity",
"tagTreeItemCategory",
"tagTreeItemBusinessPartner"
],
"title": "ContractsTagInstance",
"type": "object"
},
"ContractsTagInstanceDetails": {
"properties": {
"amountFirst": {
"description": "First payment among contract payments",
"examples": [
100.0,
-19.99
],
"title": "Amountfirst",
"type": "number"
},
"amountLatest": {
"description": "Most recent payment among contract payments",
"examples": [
4190.45,
-305.55
],
"title": "Amountlatest",
"type": "number"
},
"amountMaximum": {
"description": "Maximum payment among contract payments",
"examples": [
-1200.56,
-56.69,
96.0,
4910.55
],
"title": "Amountmaximum",
"type": "number"
},
"amountMean": {
"description": "Mean payment among contract payments",
"examples": [
-501.67,
209.91
],
"title": "Amountmean",
"type": "number"
},
"amountMedian": {
"description": "Median payment among contract payments",
"examples": [
-1295.34,
1003.5
],
"title": "Amountmedian",
"type": "number"
},
"amountMinimum": {
"description": "Minimum payment among contract payments",
"examples": [
3459.05,
-1400.0,
204.0,
184.22
],
"title": "Amountminimum",
"type": "number"
},
"amountNext": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Predicted next payment based on contract payments",
"examples": [
2349.54,
-49.95
],
"title": "Amountnext"
},
"amountTotal": {
"description": "Total amount of regular and non-regular payments",
"examples": [
32495.6,
-3950.91
],
"title": "Amounttotal",
"type": "number"
},
"amountTotalNonRegular": {
"description": "Total amount of non-regular payments",
"examples": [
-0.96,
1.35
],
"title": "Amounttotalnonregular",
"type": "number"
},
"amountTotalRegular": {
"description": "Total amount of regular payments",
"examples": [
3341.12,
-3919.33
],
"title": "Amounttotalregular",
"type": "number"
},
"contractNumbers": {
"description": "List of detected contract numbers",
"examples": [
[
"33350437",
"33350438"
],
[
"00005352"
],
[
"123.5669.9813"
]
],
"items": {
"type": "string"
},
"title": "Contractnumbers",
"type": "array"
},
"costDevelopment": {
"additionalProperties": {
"type": "number"
},
"description": "History of regular and non-regular payments",
"examples": [
{
"2024-01-15": -25.67,
"2024-02-15": -28.23,
"2024-03-15": -23.84,
"2024-04-15": -29.9
}
],
"title": "Costdevelopment",
"type": "object"
},
"costDevelopmentNonRegular": {
"additionalProperties": {
"type": "number"
},
"description": "History of non-regular payments",
"examples": [
{
"2024-04-15": -29.9
}
],
"title": "Costdevelopmentnonregular",
"type": "object"
},
"costDevelopmentRegular": {
"additionalProperties": {
"type": "number"
},
"description": "History of regular payments",
"examples": [
{
"2024-01-15": -25.67,
"2024-02-15": -28.23,
"2024-03-15": -23.84
}
],
"title": "Costdevelopmentregular",
"type": "object"
},
"counterpartyBic": {
"anyOf": [
{
"maxLength": 11,
"type": "string"
},
{
"type": "null"
}
],
"description": "BIC of the counterparty",
"examples": [
"BYLADEM1001",
"COBADEFFXXX",
"INGDDEFFXXX",
"NTSBDEB1XXX"
],
"title": "Counterpartybic"
},
"counterpartyIban": {
"anyOf": [
{
"maxLength": 34,
"type": "string"
},
{
"type": "null"
}
],
"description": "IBAN of the counterparty",
"examples": [
"DE54700500003701190315",
"DE69600800000905961100"
],
"title": "Counterpartyiban"
},
"counterpartyName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Name of the counterparty",
"examples": [
"Rewe",
"Allianz LV",
"Spotify AB"
],
"title": "Counterpartyname"
},
"counterpartyNameUltimate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Name of the ultimate counterparty",
"examples": [
"Allianz AG"
],
"title": "Counterpartynameultimate"
},
"creditAmount": {
"anyOf": [
{
"exclusiveMinimum": 0.0,
"type": "number"
},
{
"type": "null"
}
],
"description": "Net amount of the loan being paid back with the contract",
"examples": [
50000.0,
12500.0
],
"title": "Creditamount"
},
"creditAmountGross": {
"anyOf": [
{
"exclusiveMinimum": 0.0,
"type": "number"
},
{
"type": "null"
}
],
"description": "Total amount of the loan being paid back with the contract including additional costs",
"examples": [
51561.32,
12709.14
],
"title": "Creditamountgross"
},
"customName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "If there is no listed business partner found, a custom name is tried to be extracted from the transaction.",
"examples": [
"Frauke Testel",
"B\u00e4ckerei Astovic"
],
"title": "Customname"
},
"customerNumbers": {
"description": "List of detected customer numbers",
"examples": [
[
"0058681"
],
[
"000194",
"0000195"
],
[
"D48Z2K9"
],
[
"D54/50/3490"
]
],
"items": {
"type": "string"
},
"title": "Customernumbers",
"type": "array"
},
"dateEnd": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Contract end date",
"examples": [
"2024-04-13",
"2021-11-04"
],
"title": "Dateend"
},
"dateFirst": {
"description": "Date of the first payment",
"examples": [
"2022-05-13",
"2021-11-04"
],
"title": "Datefirst",
"type": "string"
},
"dateLatest": {
"description": "Date of the last payment",
"examples": [
"2024-04-13",
"2021-11-04"
],
"title": "Datelatest",
"type": "string"
},
"dateNext": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Predicted date of the next payment",
"examples": [
"2023-06-13",
"2025-11-04"
],
"title": "Datenext"
},
"dateStart": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Contract start date",
"examples": [
"2022-05-13",
"2021-11-04"
],
"title": "Datestart"
},
"daysAge": {
"description": "Age of the contract in days",
"examples": [
724,
249,
59,
1248
],
"title": "Daysage",
"type": "integer"
},
"growthRate": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Procentual growth rate per period",
"examples": [
0.3519
],
"title": "Growthrate"
},
"interestRate": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Effective annual interest rate estimated for this contract",
"examples": [
0.01,
0.0375
],
"title": "Interestrate"
},
"interestRateNominal": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Nominal annual interest rate detected for this contract",
"examples": [
0.0098,
0.0314
],
"title": "Interestratenominal"
},
"numberContract": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Deprecated. Use field contractNumbers instead.",
"examples": [
"524589",
"000000594",
"12.56979.99138",
"B254698X1"
],
"title": "Numbercontract"
},
"numberCustomer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Deprecated. Use field customerNumbers instead.",
"examples": [
"3334962",
"0001235",
"09234.2356.123",
"3AXF68R"
],
"title": "Numbercustomer"
},
"periodConfidenceLevel": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Confidence level for the assigned period (0.0-1.0)",
"examples": [
0.3,
0.5,
0.7,
0.8
],
"title": "Periodconfidencelevel"
},
"standardDeviation": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Standard deviation of contract payments",
"examples": [
0.14589
],
"title": "Standarddeviation"
},
"status": {
"description": "Status of contract (ACTIVE or NOT_ACTIVE)",
"examples": [
"ACTIVE",
"INACTIVE"
],
"title": "Status",
"type": "string"
},
"transactionIds": {
"description": "List of transaction ids, regular and non-regular payments",
"examples": [
[
"7d826b61-b97c-4de2-9fd8-d5a64a7ade5b",
"928a8da4-0dec-4a46-9dab-09fd0f589abb",
"80111cd6-cbf7-44b6-a1f3-b3162e41c7e7",
"97b3f4e0-581d-4e04-add2-3714947904cb"
]
],
"items": {
"type": "string"
},
"title": "Transactionids",
"type": "array"
},
"transactionIdsNonRegular": {
"description": "List of transaction ids, non-regular payments only",
"examples": [
[
"97b3f4e0-581d-4e04-add2-3714947904cb"
]
],
"items": {
"type": "string"
},
"title": "Transactionidsnonregular",
"type": "array"
},
"transactionIdsRegular": {
"description": "List of transaction ids, regular payments only",
"examples": [
[
"7d826b61-b97c-4de2-9fd8-d5a64a7ade5b",
"928a8da4-0dec-4a46-9dab-09fd0f589abb",
"80111cd6-cbf7-44b6-a1f3-b3162e41c7e7"
]
],
"items": {
"type": "string"
},
"title": "Transactionidsregular",
"type": "array"
}
},
"required": [
"amountMaximum",
"amountMinimum",
"amountMean",
"amountMedian",
"amountLatest",
"amountFirst",
"amountTotal",
"amountTotalRegular",
"amountTotalNonRegular",
"dateFirst",
"dateLatest",
"daysAge",
"status",
"contractNumbers",
"customerNumbers",
"transactionIds",
"transactionIdsRegular",
"transactionIdsNonRegular",
"costDevelopment",
"costDevelopmentRegular",
"costDevelopmentNonRegular"
],
"title": "ContractsTagInstanceDetails",
"type": "object"
},
"CreditAttributesActivePassiveContracts": {
"properties": {
"activeContracts": {
"description": "Contracts that are still running",
"items": {
"$ref": "#/components/schemas/ContractsTagInstance"
},
"title": "Activecontracts",
"type": "array"
},
"passiveContracts": {
"description": "Contracts that are still running",
"items": {
"$ref": "#/components/schemas/ContractsTagInstance"
},
"title": "Passivecontracts",
"type": "array"
}
},
"required": [
"activeContracts",
"passiveContracts"
],
"title": "CreditAttributesActivePassiveContracts",
"type": "object"
},
"CreditAttributesAssets": {
"properties": {
"investments": {
"description": "List of all investment accounts of the user",
"items": {
"$ref": "#/components/schemas/Investment-Output"
},
"title": "Investments",
"type": "array"
},
"products": {
"description": "List of all bank products of the user",
"items": {
"$ref": "#/components/schemas/BankProduct-Output"
},
"title": "Products",
"type": "array"
}
},
"required": [
"investments",
"products"
],
"title": "CreditAttributesAssets",
"type": "object"
},
"CreditAttributesBudget": {
"properties": {
"expenses": {
"$ref": "#/components/schemas/CreditAttributesExpenses",
"description": "Breakdown of negative financial flow into fixed and variable spending, excluding transfers between connected accounts"
},
"income": {
"$ref": "#/components/schemas/CreditAttributesIncome",
"description": "Breakdown of positive financial flow, excluding transfers between connected accounts"
},
"net": {
"$ref": "#/components/schemas/CreditAttributesNet",
"description": "Net financial flow that accumulates monthly after total spending and total saving is deducted from total income"
},
"savings": {
"$ref": "#/components/schemas/CreditAttributesCategorySummary",
"description": "Financial flow that is spent into savings-related targets such as depots, savings-books"
}
},
"required": [
"income",
"expenses",
"savings",
"net"
],
"title": "CreditAttributesBudget",
"type": "object"
},
"CreditAttributesCategorySummary": {
"properties": {
"statistics": {
"$ref": "#/components/schemas/CreditAttributesStatistics",
"description": "A summary of the statistics over the last 6 months as far as available"
}
},
"required": [
"statistics"
],
"title": "CreditAttributesCategorySummary",
"type": "object"
},
"CreditAttributesContractBudgetType": {
"properties": {
"contracts": {
"description": "A list of all contracts in this category active or ended within the last 6 months",
"items": {
"$ref": "#/components/schemas/ContractsTagInstance"
},
"title": "Contracts",
"type": "array"
},
"statistics": {
"$ref": "#/components/schemas/CreditAttributesStatistics",
"description": "A summary of the statistics over the last 6 months as far as available"
}
},
"required": [
"statistics",
"contracts"
],
"title": "CreditAttributesContractBudgetType",
"type": "object"
},
"CreditAttributesCredit": {
"properties": {
"financialCredit": {
"$ref": "#/components/schemas/CreditAttributesActivePassiveContracts",
"description": "Credit contracts with banks or near-banks"
},
"leasing": {
"$ref": "#/components/schemas/CreditAttributesActivePassiveContracts",
"description": "Contract related to the leasing of a car."
},
"mortgage": {
"$ref": "#/components/schemas/CreditAttributesActivePassiveContracts",
"description": "Credit related to the purchase of a house"
}
},
"required": [
"mortgage",
"financialCredit",
"leasing"
],
"title": "CreditAttributesCredit",
"type": "object"
},
"CreditAttributesExpenses": {
"properties": {
"fixedSpending": {
"$ref": "#/components/schemas/CreditAttributesCategorySummary",
"description": "Negative financial flow out of all connected accounts, that can be attributed to contracts"
},
"totalSpending": {
"$ref": "#/components/schemas/CreditAttributesCategorySummary",
"description": "Total negative financial flow out of all connected accounts, excluding transfers between accounts"
},
"variableSpending": {
"$ref": "#/components/schemas/CreditAttributesCategorySummary",
"description": "Negative financial flow out of all connected accounts, that can not be attributed to contracts"
}
},
"required": [
"totalSpending",
"fixedSpending",
"variableSpending"
],
"title": "CreditAttributesExpenses",
"type": "object"
},
"CreditAttributesFlags": {
"properties": {
"creditCards": {
"description": "Number of credit cards the user has",
"examples": [
2,
6,
0
],
"minimum": 0.0,
"title": "Creditcards",
"type": "integer"
},
"debtCollection": {
"description": "List of payments to debt collection agencies",
"items": {
"$ref": "#/components/schemas/CreditAttributesTransaction"
},
"title": "Debtcollection",
"type": "array"
},
"reminderCharges": {
"description": "List of reminder charges",
"items": {
"$ref": "#/components/schemas/CreditAttributesTransaction"
},
"title": "Remindercharges",
"type": "array"
},
"returnedDebitNotes": {
"description": "List of received payments due to a returned debit note (e.g. because of insufficient funds)",
"items": {
"$ref": "#/components/schemas/CreditAttributesTransaction"
},
"title": "Returneddebitnotes",
"type": "array"
},
"riskyPayment": {
"$ref": "#/components/schemas/CreditAttributesCategorySummary",
"description": "Aggregated payments to risky activities such as online casinos"
}
},
"required": [
"reminderCharges",
"riskyPayment",
"debtCollection",
"returnedDebitNotes",
"creditCards"
],
"title": "CreditAttributesFlags",
"type": "object"
},
"CreditAttributesIncome": {
"properties": {
"fixedIncome": {
"$ref": "#/components/schemas/CreditAttributesContractBudgetType",
"description": "Information related to non-salary recurring income sources such as rental or retirement income"
},
"salary": {
"$ref": "#/components/schemas/CreditAttributesSalary",
"description": "Information related to recurring income sources that are associated with a salary contract"
},
"totalIncome": {
"$ref": "#/components/schemas/CreditAttributesCategorySummary",
"description": "Sum of all positive financial flow, excluding transfers. Includes, salary, fixed income, windfall and non-regular income."
},
"variableIncome": {
"$ref": "#/components/schemas/CreditAttributesCategorySummary",
"description": "Financial flows that cannot be mapped to salary, fixed income or windfalls"
},
"windfalls": {
"description": "One-time positive financial flows that are at least 3 times more than average total income",
"items": {
"$ref": "#/components/schemas/CreditAttributesTransaction"
},
"title": "Windfalls",
"type": "array"
}
},
"required": [
"totalIncome",
"salary",
"fixedIncome",
"variableIncome",
"windfalls"
],
"title": "CreditAttributesIncome",
"type": "object"
},
"CreditAttributesLifeStages": {
"properties": {
"housing": {
"anyOf": [
{
"$ref": "#/components/schemas/LifeStagesTagInstance"
},
{
"type": "null"
}
],
"description": "Type of housing"
},
"labourMarket": {
"anyOf": [
{
"$ref": "#/components/schemas/LifeStagesTagInstance"
},
{
"type": "null"
}
],
"description": "Life stage in the job market"
},
"parenthood": {
"anyOf": [
{
"$ref": "#/components/schemas/LifeStagesTagInstance"
},
{
"type": "null"
}
],
"description": "Whether the user has non-adult children"
},
"relationship": {
"anyOf": [
{
"$ref": "#/components/schemas/LifeStagesTagInstance"
},
{
"type": "null"
}
],
"description": "Relationship status"
}
},
"title": "CreditAttributesLifeStages",
"type": "object"
},
"CreditAttributesNet": {
"properties": {
"positiveCashflowRatio": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Ratio of months where there was a positive net cash-flow in last 6 months",
"examples": [
0.83,
0.42,
0.3
],
"title": "Positivecashflowratio"
},
"statistics": {
"$ref": "#/components/schemas/CreditAttributesStatistics",
"description": "A summary of the statistics over the last 6 months as far as available"
}
},
"required": [
"statistics"
],
"title": "CreditAttributesNet",
"type": "object"
},
"CreditAttributesSalary": {
"properties": {
"contracts": {
"description": "A list of all contracts in this category active or ended within the last 6 months",
"items": {
"$ref": "#/components/schemas/ContractsTagInstance"
},
"title": "Contracts",
"type": "array"
},
"lengthOfEmployment": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Age of oldest continuous salary contract in days",
"examples": [
914,
75,
1240
],
"title": "Lengthofemployment"
},
"statistics": {
"$ref": "#/components/schemas/CreditAttributesStatistics",
"description": "A summary of the statistics over the last 6 months as far as available"
}
},
"required": [
"statistics",
"contracts",
"lengthOfEmployment"
],
"title": "CreditAttributesSalary",
"type": "object"
},
"CreditAttributesStatistics": {
"properties": {
"max": {
"description": "Largest sum of payments in a month",
"examples": [
-86.12,
-1405.0
],
"title": "Max",
"type": "number"
},
"mean": {
"description": "Mean sum of payments per month",
"examples": [
-34.56,
-923.3
],
"title": "Mean",
"type": "number"
},
"median": {
"description": "Median sum of payments per month",
"examples": [
-20.05,
-626.11
],
"title": "Median",
"type": "number"
},
"min": {
"description": "Smallest sum of payments in a month",
"examples": [
-12.56,
-695.33
],
"title": "Min",
"type": "number"
}
},
"required": [
"mean",
"median",
"max",
"min"
],
"title": "CreditAttributesStatistics",
"type": "object"
},
"CreditAttributesTagInstance": {
"properties": {
"assets": {
"$ref": "#/components/schemas/CreditAttributesAssets",
"description": "List of all bank products and depots their credit-lines and ages"
},
"budget": {
"$ref": "#/components/schemas/CreditAttributesBudget",
"description": "A digital budget summarizing financial flows across all the connected accounts"
},
"credit": {
"$ref": "#/components/schemas/CreditAttributesCredit",
"description": "Active and paid-off credit contracts"
},
"flags": {
"$ref": "#/components/schemas/CreditAttributesFlags",
"description": "Payments that reflect lower probabilities for credit repayment"
},
"lifeStages": {
"$ref": "#/components/schemas/CreditAttributesLifeStages",
"description": "Life stages in different life domains that may relate to credit worthiness. Only positive detections are reported. Empty result in a domain may indicate lack of relevant transactions."
}
},
"required": [
"lifeStages",
"credit",
"budget",
"flags",
"assets"
],
"title": "CreditAttributesTagInstance",
"type": "object"
},
"CreditAttributesTags": {
"properties": {
"businessPartner": {
"$ref": "#/components/schemas/TagInstance",
"description": "The business partner tag assigned to the transaction"
},
"category": {
"$ref": "#/components/schemas/TagInstance",
"description": "The categorization tag assigned to the transaction"
},
"insurance": {
"anyOf": [
{
"$ref": "#/components/schemas/TagInstance"
},
{
"type": "null"
}
],
"description": "The insurance tag assigned to the transaction"
}
},
"required": [
"category",
"businessPartner"
],
"title": "CreditAttributesTags",
"type": "object"
},
"CreditAttributesTransaction": {
"properties": {
"amount": {
"description": "Amount in Euros",
"examples": [
-5.67,
-690.95,
45.99
],
"title": "Amount",
"type": "number"
},
"id": {
"description": "ID of the transaction",
"examples": [
"57624057-11bf-4087-b16a-dc1a7525d3b5",
"af110389-4040-4f01-a926-1dad079b2a1a"
],
"title": "Id",
"type": "string"
},
"postingDatetime": {
"description": "Date the transaction was initiated in yyyy-mm-dd HH:MM:SS format",
"examples": [
"2020-01-15 09:00:00",
"2024-04-14 14:00:00"
],
"title": "Postingdatetime",
"type": "string"
},
"product": {
"description": "ID of the banking product to which the transaction belongs",
"examples": [
"30cc4587-7e5f-450f-bb51-dc3829f67db4",
"1ad45f76-2567-4b56-902e-52764f7af324"
],
"title": "Product",
"type": "string"
},
"provider": {
"description": "ID of the bank/service provider to which the transaction belongs",
"examples": [
"23d67ff8-ff6a-44ff-93da-f2af835394e4",
"4e076361-e53b-4e71-8a0d-8e3d62b3d642"
],
"title": "Provider",
"type": "string"
},
"tags": {
"$ref": "#/components/schemas/CreditAttributesTags",
"description": "Tags detected for this transaction"
}
},
"required": [
"id",
"product",
"provider",
"postingDatetime",
"amount",
"tags"
],
"title": "CreditAttributesTransaction",
"type": "object"
},
"DisposableMoneyTagInstance": {
"properties": {
"details": {
"anyOf": [
{
"$ref": "#/components/schemas/DisposableMoneyTagInstanceDetails"
},
{
"type": "null"
}
]
},
"entity": {
"$ref": "#/components/schemas/Entity"
},
"id": {
"description": "Unique Universal Identifier (UUID)",
"examples": [
"956ca508-c0e2-52c5-3202-8de20e7ed12b",
"1728219d-383c-48af-a8c7-f31ea61381df"
],
"title": "Id",
"type": "string"
},
"relations": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/Relation"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "List of relations",
"title": "Relations"
},
"tagTreeItem": {
"$ref": "#/components/schemas/TagTreeItem"
}
},
"required": [
"id",
"tagTreeItem",
"entity"
],
"title": "DisposableMoneyTagInstance",
"type": "object"
},
"DisposableMoneyTagInstanceDetails": {
"properties": {
"amountCashflow": {
"description": "Sum of income and expenses (cashflow) since the latest salary payment",
"examples": [
-1322.78,
410.46
],
"title": "Amountcashflow",
"type": "number"
},
"amountCurrentlyLeft": {
"description": "Amount currently left until the next salary payment considering the cashflow since the latest salary payment",
"examples": [
-422.78,
349.2
],
"title": "Amountcurrentlyleft",
"type": "number"
},
"amountDisposableMoney": {
"description": "Amount estimated to be left at the next salary payment considering the cashflow since the latest salary payment the expected fixed cashflow until the next salary payment and the expected flexible cashflow until the next salary payment",
"examples": [
672.19,
1300.08
],
"title": "Amountdisposablemoney",
"type": "number"
},
"amountExpectedFixedCashflow": {
"description": "Amount of the next salary payment",
"examples": [
2840.53,
1294.42
],
"title": "Amountexpectedfixedcashflow",
"type": "number"
},
"amountExpectedFlexCashflow": {
"description": "Sum of flexible income and expenses (cashflow) expected until the next salary payment derived from previous spending habits excluding contracts (expected fixed cashflow)",
"examples": [
-422.78,
-304.12
],
"title": "Amountexpectedflexcashflow",
"type": "number"
},
"amountExpectedLeft": {
"description": "Amount expectedly left until the next salary payment considering the cashflow since the latest salary payment and the expected cashflow until the next salary payment",
"examples": [
1094.97,
-30.55
],
"title": "Amountexpectedleft",
"type": "number"
},
"amountExpectedLeftDaily": {
"description": "Daily amount expectedly left until the next salary payment considering the cashflow since the latest salary payment and the expected cashflow until the next salary payment",
"examples": [
64.41,
4.01
],
"title": "Amountexpectedleftdaily",
"type": "number"
},
"amountSalaryLatest": {
"description": "Amount of the latest salary payment",
"examples": [
2840.53,
3104.5
],
"minimum": 0.0,
"title": "Amountsalarylatest",
"type": "number"
},
"amountSalaryNext": {
"description": "Amount of the next salary payment",
"examples": [
2840.53,
3104.5
],
"minimum": 0.0,
"title": "Amountsalarynext",
"type": "number"
},
"dateSalaryLatest": {
"description": "Date of the latest salary payment",
"examples": [
"2024-01-30",
"2024-04-29"
],
"title": "Datesalarylatest",
"type": "string"
},
"dateSalaryNext": {
"description": "Predicted date of the next salary payment",
"examples": [
"2024-02-29",
"2024-05-30"
],
"title": "Datesalarynext",
"type": "string"
},
"daysUntilSalary": {
"description": "Days until the next salary payment is expected. A negative value means, the predicted salary payment is overdue or the employment ended and no new employment contract was detected or the detection did not work.",
"examples": [
17,
3,
28
],
"maximum": 99.0,
"minimum": -99.0,
"title": "Daysuntilsalary",
"type": "integer"
}
},
"required": [
"dateSalaryLatest",
"dateSalaryNext",
"amountSalaryLatest",
"amountSalaryNext",
"daysUntilSalary",
"amountCashflow",
"amountCurrentlyLeft",
"amountExpectedFixedCashflow",
"amountExpectedLeft",
"amountExpectedLeftDaily",
"amountExpectedFlexCashflow",
"amountDisposableMoney"
],
"title": "DisposableMoneyTagInstanceDetails",
"type": "object"
},
"Empty": {
"properties": {},
"title": "Empty",
"type": "object"
},
"Entity": {
"properties": {
"displayName": {
"description": "Display name of the entity",
"examples": [
"Kontoumsatz",
"Benutzer"
],
"title": "Displayname",
"type": "string"
},
"entityClass": {
"description": "Class of the entity, such as TRANSACTION or USER",
"examples": [
"TRANSACTION",
"USER"
],
"title": "Entityclass",
"type": "string"
},
"id": {
"description": "UUID of the entity (transaction or user)",
"examples": [
"156ca508-c0e2-52c5-3202-8de20e7ed12b",
"9bd97a85-594a-4411-85d1-97b0606aeb33"
],
"title": "Id",
"type": "string"
},
"userId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "UUID of the user",
"examples": [
"156ca508-c0e2-52c5-3202-8de20e7ed12b",
"c0458fba-715a-46b9-920b-3b78966149b4"
],
"title": "Userid"
}
},
"required": [
"id",
"entityClass",
"displayName"
],
"title": "Entity",
"type": "object"
},
"ExtensiveTagTreeItem": {
"properties": {
"addressCity": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Address city of the business partner",
"examples": [
"M\u00fcnchen",
"Berlin"
],
"title": "Addresscity"
},
"addressCountry": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Address country of the business partner",
"examples": [
"Deutschland",
"Italien"
],
"title": "Addresscountry"
},
"addressStreet": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Address street incl. number of the business partner",
"examples": [
"Lyonel-Feininger-Stra\u00dfe 28",
"Hauptstr. 12"
],
"title": "Addressstreet"
},
"addressZip": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Address zip/postal code of the business partner",
"examples": [
"80807",
"10557"
],
"title": "Addresszip"
},
"categories": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "Categories the business partner belongs to.",
"examples": [
[
"BANKFINANCE",
"BANKFINANCE_INVESTMENT",
"BANKFINANCE_OTHER",
"SERVICES",
"SERVICES_PROFESSIONAL",
"SERVICES_ONLINE"
]
],
"title": "Categories"
},
"creditorId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "creditor id of the business partner",
"examples": [
"DE23ZZZ00000063478",
"DE93ZZZ00000078611"
],
"title": "Creditorid"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Gives a description of the tagTreeItem",
"examples": [
"Expenses from daily grocery purchases"
],
"title": "Description"
},
"displayName": {
"description": "User-friendly name shown to the end-users",
"examples": [
"BANKSapi",
"Allianz"
],
"title": "Displayname",
"type": "string"
},
"group": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Group the business partner belongs to.",
"examples": [
"Finconomy AG",
"Allianz"
],
"title": "Group"
},
"relations": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/Relation"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "List of relations",
"title": "Relations"
},
"systemId": {
"description": "Unique internal id of the tag tree item",
"examples": [
262,
8,
2405
],
"title": "Systemid",
"type": "integer"
},
"systemName": {
"description": "Unique name of the tag tree item",
"examples": [
"BANKSapi Technology GmbH",
"Allianz Versicherungs-Aktiengesellschaft"
],
"title": "Systemname",
"type": "string"
},
"systemNameParent": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Unique name of the parent of the tagTreeItem",
"examples": [
"LIVING",
"HOUSING"
],
"title": "Systemnameparent"
},
"tagTree": {
"$ref": "#/components/schemas/TagTree",
"description": "tagTree that the tagTreeItem belongs to"
},
"telephone": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Telephone of the business partner",
"examples": [
"+49 (0)89 121 408 82",
"089-3838-1010"
],
"title": "Telephone"
},
"website": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Website of the business partner",
"examples": [
"www.banksapi.de",
"www.allianz.de"
],
"title": "Website"
}
},
"required": [
"systemId",
"systemName",
"displayName",
"tagTree"
],
"title": "ExtensiveTagTreeItem",
"type": "object"
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
},
"Investment-Output": {
"properties": {
"amount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Amount of the securities",
"examples": [
7.0,
2495.0
],
"title": "Amount"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Trading currency (Alphabetic Code ISO 4217)",
"examples": [
"EUR",
"USD"
],
"title": "Currency"
},
"exchangeRate": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Exchange rate from EUR to the trading currency",
"examples": [
1.0,
0.94
],
"title": "Exchangerate"
},
"isin": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "International Securities Identification Number (ISIN) of the financial instrument",
"examples": [
"DE000BAY0017"
],
"title": "Isin"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Name of the deposit position, usually the name of the financial instrument",
"examples": [
"Bayer AG, BMW AG"
],
"title": "Name"
},
"price": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Trading price in trading currency",
"examples": [
53.47,
102.3
],
"title": "Price"
},
"rateDate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Date of the trading rate in yyyy-mm-dd HH:MM:SS format",
"examples": [
"2021-03-08 09:34:46",
"2024-02-02 17:54:20"
],
"title": "Ratedate"
},
"totalValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Total value of the stock in EUR as at the end of the financial statements",
"examples": [
364.66,
4912.9
],
"title": "Totalvalue"
},
"unit": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Trading unit",
"examples": [
"STUECK"
],
"title": "Unit"
},
"venue": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Trading venue of the price determination",
"examples": [
"MUN"
],
"title": "Venue"
},
"wkn": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Wertpapierkennnummer (WKN) of the financial instrument. Corresponds to the German National Securities Identifying Number (NSIN), but without the three leading zeros.",
"examples": [
"BAY001"
],
"title": "Wkn"
}
},
"title": "Investment",
"type": "object"
},
"LifeEventsTagInstance": {
"properties": {
"details": {
"anyOf": [
{
"$ref": "#/components/schemas/LifeEventsTagInstanceDetails"
},
{
"type": "null"
}
]
},
"entity": {
"$ref": "#/components/schemas/Entity"
},
"id": {
"description": "Unique Universal Identifier (UUID)",
"examples": [
"956ca508-c0e2-52c5-3202-8de20e7ed12b",
"1728219d-383c-48af-a8c7-f31ea61381df"
],
"title": "Id",
"type": "string"
},
"relations": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/Relation"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "List of relations",
"title": "Relations"
},
"tagTreeItem": {
"$ref": "#/components/schemas/LifeTagTreeItem"
}
},
"required": [
"id",
"tagTreeItem",
"entity"
],
"title": "LifeEventsTagInstance",
"type": "object"
},
"LifeEventsTagInstanceDetails": {
"properties": {
"eventDate": {
"description": "Date of the event",
"examples": [
"2019-05-03",
"2024-02-20"
],
"title": "Eventdate",
"type": "string"
}
},
"required": [
"eventDate"
],
"title": "LifeEventsTagInstanceDetails",
"type": "object"
},
"LifeStagesExplanation": {
"properties": {
"conflictingEvents": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LifeEventsTagInstance"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "The life events that caused the stage to be ambiguous. If the absence of events causes the inconsistency, the list will be empty.",
"title": "Conflictingevents"
},
"conflictingStages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/TagTreeItem"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "The life stages that caused the stage to be ambiguous",
"title": "Conflictingstages"
},
"contractDetails": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LifeStagesExplanationContracts"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "The contracts that caused the detection of a life stage",
"title": "Contractdetails"
}
},
"title": "LifeStagesExplanation",
"type": "object"
},
"LifeStagesExplanationContracts": {
"properties": {
"amountMean": {
"description": "Mean payment among contract payments",
"examples": [
-45.18,
30.1
],
"title": "Amountmean",
"type": "number"
},
"customName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "If there is no listed business partner found, a custom name is tried to be extracted from the transaction.",
"examples": [
"Zweirad M\u00fcller",
"Vegan Shop M\u00fcnchen"
],
"title": "Customname"
},
"id": {
"description": "Unique Universal Identifier (UUID)",
"examples": [
"956ca508-c0e2-52c5-3202-8de20e7ed12b",
"a172159c-8042-4a16-90f7-3d7fa53273aa"
],
"title": "Id",
"type": "string"
},
"status": {
"description": "Status of contract (ACTIVE or NOT_ACTIVE)",
"examples": [
"ACTIVE",
"NOT_ACTIVE"
],
"title": "Status",
"type": "string"
},
"tagTreeItemBusinessPartner": {
"$ref": "#/components/schemas/BusinessPartnersTagTreeItem"
},
"tagTreeItemCategory": {
"$ref": "#/components/schemas/TagTreeItem"
},
"tagTreeItemInsuranceType": {
"anyOf": [
{
"$ref": "#/components/schemas/TagTreeItem"
},
{
"type": "null"
}
]
},
"tagTreeItemPeriod": {
"anyOf": [
{
"$ref": "#/components/schemas/TagTreeItem"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"tagTreeItemCategory",
"tagTreeItemBusinessPartner",
"amountMean",
"status"
],
"title": "LifeStagesExplanationContracts",
"type": "object"
},
"LifeStagesTagInstance": {
"properties": {
"details": {
"anyOf": [
{
"$ref": "#/components/schemas/LifeStagesTagInstanceDetails"
},
{
"type": "null"
}
]
},
"entity": {
"$ref": "#/components/schemas/Entity"
},
"id": {
"description": "Unique Universal Identifier (UUID)",
"examples": [
"956ca508-c0e2-52c5-3202-8de20e7ed12b",
"1728219d-383c-48af-a8c7-f31ea61381df"
],
"title": "Id",
"type": "string"
},
"relations": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/Relation"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "List of relations",
"title": "Relations"
},
"tagTreeItem": {
"$ref": "#/components/schemas/LifeTagTreeItem"
}
},
"required": [
"id",
"tagTreeItem",
"entity"
],
"title": "LifeStagesTagInstance",
"type": "object"
},
"LifeStagesTagInstanceDetails": {
"properties": {
"explanation": {
"$ref": "#/components/schemas/LifeStagesExplanation"
}
},
"title": "LifeStagesTagInstanceDetails",
"type": "object"
},
"LifeTagTreeItem": {
"properties": {
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Gives a description of the tagTreeItem",
"examples": [
"Expenses from daily grocery purchases",
"",
"Period of a single month"
],
"title": "Description"
},
"displayName": {
"description": "User-friendly name shown to the end-users",
"examples": [
"Groceries",
"Tierhalterhaftpflichtversicherung",
"Ein Monat"
],
"title": "Displayname",
"type": "string"
},
"domain": {
"$ref": "#/components/schemas/TagTreeItem"
},
"systemId": {
"description": "Unique internal id of the tag tree item",
"examples": [
17,
39,
1,
114
],
"title": "Systemid",
"type": "integer"
},
"systemName": {
"description": "Unique name of the tag tree",
"examples": [
"LIVING_GROCERIES",
"LIABILITY_ANIMALS",
"MONTH_ONE"
],
"title": "Systemname",
"type": "string"
},
"systemNameParent": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Unique name of the parent of the tagTreeItem",
"examples": [
"LIVING",
"LIABILITY",
"MONTH"
],
"title": "Systemnameparent"
},
"tagTree": {
"$ref": "#/components/schemas/TagTree",
"description": "tagTree that the tagTreeItem belongs to"
}
},
"required": [
"systemId",
"systemName",
"displayName",
"tagTree",
"domain"
],
"title": "LifeTagTreeItem",
"type": "object"
},
"ParamModelCashflowLevel": {
"enum": [
"main",
"sub"
],
"title": "ParamModelCashflowLevel",
"type": "string"
},
"ParamModelCashflowSort": {
"enum": [
"tag",
"time"
],
"title": "ParamModelCashflowSort",
"type": "string"
},
"ParamModelCashflowTagTree": {
"enum": [
"CATEGORIES",
"BUSINESS_PARTNERS"
],
"title": "ParamModelCashflowTagTree",
"type": "string"
},
"ParamModelCategoriesModel": {
"enum": [
"hybrid",
"ai",
"basic"
],
"title": "ParamModelCategoriesModel",
"type": "string"
},
"ParamModelFreelancerCategoriesModel": {
"enum": [
"ai",
"basic"
],
"title": "ParamModelFreelancerCategoriesModel",
"type": "string"
},
"Relation": {
"properties": {
"href": {
"description": "Link of the relation",
"examples": [
"https://banksapi.io/tags/tag-trees/",
"https://banksapi.io/tags/tag-trees/1/"
],
"title": "Href",
"type": "string"
},
"rel": {
"description": "Name of the relation",
"examples": [
"tag_trees",
"tag_tree_items"
],
"title": "Rel",
"type": "string"
}
},
"required": [
"rel",
"href"
],
"title": "Relation",
"type": "object"
},
"SalesTriggersTagInstance": {
"properties": {
"details": {
"$ref": "#/components/schemas/SalesTriggersTagInstanceDetails"
},
"entity": {
"$ref": "#/components/schemas/Entity"
},
"id": {
"description": "Unique Universal Identifier (UUID)",
"examples": [
"956ca508-c0e2-52c5-3202-8de20e7ed12b",
"1728219d-383c-48af-a8c7-f31ea61381df"
],
"title": "Id",
"type": "string"
},
"relations": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/Relation"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "List of relations",
"title": "Relations"
},
"tagTreeItem": {
"$ref": "#/components/schemas/TagTreeItem"
}
},
"required": [
"id",
"tagTreeItem",
"entity"
],
"title": "SalesTriggersTagInstance",
"type": "object"
},
"SalesTriggersTagInstanceDetails": {
"properties": {
"eventDate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Date of the event",
"examples": [
"2023-11-03",
"2023-12-20"
],
"title": "Eventdate"
}
},
"title": "SalesTriggersTagInstanceDetails",
"type": "object"
},
"TagInstance": {
"properties": {
"entity": {
"$ref": "#/components/schemas/Entity"
},
"id": {
"description": "Unique Universal Identifier (UUID)",
"examples": [
"956ca508-c0e2-52c5-3202-8de20e7ed12b",
"1728219d-383c-48af-a8c7-f31ea61381df"
],
"title": "Id",
"type": "string"
},
"relations": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/Relation"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "List of relations",
"title": "Relations"
},
"tagTreeItem": {
"$ref": "#/components/schemas/TagTreeItem"
}
},
"required": [
"id",
"tagTreeItem",
"entity"
],
"title": "TagInstance",
"type": "object"
},
"TagTree": {
"properties": {
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Gives a description of the tag tree",
"examples": [
"Two level categorization tree.",
"Two level fine grained insurance categorization tag tree.",
"Two level periods tag tree."
],
"title": "Description"
},
"displayName": {
"description": "User-friendly name shown to the end-users",
"examples": [
"Kategorien",
"Versicherungsarten",
"Turnus"
],
"title": "Displayname",
"type": "string"
},
"isTenantGenerated": {
"description": "Boolean flag, set TRUE if the tag was manually set",
"examples": [
false,
true
],
"title": "Istenantgenerated",
"type": "boolean"
},
"systemId": {
"description": "Unique internal id of the tag tree",
"examples": [
1,
2,
8
],
"title": "Systemid",
"type": "integer"
},
"systemName": {
"description": "Unique name of the tag tree",
"examples": [
"CATEGORIES",
"INSURANCE_TYPES"
],
"title": "Systemname",
"type": "string"
},
"version": {
"description": "Version of the tag tree",
"examples": [
1.56,
2.03
],
"minimum": 0.0,
"title": "Version",
"type": "number"
}
},
"required": [
"systemName",
"systemId",
"displayName",
"isTenantGenerated",
"version"
],
"title": "TagTree",
"type": "object"
},
"TagTreeInput": {
"properties": {
"systemId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Unique internal id of the tag tree to change to",
"examples": [
1,
4,
12
],
"title": "Systemid"
},
"systemName": {
"description": "Unique name of the tag tree to change to",
"examples": [
"CATEGORIES",
"CUSTOM_CATEGORIES",
"INSURANCE_TYPES"
],
"title": "Systemname",
"type": "string"
}
},
"required": [
"systemName"
],
"title": "TagTreeInput",
"type": "object"
},
"TagTreeItem": {
"properties": {
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Gives a description of the tagTreeItem",
"examples": [
"Expenses from daily grocery purchases",
"",
"Period of a single month"
],
"title": "Description"
},
"displayName": {
"description": "User-friendly name shown to the end-users",
"examples": [
"Groceries",
"Tierhalterhaftpflichtversicherung",
"Ein Monat"
],
"title": "Displayname",
"type": "string"
},
"systemId": {
"description": "Unique internal id of the tag tree item",
"examples": [
17,
39,
1,
114
],
"title": "Systemid",
"type": "integer"
},
"systemName": {
"description": "Unique name of the tag tree",
"examples": [
"LIVING_GROCERIES",
"LIABILITY_ANIMALS",
"MONTH_ONE"
],
"title": "Systemname",
"type": "string"
},
"systemNameParent": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Unique name of the parent of the tagTreeItem",
"examples": [
"LIVING",
"LIABILITY",
"MONTH"
],
"title": "Systemnameparent"
},
"tagTree": {
"$ref": "#/components/schemas/TagTree",
"description": "tagTree that the tagTreeItem belongs to"
}
},
"required": [
"systemId",
"systemName",
"displayName",
"tagTree"
],
"title": "TagTreeItem",
"type": "object"
},
"TagTreeItemInput": {
"properties": {
"systemId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Unique internal id of the tag tree item to change to",
"examples": [
17,
30,
4
],
"title": "Systemid"
},
"systemName": {
"description": "Unique name of the tag tree item to change to",
"examples": [
"LIVING_GROCERIES",
"HOUSING_RENT"
],
"title": "Systemname",
"type": "string"
},
"tagTree": {
"$ref": "#/components/schemas/TagTreeInput"
}
},
"required": [
"systemName",
"tagTree"
],
"title": "TagTreeItemInput",
"type": "object"
},
"TaggingRule": {
"properties": {
"counterpartyIban": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "IBAN of the counterparty",
"examples": [
"DE75512108001245126199",
"DE62500105175823116368"
],
"title": "Counterpartyiban"
},
"counterpartyName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Name of the counterparty",
"examples": [
"ALLIANZ LV AG",
"Spotify AB"
],
"title": "Counterpartyname"
},
"id": {
"description": "ID of the rule",
"examples": [
"956ca508-c0e2-52c5-3202-8de20e7ed12b",
"e3bda08a-2240-4643-85a5-14934964e29c"
],
"title": "Id",
"type": "string"
},
"tagTreeItem": {
"$ref": "#/components/schemas/TagTreeItem",
"description": "tag tree item to use for categorization rule"
},
"user": {
"description": "ID of the user",
"examples": [
"156ca508-c0e2-52c5-3202-8de20e7ed12b",
"cf4fef05-7a1c-449c-8a34-8051cb0ed718"
],
"title": "User",
"type": "string"
}
},
"required": [
"id",
"user",
"counterpartyName",
"counterpartyIban",
"tagTreeItem"
],
"title": "TaggingRule",
"type": "object"
},
"TaggingRuleInput": {
"properties": {
"counterpartyIban": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "IBAN of the counterparty",
"examples": [
"DE75512108001245126199",
"IT53H0300203280684587387792"
],
"title": "Counterpartyiban"
},
"counterpartyName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Name of the counterparty",
"examples": [
"ALLIANZ LV",
"Ristorante Mario Schwabing"
],
"title": "Counterpartyname"
},
"tagTreeItem": {
"$ref": "#/components/schemas/TagTreeItemInput",
"description": "tag tree item to use for categorization rule"
},
"tenant": {
"description": "ID of the tenant",
"examples": [
"1bcb487e-f409-4438-a358-d8d128581761",
"8adf52d8-6a9b-468b-90d0-420d0317c148"
],
"maxLength": 36,
"minLength": 36,
"title": "Tenant",
"type": "string"
},
"user": {
"description": "ID of the user",
"examples": [
"624ca509-b0f2-42f6-b202-8de20e9ed12a",
"55fb6f4f-50ea-4591-a9e6-45393139ecd1"
],
"maxLength": 36,
"minLength": 36,
"title": "User",
"type": "string"
}
},
"required": [
"tenant",
"user",
"counterpartyName",
"counterpartyIban",
"tagTreeItem"
],
"title": "TaggingRuleInput",
"type": "object"
},
"TagsTagTree": {
"properties": {
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Gives a description of the tag tree",
"examples": [
"Two level categorization tree.",
"Two level fine grained insurance categorization tag tree."
],
"title": "Description"
},
"displayName": {
"description": "User-friendly name shown to the end-users",
"examples": [
"Kategorien",
"Versicherungsarten"
],
"title": "Displayname",
"type": "string"
},
"isTenantGenerated": {
"description": "Boolean flag, set TRUE if the tag was manually set",
"examples": [
false,
true
],
"title": "Istenantgenerated",
"type": "boolean"
},
"relations": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/Relation"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "List of relations",
"title": "Relations"
},
"systemId": {
"description": "Unique internal id of the tag tree",
"examples": [
1,
12,
4
],
"title": "Systemid",
"type": "integer"
},
"systemName": {
"description": "Unique name of the tag tree",
"examples": [
"CATEGORIES",
"INSURANCE_TYPES"
],
"title": "Systemname",
"type": "string"
},
"version": {
"description": "Version of the tag tree",
"examples": [
1.5,
0.93,
13.569
],
"exclusiveMinimum": 0.0,
"title": "Version",
"type": "number"
}
},
"required": [
"systemName",
"systemId",
"displayName",
"isTenantGenerated",
"version"
],
"title": "TagsTagTree",
"type": "object"
},
"Transaction": {
"properties": {
"amount": {
"description": "Amount in Euros",
"examples": [
-25.67,
150.0
],
"title": "Amount",
"type": "number"
},
"balance": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Transaction balance",
"examples": [
1000.5,
250.75
],
"title": "Balance"
},
"bankUniqueId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": "",
"description": "Id used by the bank",
"examples": [
"999001",
"9982003"
],
"title": "Bankuniqueid"
},
"batchId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Batch identifier",
"examples": [
"123456",
"789012"
],
"title": "Batchid"
},
"bookingRef": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Booking reference",
"examples": [
"20250760147752440002",
"20251840046687330008"
],
"title": "Bookingref"
},
"counterpartyBic": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": "",
"description": "BIC of the counterparty",
"examples": [
"PBNKDEFF",
"INGDDEFFXXX"
],
"title": "Counterpartybic"
},
"counterpartyIban": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": "",
"description": "IBAN of the counterparty",
"examples": [
"DE75512108001245126199",
"DE62500105175823116368"
],
"title": "Counterpartyiban"
},
"counterpartyName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": "",
"description": "Name of the counterparty",
"examples": [
"Deutsche Kreditbank",
"Allianz"
],
"title": "Counterpartyname"
},
"counterpartyNameUltimate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": "",
"description": "Name of the ultimate counterparty",
"examples": [
"ALLIANZ LV AG",
"Spotify AB"
],
"title": "Counterpartynameultimate"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": "",
"description": "Name of the currency in alphabetic ISO 4217 format",
"examples": [
"EUR",
"USD"
],
"title": "Currency"
},
"endToEndId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "End-to-end identifier",
"examples": [
"000096986100100075010006562",
"Beleg-Nr.1522079838",
"ZAHLBELEG 01004004037",
"NOTPROVIDED"
],
"title": "Endtoendid"
},
"entryReference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Entry reference",
"examples": [
"1214917436902509170090000",
"2811790646983759120080005"
],
"title": "Entryreference"
},
"gvCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": "",
"description": "SEPA GV Code (Gesch\u00e4ftsvorfallcode)",
"examples": [
"082",
"024"
],
"title": "Gvcode"
},
"hash": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Hash value for historical ordering",
"examples": [
"956ca508-c0e2-52c5-3202-8de20e7ed12b",
"b77435f7-2eab-45eb-b818-49842d060856"
],
"title": "Hash"
},
"id": {
"description": "ID of the transaction",
"examples": [
"46fd0f39-8083-4c93-b8a3-4b753f83e97c",
"bfbf2601-19fb-4342-928f-b9f06dc16045"
],
"title": "Id",
"type": "string"
},
"mandateId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "SEPA mandate reference",
"examples": [
"48228024",
"KV026602240000001"
],
"title": "Mandateid"
},
"noteToPayee": {
"description": "Text entered during posting",
"examples": [
"CRED DE07ZZZ00000063475 Beitrag Lebensvers 2020 01 SEPA BASISLASTSCHRIFT"
],
"title": "Notetopayee",
"type": "string"
},
"ownerRef": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Owner reference",
"title": "Ownerref"
},
"paypalSubtype": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "PayPal transaction subtype",
"examples": [
"PAYMENT"
],
"title": "Paypalsubtype"
},
"postingDatetime": {
"description": "Date the transaction was initiated in yyyy-mm-dd HH:MM:SS format",
"examples": [
"2020-01-15 09:00:00",
"2024-02-22 14:00:00"
],
"format": "date-time",
"title": "Postingdatetime",
"type": "string"
},
"postingText": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": "",
"description": "Posting text of the transaction",
"examples": [
"Lastschrift",
"BARAUSZAHLUNG"
],
"title": "Postingtext"
},
"product": {
"description": "ID of the banking product to which the transaction belongs",
"examples": [
"30cc4587-7e5f-450f-bb51-dc3829f67db4",
"feb7c4a4-f1da-4db7-a47e-52199bfa0fa0"
],
"title": "Product",
"type": "string"
},
"proprietaryCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Proprietary transaction code, used for example for PayPal's proprietary transaction ID",
"examples": [
"NCOL+161+01034",
"NTRF+199+00402",
"Lastschrifteinzug"
],
"title": "Proprietarycode"
},
"provider": {
"description": "ID of the bank/service provider to which the transaction belongs",
"examples": [
"23d67ff8-ff6a-44ff-93da-f2af835394e4",
"e410c1d7-fcfd-448e-b93d-8fcd825115d5"
],
"title": "Provider",
"type": "string"
},
"tenant": {
"description": "ID of the tenant to which the transaction belongs",
"examples": [
"1bcb487e-f409-4438-a358-d8d128581761",
"b00c3166-1350-4458-9e6c-6a04078076bc"
],
"title": "Tenant",
"type": "string"
},
"user": {
"description": "ID of the user to whom the transaction belongs",
"examples": [
"624ca509-b0f2-42f6-b202-8de20e9ed12a",
"c75a87d1-f95f-4043-a7fa-d9d58cbbd4f9"
],
"title": "User",
"type": "string"
},
"valueDatetime": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Date the transaction was booked in yyyy-mm-dd HH:MM:SS format",
"examples": [
"2020-01-16 08:00:00",
"2024-02-24 15:00:00"
],
"title": "Valuedatetime"
}
},
"required": [
"id",
"postingDatetime",
"amount",
"noteToPayee",
"user",
"provider",
"product",
"tenant"
],
"title": "Transaction",
"type": "object"
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"title": "Location",
"type": "array"
},
"msg": {
"title": "Message",
"type": "string"
},
"type": {
"title": "Error Type",
"type": "string"
}
},
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError",
"type": "object"
}
}
},
"info": {
"contact": {
"name": "BANKSapi Technology GmbH",
"url": "https://www.banksapi.de/"
},
"description": "# Introduction\n\nThe BANKSapi AI platform provides classification and analysis of financial data.\n\n## Endpoint Types\nThere are two complementary endpoint types.\n\n**Transaction-Level Endpoints** classify individual transactions within bank products by spending categories, business partners, insurance types, and more.\n\n**User-Level Endpoints** aggregate all bank products and their transactions to deliver comprehensive insights like contract detection, life stage analysis, credit risk assessment, and financial behavior patterns.\n\n## Building Blocks\n\nEndpoints build upon each other, transaction classifications form the foundation for contract detection, which enables life stage analysis, which powers credit risk assessment.\nThis layered approach ensures consistency while maximizing the value extracted from financial data.\n\n## Standardized Classification\n\nAll endpoints use a standardized **tagging architecture** with **Tag Instances** linking entities to **Tag Tree Items** from hierarchical **Tag Trees**.\nFor example, in **Categories**, a grocery store transaction gets a Tag Instance linking to the Tag Tree Item LIVING_GROCERIES from the Tag Tree CATEGORIES.\nThis ensures consistent classification vocabularies across the platform.\nExplore the **Tags** endpoints to understand available taxonomies and classes before diving into specific classifications.\n\n## Getting Started\nReady to start? Try **Categories** to classify each transaction of a bank product or **Contracts** to detect the contracts of a user across all his bank products.",
"title": "AI/Connect API Reference",
"version": "3.2"
},
"openapi": "3.1.0",
"paths": {
"/customer/v2/ai/affinities/": {
"get": {
"description": "Returns detected affinities for a provided user.",
"operationId": "get_affinities",
"parameters": [
{
"description": "ID used to track end-to-end processing of the request",
"in": "header",
"name": "x-correlation-id",
"required": false,
"schema": {
"description": "ID used to track end-to-end processing of the request",
"examples": [
"f47ac10b-58cc-4372-a567-0e02b2c3d479",
"6ba7b810-9dad-41d1-80b4-00c04fd430c8",
"550e8400-e29b-41d4-a716-446655440000"
],
"title": "X-Correlation-Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"default": {
"value": [
{
"entity": {
"displayName": "BENUTZER",
"entityClass": "USER",
"id": "d93043ad-e427-4ccc-95ed-09526ff2dc8a",
"userId": "d93043ad-e427-4ccc-95ed-09526ff2dc8a"
},
"id": "0e992f42-eb5f-4de4-a2c1-8daa53d8c395",
"relations": [
{
"href": "https://banksapi.io/tags/v1/tag-trees/",
"rel": "tag_trees"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/14/",
"rel": "tag_tree"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/14/tag-tree-items/",
"rel": "tag_tree_items"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/14/tag-tree-items/1/",
"rel": "tag_tree_item"
}
],
"tagTreeItem": {
"description": "Sportive",
"displayName": "Sportenthusiast*in",
"systemId": 1,
"systemName": "SPORTIVE",
"tagTree": {
"description": "Affinity detection tag tree.",
"displayName": "Affinit\u00e4ten",
"isTenantGenerated": false,
"systemId": 14,
"systemName": "AFFINITIES",
"version": 0.1
}
}
}
]
}
},
"schema": {
"items": {
"$ref": "#/components/schemas/CategoriesTagInstance-Output"
},
"title": "Response Get Affinities",
"type": "array"
}
}
},
"description": "Success, tags newly created or read from database"
},
"400": {
"description": "Bad request syntax or unsupported method"
},
"403": {
"description": "Tenant not set up for AI endpoints"
},
"408": {
"description": "Request timed out; try again later"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
},
"500": {
"description": "Server got itself in trouble"
}
},
"summary": "Get affinities tags",
"tags": [
"Affinities"
]
}
},
"/customer/v2/ai/affordability/": {
"get": {
"description": "Returns comprehensive affordability analysis for a provided user.",
"operationId": "get_affordability",
"parameters": [
{
"description": "ID used to track end-to-end processing of the request",
"in": "header",
"name": "x-correlation-id",
"required": false,
"schema": {
"description": "ID used to track end-to-end processing of the request",
"examples": [
"f47ac10b-58cc-4372-a567-0e02b2c3d479",
"6ba7b810-9dad-41d1-80b4-00c04fd430c8",
"550e8400-e29b-41d4-a716-446655440000"
],
"title": "X-Correlation-Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"default": {
"value": {
"details": {
"creditCards": 0,
"debtCollectionPayments": false,
"discretionary": 3788.69,
"discretionaryForIrregularLuxuries": 3609.48,
"existingLoans": false,
"expenses": {
"amount": -1722.88,
"luxuries": {
"amount": -435.9,
"irregular": {
"amount": -216.57,
"amountsPerTagTreeItem": [
{
"amount": -191.67,
"tagTreeItem": {
"description": "Transactions involving cash withdrawals at an ATM or a bank facility",
"displayName": "Barauszahlung",
"systemId": 2,
"systemName": "BANKFINANCE_CASHWITHDRAWAL",
"systemNameParent": "BANKFINANCE",
"tagTree": {
"description": "Two level categorization tree.",
"displayName": "Kategorien",
"isTenantGenerated": false,
"systemId": 1,
"systemName": "CATEGORIES",
"version": 3.71
}
}
},
{
"amount": -12.22,
"tagTreeItem": {
"description": "Payments from eating out (e.g. restaurants, bars)",
"displayName": "Ausgehen und Essen",
"systemId": 83,
"systemName": "RECREATION_FOODANDDRINKS",
"systemNameParent": "RECREATION",
"tagTree": {
"description": "Two level categorization tree.",
"displayName": "Kategorien",
"isTenantGenerated": false,
"systemId": 1,
"systemName": "CATEGORIES",
"version": 3.71
}
}
},
{
"amount": -2.99,
"tagTreeItem": {
"description": "Expenses for clothing and accessories",
"displayName": "Kleidung und Accessoires",
"systemId": 101,
"systemName": "SHOPPING_CLOTHINGACCESSORIES",
"systemNameParent": "SHOPPING",
"tagTree": {
"description": "Two level categorization tree.",
"displayName": "Kategorien",
"isTenantGenerated": false,
"systemId": 1,
"systemName": "CATEGORIES",
"version": 3.71
}
}
},
{
"amount": -6,
"tagTreeItem": {
"description": "Donations to charities",
"displayName": "Spenden & Wohlt\u00e4tigkeit",
"systemId": 65,
"systemName": "LIVING_CHARITY",
"systemNameParent": "LIVING",
"tagTree": {
"description": "Two level categorization tree.",
"displayName": "Kategorien",
"isTenantGenerated": false,
"systemId": 1,
"systemName": "CATEGORIES",
"version": 3.71
}
}
},
{
"amount": -1.58,
"tagTreeItem": {
"description": "Expenses related to child toys (e.g. buying toys at toysrus)",
"displayName": "Spielwaren",
"systemId": 25,
"systemName": "FAMILY_TOYS",
"systemNameParent": "FAMILY",
"tagTree": {
"description": "Two level categorization tree.",
"displayName": "Kategorien",
"isTenantGenerated": false,
"systemId": 1,
"systemName": "CATEGORIES",
"version": 3.71
}
}
},
{
"amount": -1.82,
"tagTreeItem": {
"description": "Other transactions related to the subject of housing",
"displayName": "Wohnen - Sonstiges",
"systemId": 35,
"systemName": "HOUSING_OTHER",
"systemNameParent": "HOUSING",
"tagTree": {
"description": "Two level categorization tree.",
"displayName": "Kategorien",
"isTenantGenerated": false,
"systemId": 1,
"systemName": "CATEGORIES",
"version": 3.71
}
}
},
{
"amount": -0.29,
"tagTreeItem": {
"description": "Other transactions including living expenses",
"displayName": "Lebenshaltung - Sonstiges",
"systemId": 68,
"systemName": "LIVING_OTHER",
"systemNameParent": "LIVING",
"tagTree": {
"description": "Two level categorization tree.",
"displayName": "Kategorien",
"isTenantGenerated": false,
"systemId": 1,
"systemName": "CATEGORIES",
"version": 3.71
}
}
}
]
},
"regular": {
"amount": -179.21,
"amountsPerTagTreeItem": [
{
"amount": -21.98,
"tagTreeItem": {
"description": "Expenses for music and video streaming as well as pay TV",
"displayName": "Streaming und Pay-TV",
"systemId": 115,
"systemName": "RECREATION_STREAMING",
"systemNameParent": "RECREATION",
"tagTree": {
"description": "Two level categorization tree.",
"displayName": "Kategorien",
"isTenantGenerated": false,
"systemId": 1,
"systemName": "CATEGORIES",
"version": 3.71
}
}
},
{
"amount": -20.0,
"tagTreeItem": {
"description": "Transactions related to personal fitness and sports (e.g. monthly gym membership payments)",
"displayName": "Sport und Fitness",
"systemId": 89,
"systemName": "RECREATION_SPORTS",
"systemNameParent": "RECREATION",
"tagTree": {
"description": "Two level categorization tree.",
"displayName": "Kategorien",
"isTenantGenerated": false,
"systemId": 1,
"systemName": "CATEGORIES",
"version": 3.71
}
}
},
{
"amount": -24.1,
"tagTreeItem": {
"description": "Payments related to a car insurance",
"displayName": "KFZ-Versicherung",
"systemId": 63,
"systemName": "INSURANCE_VEHICLE",
"systemNameParent": "INSURANCE",
"tagTree": {
"description": "Two level categorization tree.",
"displayName": "Kategorien",
"isTenantGenerated": false,
"systemId": 1,
"systemName": "CATEGORIES",
"version": 3.71
}
}
},
{
"amount": -4.77,
"tagTreeItem": {
"description": "Payments related to a liability insurance contract",
"displayName": "Haftpflichtversicherung",
"systemId": 57,
"systemName": "INSURANCE_LIABILITY",
"systemNameParent": "INSURANCE",
"tagTree": {
"description": "Two level categorization tree.",
"displayName": "Kategorien",
"isTenantGenerated": false,
"systemId": 1,
"systemName": "CATEGORIES",
"version": 3.71
}
}
},
{
"amount": -79.01,
"tagTreeItem": {
"description": "Payments related to a life insurance contract",
"displayName": "Lebensversicherung",
"systemId": 58,
"systemName": "INSURANCE_LIFE",
"systemNameParent": "INSURANCE",
"tagTree": {
"description": "Two level categorization tree.",
"displayName": "Kategorien",
"isTenantGenerated": false,
"systemId": 1,
"systemName": "CATEGORIES",
"version": 3.71
}
}
},
{
"amount": -10.31,
"tagTreeItem": {
"description": "Payments from eating out (e.g. restaurants, bars)",
"displayName": "Ausgehen und Essen",
"systemId": 83,
"systemName": "RECREATION_FOODANDDRINKS",
"systemNameParent": "RECREATION",
"tagTree": {
"description": "Two level categorization tree.",
"displayName": "Kategorien",
"isTenantGenerated": false,
"systemId": 1,
"systemName": "CATEGORIES",
"version": 3.71
}
}
},
{
"amount": -19.04,
"tagTreeItem": {
"description": "Payments related to an insurance contract covering legal expenses",
"displayName": "Rechtsschutzversicherung",
"systemId": 56,
"systemName": "INSURANCE_LEGAL",
"systemNameParent": "INSURANCE",
"tagTree": {
"description": "Two level categorization tree.",
"displayName": "Kategorien",
"isTenantGenerated": false,
"systemId": 1,
"systemName": "CATEGORIES",
"version": 3.71
}
}
}
]
}
},
"necessities": {
"amount": -1272.15,
"irregular": {
"amount": -94.02,
"amountsPerTagTreeItem": [
{
"amount": -48.94,
"tagTreeItem": {
"description": "Payments from grocery shopping",
"displayName": "Lebensmittel",
"systemId": 67,
"systemName": "LIVING_GROCERIES",
"systemNameParent": "LIVING",
"tagTree": {
"description": "Two level categorization tree.",
"displayName": "Kategorien",
"isTenantGenerated": false,
"systemId": 1,
"systemName": "CATEGORIES",
"version": 3.71
}
}
},
{
"amount": -21.62,
"tagTreeItem": {
"description": "Payments from refueling at a gas station",
"displayName": "Kraftstoffe und Schmiermittel",
"systemId": 72,
"systemName": "MOBILITY_FUEL",
"systemNameParent": "MOBILITY",
"tagTree": {
"description": "Two level categorization tree.",
"displayName": "Kategorien",
"isTenantGenerated": false,
"systemId": 1,
"systemName": "CATEGORIES",
"version": 3.71
}
}
},
{
"amount": -6.28,
"tagTreeItem": {
"description": "Payments for drugstore items (e.g. buying bath products)",
"displayName": "Drogerie",
"systemId": 66,
"systemName": "LIVING_DRUGSTORE",
"systemNameParent": "LIVING",
"tagTree": {
"description": "Two level categorization tree.",
"displayName": "Kategorien",
"isTenantGenerated": false,
"systemId": 1,
"systemName": "CATEGORIES",
"version": 3.71
}
}
},
{
"amount": -4.19,
"tagTreeItem": {
"description": "Business related interest or principal payments",
"displayName": "Kredittilgung (gesch\u00e4ftlich)",
"systemId": 144,
"systemName": "BUSINESS_CREDITPAYMENT",
"systemNameParent": "BUSINESS",
"tagTree": {
"description": "Two level categorization tree.",
"displayName": "Kategorien",
"isTenantGenerated": false,
"systemId": 1,
"systemName": "CATEGORIES",
"version": 3.71
}
}
},
{
"amount": -7.38,
"tagTreeItem": {
"description": "Transactions involving payments for public radio and television",
"displayName": "\u00d6ffentlich-rechtlicher Rundfunk",
"systemId": 11,
"systemName": "BILLS_PUBLICRADIO",
"systemNameParent": "BILLS",
"tagTree": {
"description": "Two level categorization tree.",
"displayName": "Kategorien",
"isTenantGenerated": false,
"systemId": 1,
"systemName": "CATEGORIES",
"version": 3.71
}
}
},
{
"amount": -5.61,
"tagTreeItem": {
"description": "Other transactions related to education",
"displayName": "Bildungswesen - Sonstiges",
"systemId": 16,
"systemName": "EDUCATION_OTHER",
"systemNameParent": "EDUCATION",
"tagTree": {
"description": "Two level categorization tree.",
"displayName": "Kategorien",
"isTenantGenerated": false,
"systemId": 1,
"systemName": "CATEGORIES",
"version": 3.71
}
}
}
]
},
"regular": {
"amount": -1135.31,
"amountsPerTagTreeItem": [
{
"amount": -17.5,
"tagTreeItem": {
"description": "Transactions involving payments for public radio and television",
"displayName": "\u00d6ffentlich-rechtlicher Rundfunk",
"systemId": 11,
"systemName": "BILLS_PUBLICRADIO",
"systemNameParent": "BILLS",
"tagTree": {
"description": "Two level categorization tree.",
"displayName": "Kategorien",
"isTenantGenerated": false,
"systemId": 1,
"systemName": "CATEGORIES",
"version": 3.71
}
}
},
{
"amount": -2.53,
"tagTreeItem": {
"description": "Payments from refueling at a gas station",
"displayName": "Kraftstoffe und Schmiermittel",
"systemId": 72,
"systemName": "MOBILITY_FUEL",
"systemNameParent": "MOBILITY",
"tagTree": {
"description": "Two level categorization tree.",
"displayName": "Kategorien",
"isTenantGenerated": false,
"systemId": 1,
"systemName": "CATEGORIES",
"version": 3.71
}
}
},
{
"amount": -0.9,
"tagTreeItem": {
"description": "Payments for drugstore items (e.g. buying bath products)",
"displayName": "Drogerie",
"systemId": 66,
"systemName": "LIVING_DRUGSTORE",
"systemNameParent": "LIVING",
"tagTree": {
"description": "Two level categorization tree.",
"displayName": "Kategorien",
"isTenantGenerated": false,
"systemId": 1,
"systemName": "CATEGORIES",
"version": 3.71
}
}
},
{
"amount": -56.82,
"tagTreeItem": {
"description": "Transactions involving payments for electricity and heating (e.g. to a municipal utility)",
"displayName": "Energiekosten",
"systemId": 9,
"systemName": "BILLS_ENERGY",
"systemNameParent": "BILLS",
"tagTree": {
"description": "Two level categorization tree.",
"displayName": "Kategorien",
"isTenantGenerated": false,
"systemId": 1,
"systemName": "CATEGORIES",
"version": 3.71
}
}
},
{
"amount": -46.17,
"tagTreeItem": {
"description": "Payments to telecommunication providers for a mobile or fixed-line network connection",
"displayName": "Internet und Telekommunikation",
"systemId": 12,
"systemName": "BILLS_TELECOMMUNICATIONS",
"systemNameParent": "BILLS",
"tagTree": {
"description": "Two level categorization tree.",
"displayName": "Kategorien",
"isTenantGenerated": false,
"systemId": 1,
"systemName": "CATEGORIES",
"version": 3.71
}
}
},
{
"amount": -66.6,
"tagTreeItem": {
"description": "Payments from using public transports",
"displayName": "\u00d6PNV",
"systemId": 75,
"systemName": "MOBILITY_PUBLICTRANSPORT",
"systemNameParent": "MOBILITY",
"tagTree": {
"description": "Two level categorization tree.",
"displayName": "Kategorien",
"isTenantGenerated": false,
"systemId": 1,
"systemName": "CATEGORIES",
"version": 3.71
}
}
},
{
"amount": -944.79,
"tagTreeItem": {
"description": "Transactions involving payments to a tenant",
"displayName": "Miete/Wohngeld",
"systemId": 37,
"systemName": "HOUSING_RENT",
"systemNameParent": "HOUSING",
"tagTree": {
"description": "Two level categorization tree.",
"displayName": "Kategorien",
"isTenantGenerated": false,
"systemId": 1,
"systemName": "CATEGORIES",
"version": 3.71
}
}
}
]
}
}
},
"financialLiteracy": false,
"gambling": 0,
"income": {
"amount": 5060.84,
"irregular": {
"amount": 0,
"amountsPerTagTreeItem": []
},
"regular": {
"amount": 5060.84,
"amountsPerTagTreeItem": [
{
"amount": 4856.84,
"tagTreeItem": {
"description": "Income from salary payments",
"displayName": "Gehalt",
"systemId": 49,
"systemName": "INCOME_SALARY",
"systemNameParent": "INCOME",
"tagTree": {
"description": "Two level categorization tree.",
"displayName": "Kategorien",
"isTenantGenerated": false,
"systemId": 1,
"systemName": "CATEGORIES",
"version": 3.71
}
}
},
{
"amount": 204,
"tagTreeItem": {
"description": "Income from gov. child benefits",
"displayName": "Staatliche F\u00f6rderung f\u00fcr Familie und Kinder",
"systemId": 52,
"systemName": "INCOME_STATEFAMILY",
"systemNameParent": "INCOME",
"tagTree": {
"description": "Two level categorization tree.",
"displayName": "Kategorien",
"isTenantGenerated": false,
"systemId": 1,
"systemName": "CATEGORIES",
"version": 3.71
}
}
}
]
}
},
"mortgagePayments": false,
"mostRecentRentalPayment": "2023-06-15",
"ratioExpensesToIncome": 0.34,
"ratioLuxuriesToExpenses": 0.25,
"ratioLuxuriesToIncome": 0.09,
"ratioNecessitiesToExpenses": 0.74,
"ratioNecessitiesToIncome": 0.25,
"reminderCharges": false,
"rentalPayments": true,
"returnDebits": false,
"savings": 3337.96,
"seizurePayments": false
},
"entity": {
"displayName": "BENUTZER",
"entityClass": "USER",
"id": "288ba056-12e0-4ba4-ae89-037153e58f27",
"userId": "288ba056-12e0-4ba4-ae89-037153e58f27"
},
"id": "69ffdb15-4c4b-4818-8a93-e9479e0bd845",
"relations": [
{
"href": "https://banksapi.io/tags/v1/tag-trees/",
"rel": "tag_trees"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/17/",
"rel": "tag_tree"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/17/tag-tree-items/",
"rel": "tag_tree_items"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/17/tag-tree-items/2/",
"rel": "tag_tree_item"
}
],
"tagTreeItem": {
"description": "Information about the affordability",
"displayName": "Informationen \u00fcber die Bezahlbarkeit",
"systemId": 2,
"systemName": "AFFORDABILITY_CHECK",
"systemNameParent": "AFFORDABILITY",
"tagTree": {
"description": "Affordability tag tree with single parent and child tag.",
"displayName": "Bezahlbarkeit",
"isTenantGenerated": false,
"systemId": 17,
"systemName": "AFFORDABILITY",
"version": 0.1
}
}
}
}
},
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/AffordabilityTagInstance"
},
{
"$ref": "#/components/schemas/Empty"
}
],
"title": "Response Get Affordability"
}
}
},
"description": "Success, tags newly created or read from database"
},
"400": {
"description": "Bad request syntax or unsupported method"
},
"403": {
"description": "Tenant not set up for AI endpoints"
},
"408": {
"description": "Request timed out; try again later"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
},
"500": {
"description": "Server got itself in trouble"
}
},
"summary": "Get affordability tags",
"tags": [
"Affordability"
]
}
},
"/customer/v2/ai/cashflow/": {
"get": {
"description": "Returns cashflow analysis with statistics and predictions for a provided user.",
"operationId": "get_cashflow",
"parameters": [
{
"description": "Cashflow is generated with the focus on either time or tag (CATEGORIES or BUSINESS_PARTNER)",
"in": "query",
"name": "focus",
"required": false,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/ParamModelCashflowSort"
},
{
"type": "null"
}
],
"default": "time",
"description": "Cashflow is generated with the focus on either time or tag (CATEGORIES or BUSINESS_PARTNER)",
"examples": [
"time",
"tag"
],
"title": "Focus"
}
},
{
"description": "Tag to use when summarizing the cashflow",
"in": "query",
"name": "tag",
"required": false,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/ParamModelCashflowTagTree"
},
{
"type": "null"
}
],
"default": "CATEGORIES",
"description": "Tag to use when summarizing the cashflow",
"examples": [
"CATEGORIES",
"BUSINESS_PARTNERS"
],
"title": "Tag"
}
},
{
"description": "Use the usual tags (\"sub\") or their parents (\"main\"). Only relevant if tag=CATEGORIES",
"in": "query",
"name": "catLevel",
"required": false,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/ParamModelCashflowLevel"
},
{
"type": "null"
}
],
"default": "sub",
"description": "Use the usual tags (\"sub\") or their parents (\"main\"). Only relevant if tag=CATEGORIES",
"examples": [
"sub",
"main"
],
"title": "Catlevel"
}
},
{
"description": "Exclude savings and investments related transactions",
"in": "query",
"name": "excludeSavings",
"required": false,
"schema": {
"description": "Exclude savings and investments related transactions",
"examples": [
false,
true
],
"title": "Excludesavings",
"type": "boolean"
}
},
{
"description": "ID used to track end-to-end processing of the request",
"in": "header",
"name": "x-correlation-id",
"required": false,
"schema": {
"description": "ID used to track end-to-end processing of the request",
"examples": [
"f47ac10b-58cc-4372-a567-0e02b2c3d479",
"6ba7b810-9dad-41d1-80b4-00c04fd430c8",
"550e8400-e29b-41d4-a716-446655440000"
],
"title": "X-Correlation-Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"default": {
"value": [
{
"details": {
"predictions": [],
"statistics": [
{
"cashflow": -1879.46,
"tagTreeItem": {
"displayName": "Gesamt",
"systemId": 906,
"systemName": "TOTAL_TOTAL",
"systemNameParent": "TOTAL",
"tagTree": {
"description": "Two level tree with years as parents and its periods as children.",
"displayName": "Cashflow",
"isClientGenerated": false,
"systemId": 6,
"systemName": "CASHFLOW",
"version": 1
}
}
},
{
"cashflow": -342.91,
"tagTreeItem": {
"displayName": "Jahr 2020",
"systemId": 692,
"systemName": "2020_Y",
"systemNameParent": "2020",
"tagTree": {
"description": "Two level tree with years as parents and its periods as children.",
"displayName": "Cashflow",
"isClientGenerated": false,
"systemId": 6,
"systemName": "CASHFLOW",
"version": 1
}
}
},
{
"cashflow": -342.91,
"tagTreeItem": {
"displayName": "1. Quartal 2020",
"systemId": 634,
"systemName": "2020_Q1",
"systemNameParent": "2020",
"tagTree": {
"description": "Two level tree with years as parents and its periods as children.",
"displayName": "Cashflow",
"isClientGenerated": false,
"systemId": 6,
"systemName": "CASHFLOW",
"version": 1
}
}
},
{
"cashflow": -154.3,
"tagTreeItem": {
"displayName": "Januar 2020",
"systemId": 622,
"systemName": "2020_M01",
"systemNameParent": "2020",
"tagTree": {
"description": "Two level tree with years as parents and its periods as children.",
"displayName": "Cashflow",
"isClientGenerated": false,
"systemId": 6,
"systemName": "CASHFLOW",
"version": 1
}
}
},
{
"cashflow": -29.99,
"tagTreeItem": {
"displayName": "1. Kalenderwoche 2020",
"systemId": 639,
"systemName": "2020_W01",
"systemNameParent": "2020",
"tagTree": {
"description": "Two level tree with years as parents and its periods as children.",
"displayName": "Cashflow",
"isClientGenerated": false,
"systemId": 6,
"systemName": "CASHFLOW",
"version": 1
}
}
}
]
},
"entity": {
"displayName": "USER",
"entityClass": "USER",
"id": "30bd730f-39b5-4646-b8ce-6aad8d95a5e4"
},
"id": "c36e4317-960b-4a03-8d02-4dfce2fc63f6",
"relations": [
{
"href": "https://banksapi.io/tags/v1/tag-trees/",
"rel": "tag_trees"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/1/",
"rel": "tag_tree"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/1/tag-tree-items/",
"rel": "tag_tree_items"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/1/tag-tree-items/2/",
"rel": "tag_tree_item"
}
],
"tagTreeItem": {
"description": "Transactions including invoices & bills",
"displayName": "Vertragsrechnungen",
"systemId": 2,
"systemName": "BILLS",
"tagTree": {
"description": "Two level categorization tree.",
"displayName": "Kategorien",
"isClientGenerated": false,
"systemId": 1,
"systemName": "CATEGORIES",
"version": 3.7
}
}
}
]
}
},
"schema": {
"items": {
"$ref": "#/components/schemas/CashflowTagInstance"
},
"title": "Response Get Cashflow",
"type": "array"
}
}
},
"description": "Success, tags newly created or read from database"
},
"400": {
"description": "Bad request syntax or unsupported method"
},
"403": {
"description": "Tenant not set up for AI endpoints"
},
"408": {
"description": "Request timed out; try again later"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
},
"500": {
"description": "Server got itself in trouble"
}
},
"summary": "Get cashflow tags",
"tags": [
"Cashflow"
]
}
},
"/customer/v2/ai/contracts/": {
"get": {
"description": "Returns contract analysis for a provided user.",
"operationId": "get_contracts",
"parameters": [
{
"description": "Return only contracts related to insurance",
"in": "query",
"name": "insuranceOnly",
"required": false,
"schema": {
"description": "Return only contracts related to insurance",
"examples": [
false,
true
],
"title": "Insuranceonly",
"type": "boolean"
}
},
{
"description": "Return only contracts related to insurance and home savings plans",
"in": "query",
"name": "insuranceOnlyExtended",
"required": false,
"schema": {
"description": "Return only contracts related to insurance and home savings plans",
"examples": [
false,
true
],
"title": "Insuranceonlyextended",
"type": "boolean"
}
},
{
"description": "ID used to track end-to-end processing of the request",
"in": "header",
"name": "x-correlation-id",
"required": false,
"schema": {
"description": "ID used to track end-to-end processing of the request",
"examples": [
"f47ac10b-58cc-4372-a567-0e02b2c3d479",
"6ba7b810-9dad-41d1-80b4-00c04fd430c8",
"550e8400-e29b-41d4-a716-446655440000"
],
"title": "X-Correlation-Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"default": {
"description": "Example response with a single telecommunications contract",
"summary": "default",
"value": [
{
"details": {
"amountFirst": -14.99,
"amountLatest": -14.99,
"amountMaximum": -15.79,
"amountMean": -15.15,
"amountMedian": -14.99,
"amountMinimum": -14.99,
"amountNext": -15.01,
"amountTotal": -166.7,
"amountTotalNonRegular": 0,
"amountTotalRegular": -166.7,
"contractNumbers": [],
"costDevelopment": {
"2024-09-28": -14.99,
"2024-10-28": -15.34,
"2024-11-28": -14.99,
"2024-12-28": -15.79,
"2025-01-28": -14.99,
"2025-02-28": -14.99,
"2025-03-28": -14.99,
"2025-04-28": -14.99,
"2025-05-28": -15.65,
"2025-06-28": -14.99,
"2025-07-28": -14.99
},
"costDevelopmentNonRegular": {},
"costDevelopmentRegular": {
"2024-09-28": -14.99,
"2024-10-28": -15.34,
"2024-11-28": -14.99,
"2024-12-28": -15.79,
"2025-01-28": -14.99,
"2025-02-28": -14.99,
"2025-03-28": -14.99,
"2025-04-28": -14.99,
"2025-05-28": -15.65,
"2025-06-28": -14.99,
"2025-07-28": -14.99
},
"counterpartyBic": "HYVEDEMMXXX",
"counterpartyIban": "DE16700202700005713153",
"counterpartyName": "Telef\u00f3nica Germany GmbH & Co. OHG",
"counterpartyNameUltimate": "",
"customerNumbers": [
"8466511587"
],
"dateFirst": "2024-09-28",
"dateLatest": "2025-07-28",
"dateNext": "2025-08-28",
"dateStart": "2024-09-28",
"daysAge": 331,
"growthRate": 0,
"standardDeviation": 0.3,
"status": "ACTIVE",
"transactionIds": [
"1b7558b0-000c-fb24-0e31-1693ae699490",
"1b7fe870-000c-9558-6920-8313f2690ad6",
"1b8ace70-000f-e36a-8733-a1533538483f",
"1b955a70-0004-e2d6-31d8-06f32d6ac043",
"1ba04070-0001-cccb-1b77-6d7383088022",
"1bab2670-0006-2880-6a9f-80a356c9b212",
"1bb4fe70-000e-b1b9-6bf2-66c3e58a5bc1",
"1bbfe0b0-0000-6f63-f8c6-ccf371ab808f",
"1bca6cb0-000c-3339-6f05-e07381c95303",
"1bd552b0-000f-1a82-976c-8ec38439d22c",
"1bdfdeb0-0001-a30e-e6c8-369302db71ae"
],
"transactionIdsNonRegular": [],
"transactionIdsRegular": [
"1b7558b0-000c-fb24-0e31-1693ae699490",
"1b7fe870-000c-9558-6920-8313f2690ad6",
"1b8ace70-000f-e36a-8733-a1533538483f",
"1b955a70-0004-e2d6-31d8-06f32d6ac043",
"1ba04070-0001-cccb-1b77-6d7383088022",
"1bab2670-0006-2880-6a9f-80a356c9b212",
"1bb4fe70-000e-b1b9-6bf2-66c3e58a5bc1",
"1bbfe0b0-0000-6f63-f8c6-ccf371ab808f",
"1bca6cb0-000c-3339-6f05-e07381c95303",
"1bd552b0-000f-1a82-976c-8ec38439d22c",
"1bdfdeb0-0001-a30e-e6c8-369302db71ae"
]
},
"entity": {
"displayName": "BENUTZER",
"entityClass": "USER",
"id": "29779cf3-06df-401a-ba6c-e93df17895e8",
"userId": "29779cf3-06df-401a-ba6c-e93df17895e8"
},
"id": "24c575f1-79b2-9fa1-dc72-dcf4fbe43432",
"relations": [
{
"href": "https://banksapi.io/tags/v1/tag-trees/",
"rel": "tag_trees"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/1/",
"rel": "tag_tree_category"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/1/tag-tree-items/",
"rel": "tag_tree_items_category"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/1/tag-tree-items/12/",
"rel": "tag_tree_item_category"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/2/",
"rel": "tag_tree_insurance_type"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/2/tag-tree-items/",
"rel": "tag_tree_items_insurance_type"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/2/tag-tree-items/87/",
"rel": "tag_tree_item_insurance_type"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/4/",
"rel": "tag_tree_period"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/4/tag-tree-items/",
"rel": "tag_tree_items_period"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/4/tag-tree-items/3/",
"rel": "tag_tree_item_period"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/3/",
"rel": "tag_tree_business_partner"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/3/tag-tree-items/",
"rel": "tag_tree_items_business_partner"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/3/tag-tree-items/3279/",
"rel": "tag_tree_item_business_partner"
}
],
"tagTreeItemBusinessPartner": {
"addressCity": "M\u00fcnchen",
"addressCountry": "Deutschland",
"addressStreet": "Georg-Brauchle-Ring 50",
"addressZip": "80992",
"categories": [
"BILLS_TELECOMMUNICATIONS"
],
"creditorId": "DE9700000000142462",
"displayName": "Telefonica",
"systemId": 3279,
"systemName": "Telefonica Germany GmbH Co OHG",
"tagTree": {
"description": "Single level tag tree of business partners.",
"displayName": "Gesch\u00e4ftspartner",
"isTenantGenerated": false,
"systemId": 3,
"systemName": "BUSINESS_PARTNERS",
"version": 1.91
},
"telephone": "+49 (0)89 / 244 20",
"website": "https://www.telefonica.de/"
},
"tagTreeItemCategory": {
"description": "Payments to telecommunication providers for a mobile or fixed-line network connection",
"displayName": "Internet und Telekommunikation",
"systemId": 12,
"systemName": "BILLS_TELECOMMUNICATIONS",
"systemNameParent": "BILLS",
"tagTree": {
"description": "Two level categorization tree.",
"displayName": "Kategorien",
"isTenantGenerated": false,
"systemId": 1,
"systemName": "CATEGORIES",
"version": 3.71
}
},
"tagTreeItemInsuranceType": {
"displayName": "Nicht versicherungsrelevant",
"systemId": 87,
"systemName": "UNRELATED_OTHER",
"systemNameParent": "UNRELATED",
"tagTree": {
"description": "Two level fine grained insurance categorization tag tree.",
"displayName": "Versicherungsarten",
"isTenantGenerated": false,
"systemId": 2,
"systemName": "INSURANCE_TYPES",
"version": 2.41
}
},
"tagTreeItemPeriod": {
"description": "Period of a single month",
"displayName": "Ein Monat",
"systemId": 3,
"systemName": "MONTH_ONE",
"systemNameParent": "MONTH",
"tagTree": {
"description": "Two level periods tag tree.",
"displayName": "Turnus",
"isTenantGenerated": false,
"systemId": 4,
"systemName": "PERIODS",
"version": 0.4
}
}
}
]
},
"empty": {
"description": "Example response when no contracts are found",
"summary": "empty",
"value": []
},
"insurance": {
"description": "Example response with a single insurance contract",
"summary": "insurance",
"value": [
{
"details": {
"amountFirst": -59.12,
"amountLatest": -59.12,
"amountMaximum": -59.12,
"amountMean": -59.12,
"amountMedian": -59.12,
"amountMinimum": -59.12,
"amountNext": -59.12,
"amountTotal": -1005.04,
"amountTotalNonRegular": 0,
"amountTotalRegular": -1005.04,
"contractNumbers": [
"2008130623005"
],
"costDevelopment": {
"2024-04-02": -59.12,
"2024-05-02": -59.12,
"2024-06-02": -59.12,
"2024-07-02": -59.12,
"2024-08-02": -59.12,
"2024-09-02": -59.12,
"2024-10-02": -59.12,
"2024-11-02": -59.12,
"2024-12-02": -59.12,
"2025-01-02": -59.12,
"2025-02-02": -59.12,
"2025-03-02": -59.12,
"2025-04-02": -59.12,
"2025-05-02": -59.12,
"2025-06-02": -59.12,
"2025-07-02": -59.12,
"2025-08-02": -59.12
},
"costDevelopmentNonRegular": {},
"costDevelopmentRegular": {
"2024-04-02": -59.12,
"2024-05-02": -59.12,
"2024-06-02": -59.12,
"2024-07-02": -59.12,
"2024-08-02": -59.12,
"2024-09-02": -59.12,
"2024-10-02": -59.12,
"2024-11-02": -59.12,
"2024-12-02": -59.12,
"2025-01-02": -59.12,
"2025-02-02": -59.12,
"2025-03-02": -59.12,
"2025-04-02": -59.12,
"2025-05-02": -59.12,
"2025-06-02": -59.12,
"2025-07-02": -59.12,
"2025-08-02": -59.12
},
"counterpartyBic": "DEUTDEBB",
"counterpartyIban": "DE36100700000460303100",
"counterpartyName": "IDEAL Lebensversicherung a.G.",
"counterpartyNameUltimate": "",
"customerNumbers": [],
"dateFirst": "2024-04-02",
"dateLatest": "2025-08-02",
"dateNext": "2025-09-02",
"dateStart": "2024-04-02",
"daysAge": 510,
"growthRate": 0,
"standardDeviation": 0,
"status": "ACTIVE",
"transactionIds": [
"1b365bb0-000a-b175-6e6e-6b7373a805b7",
"1b40e7b0-0008-bbe6-8dea-7843e27ba457",
"1b4bcdb0-0004-90bd-9753-9fe38d28b293",
"1b5659b0-0003-2207-420c-568390e8462f",
"1b613fb0-0002-753a-7be3-797398994e60",
"1b6c25b0-0003-20ea-9f9d-3f032a697156",
"1b76b1b0-000d-8e15-2d04-b593689ab6a3",
"1b819b70-000b-ead7-368f-5a3360fb45b4",
"1b8c2770-000b-28ee-66ef-1313cc9b0ebe",
"1b970d70-000f-a1ac-b456-0f73e078ac60",
"1ba1f370-0003-c259-37e6-0053603a9f67",
"1babcb70-000a-904a-a56d-80d3082b04af",
"1bb6adb0-000b-2ede-3ed5-d6c312fb4086",
"1bc139b0-0006-1c3b-1b64-42a3d8d85a88",
"1bcc1fb0-0000-c9f2-0878-52e36f89ac3d",
"1bd6abb0-000c-d1dd-f3a7-528382a92971",
"1be191b0-0006-00e7-91a1-ff63d8b80d8f"
],
"transactionIdsNonRegular": [],
"transactionIdsRegular": [
"1b365bb0-000a-b175-6e6e-6b7373a805b7",
"1b40e7b0-0008-bbe6-8dea-7843e27ba457",
"1b4bcdb0-0004-90bd-9753-9fe38d28b293",
"1b5659b0-0003-2207-420c-568390e8462f",
"1b613fb0-0002-753a-7be3-797398994e60",
"1b6c25b0-0003-20ea-9f9d-3f032a697156",
"1b76b1b0-000d-8e15-2d04-b593689ab6a3",
"1b819b70-000b-ead7-368f-5a3360fb45b4",
"1b8c2770-000b-28ee-66ef-1313cc9b0ebe",
"1b970d70-000f-a1ac-b456-0f73e078ac60",
"1ba1f370-0003-c259-37e6-0053603a9f67",
"1babcb70-000a-904a-a56d-80d3082b04af",
"1bb6adb0-000b-2ede-3ed5-d6c312fb4086",
"1bc139b0-0006-1c3b-1b64-42a3d8d85a88",
"1bcc1fb0-0000-c9f2-0878-52e36f89ac3d",
"1bd6abb0-000c-d1dd-f3a7-528382a92971",
"1be191b0-0006-00e7-91a1-ff63d8b80d8f"
]
},
"entity": {
"displayName": "BENUTZER",
"entityClass": "USER",
"id": "29779cf3-06df-401a-ba6c-e93df17895e8",
"userId": "29779cf3-06df-401a-ba6c-e93df17895e8"
},
"id": "5242c2d4-013b-a1e6-9bbd-082fb6643ad9",
"relations": [
{
"href": "https://banksapi.io/tags/v1/tag-trees/",
"rel": "tag_trees"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/1/",
"rel": "tag_tree_category"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/1/tag-tree-items/",
"rel": "tag_tree_items_category"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/1/tag-tree-items/58/",
"rel": "tag_tree_item_category"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/2/",
"rel": "tag_tree_insurance_type"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/2/tag-tree-items/",
"rel": "tag_tree_items_insurance_type"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/2/tag-tree-items/55/",
"rel": "tag_tree_item_insurance_type"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/4/",
"rel": "tag_tree_period"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/4/tag-tree-items/",
"rel": "tag_tree_items_period"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/4/tag-tree-items/3/",
"rel": "tag_tree_item_period"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/3/",
"rel": "tag_tree_business_partner"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/3/tag-tree-items/",
"rel": "tag_tree_items_business_partner"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/3/tag-tree-items/1596/",
"rel": "tag_tree_item_business_partner"
}
],
"tagTreeItemBusinessPartner": {
"addressCity": "Berlin",
"addressCountry": "Deutschland",
"addressStreet": "Kochstra\u00dfe 26",
"addressZip": "10969",
"categories": [
"INSURANCE_LIFE"
],
"creditorId": "DE40ZZZ00000559230",
"displayName": "IDEAL Lebensversicherung",
"group": "IDEAL",
"systemId": 1596,
"systemName": "IDEAL Lebensversicherung a.G.",
"tagTree": {
"description": "Single level tag tree of business partners.",
"displayName": "Gesch\u00e4ftspartner",
"isTenantGenerated": false,
"systemId": 3,
"systemName": "BUSINESS_PARTNERS",
"version": 1.91
},
"telephone": "030-2587-0",
"website": "https://www.ideal-versicherung.de/"
},
"tagTreeItemCategory": {
"description": "Payments related to a life insurance contract",
"displayName": "Lebensversicherung",
"systemId": 58,
"systemName": "INSURANCE_LIFE",
"systemNameParent": "INSURANCE",
"tagTree": {
"description": "Two level categorization tree.",
"displayName": "Kategorien",
"isTenantGenerated": false,
"systemId": 1,
"systemName": "CATEGORIES",
"version": 3.71
}
},
"tagTreeItemInsuranceType": {
"displayName": "Lebensversicherung - Sonstiges",
"systemId": 55,
"systemName": "LIFE_OTHER",
"systemNameParent": "LIFE",
"tagTree": {
"description": "Two level fine grained insurance categorization tag tree.",
"displayName": "Versicherungsarten",
"isTenantGenerated": false,
"systemId": 2,
"systemName": "INSURANCE_TYPES",
"version": 2.41
}
},
"tagTreeItemPeriod": {
"description": "Period of a single month",
"displayName": "Ein Monat",
"systemId": 3,
"systemName": "MONTH_ONE",
"systemNameParent": "MONTH",
"tagTree": {
"description": "Two level periods tag tree.",
"displayName": "Turnus",
"isTenantGenerated": false,
"systemId": 4,
"systemName": "PERIODS",
"version": 0.4
}
}
}
]
}
},
"schema": {
"items": {
"$ref": "#/components/schemas/ContractsTagInstance"
},
"title": "Response Get Contracts",
"type": "array"
}
}
},
"description": "Success, tags newly created or read from database"
},
"400": {
"description": "Bad request syntax or unsupported method"
},
"403": {
"description": "Tenant not set up for AI endpoints"
},
"408": {
"description": "Request timed out; try again later"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
},
"500": {
"description": "Server got itself in trouble"
}
},
"summary": "Get contracts tags",
"tags": [
"Contracts"
]
}
},
"/customer/v2/ai/credit-attributes/": {
"get": {
"description": "Returns comprehensive credit risk assessment for a provided user.",
"operationId": "get_credit_attributes",
"parameters": [
{
"description": "ID used to track end-to-end processing of the request",
"in": "header",
"name": "x-correlation-id",
"required": false,
"schema": {
"description": "ID used to track end-to-end processing of the request",
"examples": [
"f47ac10b-58cc-4372-a567-0e02b2c3d479",
"6ba7b810-9dad-41d1-80b4-00c04fd430c8",
"550e8400-e29b-41d4-a716-446655440000"
],
"title": "X-Correlation-Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"default": {
"value": {
"assets": {
"investments": [],
"products": [
{
"balance": 2145.78,
"bic": "XXX12345678",
"creditDrawn": 100.0,
"creditLimit": 2045.78,
"currency": "EUR",
"iban": "DE001234567890123456AI",
"id": "2aa5b423-8d68-4ad3-8b80-5d34d48cb43b",
"lastUpdated": "2023-07-13 14:09:06",
"name": "Girokonto",
"overdraftLimit": 3000.0,
"owner": "Li Wang",
"providerId": "309b5ddf-94e9-4833-8610-7096b8fae79a",
"providerName": "Demo Provider",
"status": "VOLLSTAENDIG",
"type": "GIROKONTO"
}
]
},
"budget": {
"expenses": {
"fixedSpending": {
"statistics": {
"max": 1572.24,
"mean": 1381.62,
"median": 1376.0,
"min": 1214.33
}
},
"totalSpending": {
"statistics": {
"max": 2351.1,
"mean": 1835.04,
"median": 1744.18,
"min": 1568.56
}
},
"variableSpending": {
"statistics": {
"max": 1133.32,
"mean": 453.42,
"median": 363.29,
"min": 35.19
}
}
},
"income": {
"fixedIncome": {
"contracts": [
{
"details": {
"amountFirst": 204.0,
"amountLatest": 204.0,
"amountMaximum": 204.0,
"amountMean": 204.0,
"amountMedian": 204.0,
"amountMinimum": 204.0,
"amountNext": 204.0,
"amountTotal": 2448.0,
"amountTotalNonRegular": 0.0,
"amountTotalRegular": 2448.0,
"contractNumbers": [
"KG237002FK188590"
],
"costDevelopment": {
"2022-08-09": 204.0,
"2022-09-09": 204.0,
"2022-10-09": 204.0,
"2022-11-09": 204.0,
"2022-12-09": 204.0,
"2023-01-09": 204.0,
"2023-02-09": 204.0,
"2023-03-09": 204.0,
"2023-04-09": 204.0,
"2023-05-09": 204.0,
"2023-06-09": 204.0,
"2023-07-09": 204.0
},
"costDevelopmentRegular": {
"2022-08-09": 204.0,
"2022-09-09": 204.0,
"2022-10-09": 204.0,
"2022-11-09": 204.0,
"2022-12-09": 204.0,
"2023-01-09": 204.0,
"2023-02-09": 204.0,
"2023-03-09": 204.0,
"2023-04-09": 204.0,
"2023-05-09": 204.0,
"2023-06-09": 204.0,
"2023-07-09": 204.0
},
"counterpartyBic": "MARKDEF1760",
"counterpartyIban": "DE077600000000760016",
"counterpartyName": "Bundesagentur fur Arbeit - Familienkasse",
"counterpartyNameUltimate": "",
"customerNumbers": [],
"dateFirst": "2022-08-09",
"dateLatest": "2023-07-09",
"dateNext": "2023-08-09",
"dateStart": "2022-08-09",
"daysAge": 338,
"growthRate": 0.0,
"standardDeviation": 0.0,
"status": "ACTIVE",
"transactionIds": [
"46849210-3acc-4817-9b66-64f9a9cd5e98",
"4485e5f6-c177-44b5-83a7-1d7597405aa3",
"c6df990e-7c4f-4447-a565-2dd360c96391",
"97587d3f-9854-42f0-849c-4981150f3862",
"607c84b0-c25b-44cc-b22f-6d04572ce820",
"50b81b1c-f39c-4102-93a9-cb5db565ed29",
"6ca60e80-c006-4003-9b35-486bb407c32d",
"ee76642a-b4c0-4b76-95dd-8b52767fe4ad",
"5e4d77f5-40fd-46c4-93eb-f317a4c93cf0",
"b144924b-10c0-4c3e-8cef-b92d5f970636",
"15fdcf5a-f923-45d4-8236-e77254726c82",
"cd57cc2e-db4c-4af9-bde4-f0a1caa4d419"
],
"transactionIdsNonRegular": [],
"transactionIdsRegular": [
"46849210-3acc-4817-9b66-64f9a9cd5e98",
"4485e5f6-c177-44b5-83a7-1d7597405aa3",
"c6df990e-7c4f-4447-a565-2dd360c96391",
"97587d3f-9854-42f0-849c-4981150f3862",
"607c84b0-c25b-44cc-b22f-6d04572ce820",
"50b81b1c-f39c-4102-93a9-cb5db565ed29",
"6ca60e80-c006-4003-9b35-486bb407c32d",
"ee76642a-b4c0-4b76-95dd-8b52767fe4ad",
"5e4d77f5-40fd-46c4-93eb-f317a4c93cf0",
"b144924b-10c0-4c3e-8cef-b92d5f970636",
"15fdcf5a-f923-45d4-8236-e77254726c82",
"cd57cc2e-db4c-4af9-bde4-f0a1caa4d419"
]
},
"entity": {
"displayName": "BENUTZER",
"entityClass": "USER",
"id": "ae91796e-556a-46b6-83a3-dc1d56657f79",
"userId": "ae91796e-556a-46b6-83a3-dc1d56657f79"
},
"id": "15ba9fbd-c1f3-4f1d-87af-a73a8beb7813",
"tagTreeItemBusinessPartner": {
"addressCity": "N\u00fcrnberg",
"addressCountry": "Deutschland",
"addressStreet": "Regensburger Stra\u00dfe 104",
"addressZip": "90478",
"categories": [],
"displayName": "Bundesagentur f\u00fcr Arbeit (BA)",
"systemId": 4392,
"systemName": "Bundesagentur f\u00fcr Arbeit",
"tagTree": {
"description": "Single level tag tree of business partners.",
"displayName": "Gesch\u00e4ftspartner",
"isTenantGenerated": false,
"systemId": 3,
"systemName": "BUSINESS_PARTNERS",
"version": 1.91
},
"telephone": "0911/179-0",
"website": "https://www.arbeitsagentur.de/"
},
"tagTreeItemCategory": {
"description": "Income from gov. child benefits",
"displayName": "Staatliche F\u00f6rderung f\u00fcr Familie und Kinder",
"systemId": 52,
"systemName": "INCOME_STATEFAMILY",
"systemNameParent": "INCOME",
"tagTree": {
"description": "Two level categorization tree.",
"displayName": "Kategorien",
"isTenantGenerated": false,
"systemId": 1,
"systemName": "CATEGORIES",
"version": 3.71
}
},
"tagTreeItemInsuranceType": {
"displayName": "Nicht versicherungsrelevant - Einnahmen",
"systemId": 28,
"systemName": "INCOME_UNRELATED",
"systemNameParent": "INCOME",
"tagTree": {
"description": "Two level fine grained insurance categorization tag tree.",
"displayName": "Versicherungsarten",
"isTenantGenerated": false,
"systemId": 2,
"systemName": "INSURANCE_TYPES",
"version": 2.41
}
},
"tagTreeItemPeriod": {
"description": "Period of a single month",
"displayName": "Ein Monat",
"systemId": 3,
"systemName": "MONTH_ONE",
"systemNameParent": "MONTH",
"tagTree": {
"description": "Two level periods tag tree.",
"displayName": "Turnus",
"isTenantGenerated": false,
"systemId": 4,
"systemName": "PERIODS",
"version": 0.4
}
}
}
],
"statistics": {
"max": 204.0,
"mean": 204.0,
"median": 204.0,
"min": 204.0
}
},
"salary": {
"contracts": [
{
"details": {
"amountFirst": 4856.84,
"amountLatest": 4856.84,
"amountMaximum": 4856.84,
"amountMean": 4856.84,
"amountMedian": 4856.84,
"amountMinimum": 4856.84,
"amountNext": 4856.84,
"amountTotal": 33997.88,
"amountTotalNonRegular": 0.0,
"amountTotalRegular": 33997.88,
"contractNumbers": [],
"costDevelopment": {
"2022-12-29": 4856.84,
"2023-01-29": 4856.84,
"2023-02-28": 4856.84,
"2023-03-29": 4856.84,
"2023-04-29": 4856.84,
"2023-05-29": 4856.84,
"2023-06-29": 4856.84
},
"costDevelopmentRegular": {
"2022-12-29": 4856.84,
"2023-01-29": 4856.84,
"2023-02-28": 4856.84,
"2023-03-29": 4856.84,
"2023-04-29": 4856.84,
"2023-05-29": 4856.84,
"2023-06-29": 4856.84
},
"counterpartyBic": "",
"counterpartyIban": "DE100456789",
"counterpartyName": "The Company",
"counterpartyNameUltimate": "",
"customName": "The Company",
"customerNumbers": [],
"dateFirst": "2022-12-29",
"dateLatest": "2023-06-29",
"dateNext": "2023-07-31",
"dateStart": "2022-12-29",
"daysAge": 196,
"growthRate": 0.0,
"standardDeviation": 0.0,
"status": "ACTIVE",
"transactionIds": [
"6a8b60ba-644e-41e7-b105-3313e1323399",
"59703c71-a780-4392-a7b5-3dd177467347",
"99d14818-e22a-4f4c-a0d5-83a75efbe36e",
"aef38a3f-2e18-4734-888d-95f5c5249d68",
"ff5af17a-94be-45fa-83da-cf205122231d",
"2bffbd6a-52a8-4d35-83aa-b044eb86711e",
"ecee781a-732b-4f56-935c-956c3a7db3b9"
],
"transactionIdsNonRegular": [],
"transactionIdsRegular": [
"6a8b60ba-644e-41e7-b105-3313e1323399",
"59703c71-a780-4392-a7b5-3dd177467347",
"99d14818-e22a-4f4c-a0d5-83a75efbe36e",
"aef38a3f-2e18-4734-888d-95f5c5249d68",
"ff5af17a-94be-45fa-83da-cf205122231d",
"2bffbd6a-52a8-4d35-83aa-b044eb86711e",
"ecee781a-732b-4f56-935c-956c3a7db3b9"
]
},
"entity": {
"displayName": "BENUTZER",
"entityClass": "USER",
"id": "ae91796e-556a-46b6-83a3-dc1d56657f79",
"userId": "ae91796e-556a-46b6-83a3-dc1d56657f79"
},
"id": "0b09ad15-c24a-45c9-a7d0-f16b7991381c",
"tagTreeItemBusinessPartner": {
"categories": [
"OTHER_OTHER"
],
"description": "Unknown business partner, for business partners with custom name",
"displayName": "Unbekannter Gesch\u00e4ftspartner",
"systemId": 4384,
"systemName": "UNKNOWN",
"tagTree": {
"description": "Single level tag tree of business partners.",
"displayName": "Gesch\u00e4ftspartner",
"isTenantGenerated": false,
"systemId": 3,
"systemName": "BUSINESS_PARTNERS",
"version": 1.91
}
},
"tagTreeItemCategory": {
"description": "Income from salary payments",
"displayName": "Gehalt",
"systemId": 49,
"systemName": "INCOME_SALARY",
"systemNameParent": "INCOME",
"tagTree": {
"description": "Two level categorization tree.",
"displayName": "Kategorien",
"isTenantGenerated": false,
"systemId": 1,
"systemName": "CATEGORIES",
"version": 3.71
}
},
"tagTreeItemInsuranceType": {
"displayName": "Nicht versicherungsrelevant - Einnahmen",
"systemId": 28,
"systemName": "INCOME_UNRELATED",
"systemNameParent": "INCOME",
"tagTree": {
"description": "Two level fine grained insurance categorization tag tree.",
"displayName": "Versicherungsarten",
"isTenantGenerated": false,
"systemId": 2,
"systemName": "INSURANCE_TYPES",
"version": 2.41
}
},
"tagTreeItemPeriod": {
"description": "Period of a single month",
"displayName": "Ein Monat",
"systemId": 3,
"systemName": "MONTH_ONE",
"systemNameParent": "MONTH",
"tagTree": {
"description": "Two level periods tag tree.",
"displayName": "Turnus",
"isTenantGenerated": false,
"systemId": 4,
"systemName": "PERIODS",
"version": 0.4
}
}
}
],
"lengthOfEmployment": 196,
"statistics": {
"max": 4856.84,
"mean": 4856.84,
"median": 4856.84,
"min": 4856.84
}
},
"totalIncome": {
"statistics": {
"max": 5060.84,
"mean": 5060.84,
"median": 5060.84,
"min": 5060.84
}
},
"variableIncome": {
"statistics": {
"max": 0.0,
"mean": 0.0,
"median": 0.0,
"min": 0.0
}
},
"windfalls": []
},
"net": {
"positiveCashflowRatio": 1.0,
"statistics": {
"max": 3492.28,
"mean": 3225.8,
"median": 3316.66,
"min": 2709.74
}
},
"savings": {
"statistics": {
"max": 0.0,
"mean": 0.0,
"median": 0.0,
"min": 0.0
}
}
},
"credit": {
"financialCredit": {
"activeContracts": [],
"passiveContracts": []
},
"leasing": {
"activeContracts": [],
"passiveContracts": []
},
"mortgage": {
"activeContracts": [],
"passiveContracts": []
}
},
"flags": {
"creditCards": 0,
"debtCollection": [],
"reminderCharges": [],
"returnedDebitNotes": [
{
"amount": 209.99,
"id": "27b7c777-4ccd-4f41-a145-4e7e672ec56f",
"postingDatetime": "2022-10-07 00:00:00",
"product": "2aa5b423-8d68-4ad3-8b80-5d34d48cb43b",
"provider": "309b5ddf-94e9-4833-8610-7096b8fae79a",
"tags": {
"businessPartner": {
"entity": {
"displayName": "Kontoumsatz",
"entityClass": "TRANSACTION",
"id": "27b7c777-4ccd-4f41-a145-4e7e672ec56f",
"userId": "ae91796e-556a-46b6-83a3-dc1d56657f79"
},
"id": "6aa296e1-f296-47a7-b2ca-63111708011f",
"tagTreeItem": {
"description": "Unknown business partner, for business partners with custom name",
"displayName": "Unbekannter Gesch\u00e4ftspartner",
"systemId": 4384,
"systemName": "UNKNOWN",
"tagTree": {
"description": "Single level tag tree of business partners.",
"displayName": "Gesch\u00e4ftspartner",
"isTenantGenerated": false,
"systemId": 3,
"systemName": "BUSINESS_PARTNERS",
"version": 1.91
}
}
},
"category": {
"entity": {
"displayName": "Kontoumsatz",
"entityClass": "TRANSACTION",
"id": "27b7c777-4ccd-4f41-a145-4e7e672ec56f",
"userId": "ae91796e-556a-46b6-83a3-dc1d56657f79"
},
"id": "45358886-7619-458e-a45a-d047537a6228",
"tagTreeItem": {
"description": "Transactions involving failed debit payments that are returned.",
"displayName": "R\u00fccklastschriften",
"systemId": 48,
"systemName": "INCOME_RETURNDEBIT",
"systemNameParent": "INCOME",
"tagTree": {
"description": "Two level categorization tree.",
"displayName": "Kategorien",
"isTenantGenerated": false,
"systemId": 1,
"systemName": "CATEGORIES",
"version": 3.71
}
}
},
"insurance": {
"entity": {
"displayName": "Kontoumsatz",
"entityClass": "TRANSACTION",
"id": "27b7c777-4ccd-4f41-a145-4e7e672ec56f",
"userId": "ae91796e-556a-46b6-83a3-dc1d56657f79"
},
"id": "75483a74-9716-43cf-9266-d69714cfb94c",
"tagTreeItem": {
"displayName": "Nicht versicherungsrelevant - Einnahmen",
"systemId": 28,
"systemName": "INCOME_UNRELATED",
"systemNameParent": "INCOME",
"tagTree": {
"description": "Two level fine grained insurance categorization tag tree.",
"displayName": "Versicherungsarten",
"isTenantGenerated": false,
"systemId": 2,
"systemName": "INSURANCE_TYPES",
"version": 2.41
}
}
}
}
}
],
"riskyPayment": {
"statistics": {
"max": 0.0,
"mean": 0.0,
"median": 0.0,
"min": 0.0
}
}
},
"lifeStages": {
"housing": {
"entity": {
"displayName": "BENUTZER",
"entityClass": "USER",
"id": "ae91796e-556a-46b6-83a3-dc1d56657f79",
"userId": "ae91796e-556a-46b6-83a3-dc1d56657f79"
},
"id": "0f1e88e3-e91f-4be9-b826-c8a6bc983c08",
"tagTreeItem": {
"displayName": "Mieter",
"domain": {
"description": "The user's ownership status for their current home",
"displayName": "Wohnsituation",
"systemId": 4,
"systemName": "HOUSING",
"tagTree": {
"description": "Tag tree for life domains",
"displayName": "Lebensdom\u00e4nen",
"isTenantGenerated": false,
"systemId": 10,
"systemName": "LIFE_DOMAINS",
"version": 0.3
}
},
"systemId": 15,
"systemName": "TENANCY",
"tagTree": {
"description": "Single level life stage tag tree.",
"displayName": "Lebensphasen",
"isTenantGenerated": false,
"systemId": 12,
"systemName": "LIFE_STAGES",
"version": 0.6
}
}
},
"labourMarket": {
"entity": {
"displayName": "BENUTZER",
"entityClass": "USER",
"id": "ae91796e-556a-46b6-83a3-dc1d56657f79",
"userId": "ae91796e-556a-46b6-83a3-dc1d56657f79"
},
"id": "46a684bc-7265-44f4-acd2-c35f9b5279ea",
"tagTreeItem": {
"displayName": "Angestellt",
"domain": {
"description": "The user's state with respect to employment and education",
"displayName": "Arbeitsmarkt",
"systemId": 1,
"systemName": "LABOUR_MARKET",
"tagTree": {
"description": "Tag tree for life domains",
"displayName": "Lebensdom\u00e4nen",
"isTenantGenerated": false,
"systemId": 10,
"systemName": "LIFE_DOMAINS",
"version": 0.3
}
},
"systemId": 4,
"systemName": "EMPLOYMENT",
"tagTree": {
"description": "Single level life stage tag tree.",
"displayName": "Lebensphasen",
"isTenantGenerated": false,
"systemId": 12,
"systemName": "LIFE_STAGES",
"version": 0.6
}
}
},
"parenthood": {
"entity": {
"displayName": "BENUTZER",
"entityClass": "USER",
"id": "ae91796e-556a-46b6-83a3-dc1d56657f79",
"userId": "ae91796e-556a-46b6-83a3-dc1d56657f79"
},
"id": "d0aac099-261b-4d97-aec9-239ddbf28d97",
"tagTreeItem": {
"displayName": "Elternteil",
"domain": {
"description": "The user's parental status",
"displayName": "Elternschaft",
"systemId": 2,
"systemName": "PARENTHOOD",
"tagTree": {
"description": "Tag tree for life domains",
"displayName": "Lebensdom\u00e4nen",
"isTenantGenerated": false,
"systemId": 10,
"systemName": "LIFE_DOMAINS",
"version": 0.3
}
},
"systemId": 7,
"systemName": "PARENTHOOD",
"tagTree": {
"description": "Single level life stage tag tree.",
"displayName": "Lebensphasen",
"isTenantGenerated": false,
"systemId": 12,
"systemName": "LIFE_STAGES",
"version": 0.6
}
}
},
"relationship": {}
}
}
}
},
"schema": {
"$ref": "#/components/schemas/CreditAttributesTagInstance"
}
}
},
"description": "Success, tags newly created or read from database"
},
"400": {
"description": "Bad request syntax or unsupported method"
},
"403": {
"description": "Tenant not set up for AI endpoints"
},
"408": {
"description": "Request timed out; try again later"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
},
"500": {
"description": "Server got itself in trouble"
}
},
"summary": "Get credit attributes tags",
"tags": [
"Credit Attributes"
]
}
},
"/customer/v2/ai/disposable-money/": {
"get": {
"description": "Returns disposable money analysis based on salary cycle and spending patterns for a provided user.",
"operationId": "get_disposable_money",
"parameters": [
{
"description": "ID used to track end-to-end processing of the request",
"in": "header",
"name": "x-correlation-id",
"required": false,
"schema": {
"description": "ID used to track end-to-end processing of the request",
"examples": [
"f47ac10b-58cc-4372-a567-0e02b2c3d479",
"6ba7b810-9dad-41d1-80b4-00c04fd430c8",
"550e8400-e29b-41d4-a716-446655440000"
],
"title": "X-Correlation-Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"default": {
"description": "Example with disposable money information, active salary detected.",
"summary": "default",
"value": {
"details": {
"amountCashflow": -1105.93,
"amountCurrentlyLeft": 3750.91,
"amountDisposableMoney": 3704.26,
"amountExpectedFixedCashflow": -24.98,
"amountExpectedFlexCashflow": -21.67,
"amountExpectedLeft": 3725.93,
"amountExpectedLeftDaily": 1241.98,
"amountSalaryLatest": 4856.84,
"amountSalaryNext": 4856.84,
"dateSalaryLatest": "2025-07-29",
"dateSalaryNext": "2025-08-29",
"daysUntilSalary": 3
},
"entity": {
"displayName": "BENUTZER",
"entityClass": "USER",
"id": "29779cf3-06df-401a-ba6c-e93df17895e8",
"userId": "29779cf3-06df-401a-ba6c-e93df17895e8"
},
"id": "182ee4fc-ed82-6e00-2ab3-ed0721b20ddc",
"relations": [
{
"href": "https://banksapi.io/tags/v1/tag-trees/",
"rel": "tag_trees"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/9/",
"rel": "tag_tree"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/9/tag-tree-items/",
"rel": "tag_tree_items"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/9/tag-tree-items/2/",
"rel": "tag_tree_item"
}
],
"tagTreeItem": {
"description": "Information about the disposable money",
"displayName": "Informationen \u00fcber frei verf\u00fcgbares Geld",
"systemId": 2,
"systemName": "DISPOSABLEMONEY_INFORMATION",
"tagTree": {
"description": "Disposable money tag tree with single parent and child tag.",
"displayName": "Einkommens\u00fcberschuss",
"isTenantGenerated": false,
"systemId": 9,
"systemName": "DISPOSABLE_MONEY",
"version": 0.1
}
}
}
},
"empty": {
"description": "Example with no disposable money information, no active salary detected.",
"summary": "empty",
"value": {}
}
},
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/DisposableMoneyTagInstance"
},
{
"$ref": "#/components/schemas/Empty"
}
],
"title": "Response Get Disposable Money"
}
}
},
"description": "Success, tag newly created or read from database"
},
"400": {
"description": "Bad request syntax or unsupported method"
},
"403": {
"description": "Tenant not set up for AI endpoints"
},
"408": {
"description": "Request timed out; try again later"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
},
"500": {
"description": "Server got itself in trouble"
}
},
"summary": "Get disposable money tag",
"tags": [
"Disposable Money"
]
}
},
"/customer/v2/ai/life-events/": {
"get": {
"description": "Returns the life events for a provided user.",
"operationId": "get_life_events",
"parameters": [
{
"description": "ID used to track end-to-end processing of the request",
"in": "header",
"name": "x-correlation-id",
"required": false,
"schema": {
"description": "ID used to track end-to-end processing of the request",
"examples": [
"f47ac10b-58cc-4372-a567-0e02b2c3d479",
"6ba7b810-9dad-41d1-80b4-00c04fd430c8",
"550e8400-e29b-41d4-a716-446655440000"
],
"title": "X-Correlation-Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"default": {
"value": [
{
"details": {
"eventDate": "2019-07-01"
},
"entity": {
"displayName": "USER",
"entityClass": "USER",
"id": "9b4a6348-5320-4a07-a789-faecc0a9821a"
},
"id": "094f9afc-9a30-4071-bc9d-0ae6a6860eaa",
"relations": [
{
"href": "https://banksapi.io/tags/v1/tag-trees/",
"rel": "tag_trees"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/10/",
"rel": "tag_tree"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/10/tag-tree-items/",
"rel": "tag_tree_items"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/10/tag-tree-items/931/",
"rel": "tag_tree_item"
}
],
"tagTreeItem": {
"displayName": "Ende Mietverh\u00e4ltnis",
"systemId": 931,
"systemName": "TENANCY_END",
"tagTree": {
"description": "Single level life event tag tree, usually with both start and end tags.",
"displayName": "Lebensereignisse",
"isClientGenerated": false,
"systemId": 10,
"systemName": "LIFE_EVENTS",
"version": 0.3
}
}
}
]
}
},
"schema": {
"items": {
"$ref": "#/components/schemas/LifeEventsTagInstance"
},
"title": "Response Get Life Events",
"type": "array"
}
}
},
"description": "Success, tags newly created or read from database"
},
"400": {
"description": "Bad request syntax or unsupported method"
},
"403": {
"description": "Tenant not set up for AI endpoints"
},
"408": {
"description": "Request timed out; try again later"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
},
"500": {
"description": "Server got itself in trouble"
}
},
"summary": "Get life events tags",
"tags": [
"Life"
]
}
},
"/customer/v2/ai/life-stages/": {
"get": {
"description": "Returns the life stages for a provided user.",
"operationId": "get_life_stages",
"parameters": [
{
"description": "If set to True, candidate tags are returned in case of ambiguity. Furthermore, explanations regarding tags are added.",
"in": "query",
"name": "verbose",
"required": false,
"schema": {
"default": false,
"description": "If set to True, candidate tags are returned in case of ambiguity. Furthermore, explanations regarding tags are added.",
"examples": [
true,
false
],
"title": "Verbose",
"type": "boolean"
}
},
{
"description": "ID used to track end-to-end processing of the request",
"in": "header",
"name": "x-correlation-id",
"required": false,
"schema": {
"description": "ID used to track end-to-end processing of the request",
"examples": [
"f47ac10b-58cc-4372-a567-0e02b2c3d479",
"6ba7b810-9dad-41d1-80b4-00c04fd430c8",
"550e8400-e29b-41d4-a716-446655440000"
],
"title": "X-Correlation-Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"default": {
"value": [
{
"entity": {
"displayName": "USER",
"entityClass": "USER",
"id": "1d00f12d-b0f0-499e-9414-06e8b279821a"
},
"id": "494199de-82cb-4a7f-90fd-140aaa030711",
"relations": [
{
"href": "https://banksapi.io/tags/v1/tag-trees/",
"rel": "tag_trees"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/8/",
"rel": "tag_tree"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/8/tag-tree-items/",
"rel": "tag_tree_items"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/8/tag-tree-items/923/",
"rel": "tag_tree_item"
}
],
"tagTreeItem": {
"displayName": "Mieter",
"systemId": 923,
"systemName": "TENANCY",
"tagTree": {
"description": "Single level life stage tag tree.",
"displayName": "Lebensphasen",
"isClientGenerated": false,
"systemId": 8,
"systemName": "LIFE_STAGES",
"version": 0.4
}
}
},
{
"entity": {
"displayName": "USER",
"entityClass": "USER",
"id": "1d00f12d-b0f0-499e-9414-06e8b279821a"
},
"id": "89a9a8fc-1eca-4b1f-ae98-12cb151a63ea",
"relations": [
{
"href": "https://banksapi.io/tags/v1/tag-trees/",
"rel": "tag_trees"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/8/",
"rel": "tag_tree"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/8/tag-tree-items/",
"rel": "tag_tree_items"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/8/tag-tree-items/915/",
"rel": "tag_tree_item"
}
],
"tagTreeItem": {
"displayName": "Elternteil",
"systemId": 915,
"systemName": "PARENTHOOD",
"tagTree": {
"description": "Single level life stage tag tree.",
"displayName": "Lebensphasen",
"isClientGenerated": false,
"systemId": 8,
"systemName": "LIFE_STAGES",
"version": 0.4
}
}
},
{
"entity": {
"displayName": "USER",
"entityClass": "USER",
"id": "1d00f12d-b0f0-499e-9414-06e8b279821a"
},
"id": "7cebae3f-4284-438b-a8ea-98ee09395f0e",
"relations": [
{
"href": "https://banksapi.io/tags/v1/tag-trees/",
"rel": "tag_trees"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/8/",
"rel": "tag_tree"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/8/tag-tree-items/",
"rel": "tag_tree_items"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/8/tag-tree-items/912/",
"rel": "tag_tree_item"
}
],
"tagTreeItem": {
"displayName": "Angestellt",
"systemId": 912,
"systemName": "EMPLOYMENT",
"tagTree": {
"description": "Single level life stage tag tree.",
"displayName": "Lebensphasen",
"isClientGenerated": false,
"systemId": 8,
"systemName": "LIFE_STAGES",
"version": 0.4
}
}
}
]
}
},
"schema": {
"items": {
"$ref": "#/components/schemas/LifeStagesTagInstance"
},
"title": "Response Get Life Stages",
"type": "array"
}
}
},
"description": "Success, tags newly created or read from database"
},
"400": {
"description": "Bad request syntax or unsupported method"
},
"403": {
"description": "Tenant not set up for AI endpoints"
},
"408": {
"description": "Request timed out; try again later"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
},
"500": {
"description": "Server got itself in trouble"
}
},
"summary": "Get life stages tags",
"tags": [
"Life"
]
}
},
"/customer/v2/ai/sales-triggers/": {
"get": {
"description": "Returns sales triggers analysis for a provided user.",
"operationId": "get_sales_triggers",
"parameters": [
{
"description": "Sales trigger savings potential: Threshold amount",
"in": "query",
"name": "threshold",
"required": false,
"schema": {
"default": 250,
"description": "Sales trigger savings potential: Threshold amount",
"examples": [
100,
250,
500,
1000
],
"title": "Threshold",
"type": "integer"
}
},
{
"description": "Sales trigger salary raise: Increase threshold",
"in": "query",
"name": "salaryRaiseThreshold",
"required": false,
"schema": {
"default": 0.2,
"description": "Sales trigger salary raise: Increase threshold",
"examples": [
0.1,
0.2,
0.25
],
"title": "Salaryraisethreshold",
"type": "number"
}
},
{
"description": "ID used to track end-to-end processing of the request",
"in": "header",
"name": "x-correlation-id",
"required": false,
"schema": {
"description": "ID used to track end-to-end processing of the request",
"examples": [
"f47ac10b-58cc-4372-a567-0e02b2c3d479",
"6ba7b810-9dad-41d1-80b4-00c04fd430c8",
"550e8400-e29b-41d4-a716-446655440000"
],
"title": "X-Correlation-Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"default": {
"value": [
{
"entity": {
"displayName": "USER",
"entityClass": "USER",
"id": "f1af4066-33cd-4f63-94b6-dafc633b9aff"
},
"id": "fa7dd6b1-0f58-4389-8cc8-954eb30095dd",
"relations": [
{
"href": "https://banksapi.io/tags/v1/tag-trees/",
"rel": "tag_trees"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/5/",
"rel": "tag_tree"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/5/tag-tree-items/",
"rel": "tag_tree_items"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/5/tag-tree-items/247/",
"rel": "tag_tree_item"
}
],
"tagTreeItem": {
"description": "Trigger for a missing private liability insurance",
"displayName": "Trigger f\u00fcr eine fehlende Privathaftpflichtversicherung",
"systemId": 247,
"systemName": "MISSING_INSURANCE_LIABILITY_PRIVATE",
"systemNameParent": "MISSING",
"tagTree": {
"description": "Two level sales trigger tag tree.",
"displayName": "Sales Trigger",
"isClientGenerated": false,
"systemId": 5,
"systemName": "SALES_TRIGGERS",
"version": 0.1
}
}
}
]
}
},
"schema": {
"items": {
"$ref": "#/components/schemas/SalesTriggersTagInstance"
},
"title": "Response Get Sales Triggers",
"type": "array"
}
}
},
"description": "Success, tags newly created or read from database"
},
"400": {
"description": "Bad request syntax or unsupported method"
},
"403": {
"description": "Tenant not set up for AI endpoints"
},
"408": {
"description": "Request timed out; try again later"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
},
"500": {
"description": "Server got itself in trouble"
}
},
"summary": "Get sales triggers tags",
"tags": [
"Sales Triggers"
]
}
},
"/customer/v2/ai/tagging-rules/": {
"delete": {
"description": "Deletes all existing tagging rules for a user.",
"operationId": "delete_tagging_rules",
"parameters": [
{
"description": "ID of a tag tree. If missing, all rules are selected.",
"in": "query",
"name": "tagTreeId",
"required": false,
"schema": {
"description": "ID of a tag tree. If missing, all rules are selected.",
"examples": [
1,
5,
9
],
"minimum": 1,
"title": "Tagtreeid",
"type": "integer"
}
},
{
"description": "ID used to track end-to-end processing of the request",
"in": "header",
"name": "x-correlation-id",
"required": false,
"schema": {
"description": "ID used to track end-to-end processing of the request",
"examples": [
"f47ac10b-58cc-4372-a567-0e02b2c3d479",
"6ba7b810-9dad-41d1-80b4-00c04fd430c8",
"550e8400-e29b-41d4-a716-446655440000"
],
"title": "X-Correlation-Id",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Success, rules deleted"
},
"400": {
"description": "Bad request syntax or unsupported method"
},
"403": {
"description": "Tenant not set up for AI endpoints"
},
"408": {
"description": "Request timed out; try again later"
},
"409": {
"description": "Request conflict"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Server got itself in trouble"
}
},
"summary": "Delete rules",
"tags": [
"Tagging Rules"
]
},
"get": {
"description": "Returns a list of all tagging rules for a specific user.",
"operationId": "get_tagging_rules",
"parameters": [
{
"description": "ID of a tag tree. If missing, all rules are selected.",
"in": "query",
"name": "tagTreeId",
"required": false,
"schema": {
"description": "ID of a tag tree. If missing, all rules are selected.",
"examples": [
1,
5,
9
],
"minimum": 1,
"title": "Tagtreeid",
"type": "integer"
}
},
{
"description": "ID used to track end-to-end processing of the request",
"in": "header",
"name": "x-correlation-id",
"required": false,
"schema": {
"description": "ID used to track end-to-end processing of the request",
"examples": [
"f47ac10b-58cc-4372-a567-0e02b2c3d479",
"6ba7b810-9dad-41d1-80b4-00c04fd430c8",
"550e8400-e29b-41d4-a716-446655440000"
],
"title": "X-Correlation-Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"default": {
"value": [
{
"counterpartyIban": "DE42500105174896827935",
"counterpartyName": "M\u00fcller Drogerie",
"id": "43a70053-dc94-40fb-b523-49d2e7782780",
"tagTreeItem": {
"description": "Payments from grocery shopping",
"displayName": "Lebensmittel",
"systemId": 67,
"systemName": "LIVING_GROCERIES",
"systemNameParent": "LIVING",
"tagTree": {
"description": "Two level categorization tree.",
"displayName": "Kategorien",
"isTenantGenerated": false,
"systemId": 1,
"systemName": "CATEGORIES",
"version": 3.71
}
},
"user": "0e3cb7d1-f17e-3924-4d78a-21d3590dfe58"
}
]
}
},
"schema": {
"items": {
"$ref": "#/components/schemas/TaggingRule"
},
"title": "Response Get Tagging Rules",
"type": "array"
}
}
},
"description": "Success, rules read from database"
},
"400": {
"description": "Bad request syntax or unsupported method"
},
"403": {
"description": "Tenant not set up for AI endpoints"
},
"408": {
"description": "Request timed out; try again later"
},
"409": {
"description": "Request conflict"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Server got itself in trouble"
}
},
"summary": "Get rules",
"tags": [
"Tagging Rules"
]
},
"post": {
"description": "Creates a new tagging rule for automatic transaction categorization based on counterparty information.",
"operationId": "post_tagging_rules",
"parameters": [
{
"description": "ID used to track end-to-end processing of the request",
"in": "header",
"name": "x-correlation-id",
"required": false,
"schema": {
"description": "ID used to track end-to-end processing of the request",
"examples": [
"f47ac10b-58cc-4372-a567-0e02b2c3d479",
"6ba7b810-9dad-41d1-80b4-00c04fd430c8",
"550e8400-e29b-41d4-a716-446655440000"
],
"title": "X-Correlation-Id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AiConnectRule"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"examples": {
"default": {
"value": {
"counterpartyIban": "DE42500105174896827935",
"counterpartyName": "M\u00fcller Drogerie",
"id": "57fd8e38-0dde-4464-8cfb-a7cc73bfe919",
"tagTreeItem": {
"description": "Payments from grocery shopping",
"displayName": "Lebensmittel",
"systemId": 67,
"systemName": "LIVING_GROCERIES",
"systemNameParent": "LIVING",
"tagTree": {
"description": "Two level categorization tree.",
"displayName": "Kategorien",
"isTenantGenerated": false,
"systemId": 1,
"systemName": "CATEGORIES",
"version": 3.71
}
},
"user": "b87f5f9c-9a3e-4a90-8fa3-3ad20d22c4d3"
}
}
},
"schema": {
"$ref": "#/components/schemas/TaggingRule"
}
}
},
"description": "Success, new rule created"
},
"400": {
"description": "Bad request syntax or unsupported method"
},
"403": {
"description": "Tenant not set up for AI endpoints"
},
"408": {
"description": "Request timed out; try again later"
},
"409": {
"description": "Request conflict"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Server got itself in trouble"
}
},
"summary": "Create a rule",
"tags": [
"Tagging Rules"
]
}
},
"/customer/v2/ai/tagging-rules/{ruleId}/": {
"delete": {
"description": "Deletes a specific tagging rule by ID for a user.",
"operationId": "delete_tagging_rule",
"parameters": [
{
"description": "The ID of the rule",
"in": "path",
"name": "ruleId",
"required": true,
"schema": {
"description": "The ID of the rule",
"examples": [
"536a39fb-1940-44b7-93bf-68914eaa0b11",
"88fe1461-3905-4b4f-a919-478ff15d2cf4"
],
"title": "Ruleid",
"type": "string"
}
},
{
"description": "ID used to track end-to-end processing of the request",
"in": "header",
"name": "x-correlation-id",
"required": false,
"schema": {
"description": "ID used to track end-to-end processing of the request",
"examples": [
"f47ac10b-58cc-4372-a567-0e02b2c3d479",
"6ba7b810-9dad-41d1-80b4-00c04fd430c8",
"550e8400-e29b-41d4-a716-446655440000"
],
"title": "X-Correlation-Id",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Success, rule deleted"
},
"400": {
"description": "Bad request syntax or unsupported method"
},
"403": {
"description": "Tenant not set up for AI endpoints"
},
"408": {
"description": "Request timed out; try again later"
},
"409": {
"description": "Request conflict"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Server got itself in trouble"
}
},
"summary": "Delete a rule",
"tags": [
"Tagging Rules"
]
},
"get": {
"description": "Returns a specific tagging rule by ID for a user.",
"operationId": "get_tagging_rule",
"parameters": [
{
"description": "The ID of the rule",
"in": "path",
"name": "ruleId",
"required": true,
"schema": {
"description": "The ID of the rule",
"examples": [
"536a39fb-1940-44b7-93bf-68914eaa0b11",
"88fe1461-3905-4b4f-a919-478ff15d2cf4"
],
"title": "Ruleid",
"type": "string"
}
},
{
"description": "ID used to track end-to-end processing of the request",
"in": "header",
"name": "x-correlation-id",
"required": false,
"schema": {
"description": "ID used to track end-to-end processing of the request",
"examples": [
"f47ac10b-58cc-4372-a567-0e02b2c3d479",
"6ba7b810-9dad-41d1-80b4-00c04fd430c8",
"550e8400-e29b-41d4-a716-446655440000"
],
"title": "X-Correlation-Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"default": {
"value": {
"counterpartyIban": "DE42500105174896827935",
"counterpartyName": "M\u00fcller Drogerie",
"id": "67c7fa18-428c-49b5-a2e4-d930485af331",
"tagTreeItem": {
"description": "Payments from grocery shopping",
"displayName": "Lebensmittel",
"systemId": 67,
"systemName": "LIVING_GROCERIES",
"systemNameParent": "LIVING",
"tagTree": {
"description": "Two level categorization tree.",
"displayName": "Kategorien",
"isTenantGenerated": false,
"systemId": 1,
"systemName": "CATEGORIES",
"version": 3.71
}
},
"user": "0e3cb7d1-f17e-3924-4d78a-21d3590dfe58"
}
}
},
"schema": {
"$ref": "#/components/schemas/TaggingRule"
}
}
},
"description": "Success, rule read from database"
},
"400": {
"description": "Bad request syntax or unsupported method"
},
"403": {
"description": "Tenant not set up for AI endpoints"
},
"408": {
"description": "Request timed out; try again later"
},
"409": {
"description": "Request conflict"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Server got itself in trouble"
}
},
"summary": "Get a rule",
"tags": [
"Tagging Rules"
]
}
},
"/customer/v2/bankzugaenge/{accessId}/{productId}/kontoumsaetze/{transactionId}": {
"put": {
"description": "Applies corrections to the categorization of transactions.\n\nInput contains the tag tree item(s) that should be used for re-categorization.\nAll provided tag tree items have to be valid.\nIf a single tag tree item is provided, all transaction tags receive this tag tree item.\nIf multiple tag tree items are provided, each transaction tag receives a different tag tree\nitem. Make sure to provide exactly as many tag tree items as transactions in this scenario.\n\nThe flag createRule creates a user specific rule that automatically categorizes this\ncounterparty with the provided tag tree item in all future transactions. This is a smart\nsolution to eradicate a recurring re-categorization process.\n\nThe flag changeExisting re-categorizes all existing transactions of the same counterparty.\n\nThe tagTreeItem(s) have to include a tagTree and have to be wrapped in tags: [].\n\nThe re-categorization relies on the systemName value of tagTreeItem and tagTree, all other\nfields are ignored.\n\nExample:\n```json\n{\n \"tags\": [\n {\n \"tagTreeItem\": {\n \"systemId\": 67,\n \"systemName\": \"LIVING_GROCERIES\",\n \"tagTree\": {\n \"systemId\": 1,\n \"systemName\": \"CATEGORIES\"\n }\n }\n }\n ]\n}\n```\n\nTo get the full list of categories, use:
\n`GET /tags/v1/tags/tag-trees/1/tag-tree-items/`",
"operationId": "put_categories",
"parameters": [
{
"description": "This option re-categorizes all existing transactions with this counterparty according to the provided category",
"in": "query",
"name": "changeExisting",
"required": false,
"schema": {
"default": false,
"description": "This option re-categorizes all existing transactions with this counterparty according to the provided category",
"examples": [
false,
true
],
"title": "Changeexisting",
"type": "boolean"
}
},
{
"description": "This option creates a rule for this counterparty. All future transactions with this counterparty will be categorized according to the provided category.",
"in": "query",
"name": "createRule",
"required": false,
"schema": {
"default": false,
"description": "This option creates a rule for this counterparty. All future transactions with this counterparty will be categorized according to the provided category.",
"examples": [
false,
true
],
"title": "Createrule",
"type": "boolean"
}
},
{
"description": "ID used to track end-to-end processing of the request",
"in": "header",
"name": "x-correlation-id",
"required": false,
"schema": {
"description": "ID used to track end-to-end processing of the request",
"examples": [
"f47ac10b-58cc-4372-a567-0e02b2c3d479",
"6ba7b810-9dad-41d1-80b4-00c04fd430c8",
"550e8400-e29b-41d4-a716-446655440000"
],
"title": "X-Correlation-Id",
"type": "string"
}
},
{
"description": "ID of the bank access",
"in": "path",
"name": "accessId",
"required": true,
"schema": {
"description": "ID of the bank access",
"examples": [
"a61f7249-7b32-42db-add0-1d4ee565aafc",
"0a461cd1-116b-4039-be98-543442ac4d75"
],
"title": "AccessId",
"type": "string"
}
},
{
"description": "ID of the bank product",
"in": "path",
"name": "productId",
"required": true,
"schema": {
"description": "ID of the bank product",
"examples": [
"DE62500105174269735379",
"DE85500105178475866425"
],
"title": "ProductId",
"type": "string"
}
},
{
"description": "ID of the transaction",
"in": "path",
"name": "transactionId",
"required": true,
"schema": {
"description": "ID of the transaction",
"examples": [
"ee8bb972-3a7d-4bb4-bfb8-a96abf4eecfd",
"473d3595-e08a-4e0c-a88b-ba0f77112d1b"
],
"title": "TransactionId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AiConnectTransactionPut"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "Request fulfilled, nothing follows"
},
"400": {
"description": "Bad request syntax or unsupported method"
},
"403": {
"description": "Tenant not set up for AI endpoints"
},
"408": {
"description": "Request timed out; try again later"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
},
"500": {
"description": "Server got itself in trouble"
}
},
"summary": "Update categories tags",
"tags": [
"Categories"
]
}
},
"/customer/v2/bankzugaenge/{accessId}/{productId}/kontoumsaetze?tag=business-partners": {
"get": {
"description": "Returns transactions with business partner information for a provided bank product.",
"operationId": "get_business_partners",
"parameters": [
{
"description": "ID used to track end-to-end processing of the request",
"in": "header",
"name": "x-correlation-id",
"required": false,
"schema": {
"description": "ID used to track end-to-end processing of the request",
"examples": [
"f47ac10b-58cc-4372-a567-0e02b2c3d479",
"6ba7b810-9dad-41d1-80b4-00c04fd430c8",
"550e8400-e29b-41d4-a716-446655440000"
],
"title": "X-Correlation-Id",
"type": "string"
}
},
{
"description": "ID of the bank access",
"in": "path",
"name": "accessId",
"required": true,
"schema": {
"description": "ID of the bank access",
"examples": [
"a61f7249-7b32-42db-add0-1d4ee565aafc",
"0a461cd1-116b-4039-be98-543442ac4d75"
],
"title": "AccessId",
"type": "string"
}
},
{
"description": "ID of the bank product",
"in": "path",
"name": "productId",
"required": true,
"schema": {
"description": "ID of the bank product",
"examples": [
"DE62500105174269735379",
"DE85500105178475866425"
],
"title": "ProductId",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"default": {
"value": [
{
"betrag": -39.09,
"buchungsdatum": "2023-07-11 17:00:00",
"gegenkontoBic": "",
"gegenkontoIban": "",
"gegenkontoInhaber": "",
"hash": "25118333-5204-400b-b16e-91a85f6c3ef8",
"id": "e3944e8f-6830-4b73-b64a-5f311f0acf85",
"primanotaNummer": "12345",
"tags": [
{
"entity": {
"displayName": "Kontoumsatz",
"entityClass": "TRANSACTION",
"id": "e3944e8f-6830-4b73-b64a-5f311f0acf85"
},
"id": "1b38009a-4eab-4b45-a2cd-3b2a02c8c6d9",
"relations": [
{
"href": "https://banksapi.io/tags/v1/tag-trees/",
"rel": "tag_trees"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/3/",
"rel": "tag_tree"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/3/tag-tree-items/",
"rel": "tag_tree_items"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/3/tag-tree-items/202/",
"rel": "tag_tree_item"
}
],
"tagTreeItem": {
"addressCity": "Stuttgart",
"addressCountry": "Deutschland",
"addressStreet": "Reinsburgstra\u00dfe 19",
"addressZip": "70178",
"creditorId": "DE07ZZZ00000063475",
"displayName": "Allianz Lebensversicherung",
"group": "Allianz",
"systemId": 202,
"systemName": "Allianz Lebensversicherungs-AG",
"tagTree": {
"description": "Single level tag tree of business partners.",
"displayName": "Gesch\u00e4ftspartner",
"isClientGenerated": false,
"systemId": 3,
"systemName": "BUSINESS_PARTNERS",
"version": 1.9
},
"telephone": "0711-663-0",
"website": "http://www.allianz.de"
}
}
],
"verwendungszweck": "CRED DE07ZZZ00000063475 Beitrag Lebensvers 2023 07 SEPA BASISLASTSCHRIFT wiederholend",
"wertstellungsdatum": "2023-07-11 17:00:00"
}
]
}
},
"schema": {
"items": {
"$ref": "#/components/schemas/AiConnectTransaction"
},
"type": "array"
}
}
},
"description": "Success, tags newly created or read from database"
},
"400": {
"description": "Bad request syntax or unsupported method"
},
"403": {
"description": "Tenant not set up for AI endpoints"
},
"408": {
"description": "Request timed out; try again later"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
},
"500": {
"description": "Server got itself in trouble"
}
},
"summary": "Get business partners tags",
"tags": [
"Business Partners"
]
}
},
"/customer/v2/bankzugaenge/{accessId}/{productId}/kontoumsaetze?tag=categories": {
"get": {
"description": "Returns categorized transactions for a provided bank product.",
"operationId": "get_categories",
"parameters": [
{
"description": "ID used to track end-to-end processing of the request",
"in": "header",
"name": "x-correlation-id",
"required": false,
"schema": {
"description": "ID used to track end-to-end processing of the request",
"examples": [
"f47ac10b-58cc-4372-a567-0e02b2c3d479",
"6ba7b810-9dad-41d1-80b4-00c04fd430c8",
"550e8400-e29b-41d4-a716-446655440000"
],
"title": "X-Correlation-Id",
"type": "string"
}
},
{
"description": "ID of the bank access",
"in": "path",
"name": "accessId",
"required": true,
"schema": {
"description": "ID of the bank access",
"examples": [
"a61f7249-7b32-42db-add0-1d4ee565aafc",
"0a461cd1-116b-4039-be98-543442ac4d75"
],
"title": "AccessId",
"type": "string"
}
},
{
"description": "ID of the bank product",
"in": "path",
"name": "productId",
"required": true,
"schema": {
"description": "ID of the bank product",
"examples": [
"DE62500105174269735379",
"DE85500105178475866425"
],
"title": "ProductId",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"default": {
"value": [
{
"betrag": -14.87,
"buchungsdatum": "2023-07-04 18:00:00",
"gegenkontoBic": "",
"gegenkontoIban": "",
"gegenkontoInhaber": "LV AG",
"hash": "9a192d67-56e0-4535-a513-19a6d5b6f704",
"id": "14dfe79e-c452-405f-af95-b992ae389ab9",
"primanotaNummer": "12345",
"tags": [
{
"details": {
"confidenceLevel": 0.9897049813270569
},
"entity": {
"displayName": "Kontoumsatz",
"entityClass": "Kontoumsatz",
"id": "14dfe79e-c452-405f-af95-b992ae389ab9",
"userId": "31d8a8b9-8a37-477d-8ee4-bd5e952bee99"
},
"id": "e28b29ce-1a51-4de3-8520-3ee90b757106",
"relations": [
{
"href": "https://banksapi.io/tags/v1/tag-trees/",
"rel": "tag_trees"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/1/",
"rel": "tag_tree"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/1/tag-tree-items/",
"rel": "tag_tree_items"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/1/tag-tree-items/67/",
"rel": "tag_tree_item"
}
],
"tagTreeItem": {
"description": "Payments related to a life insurance contract",
"displayName": "Lebensversicherung",
"systemId": 58,
"systemName": "INSURANCE_LIFE",
"systemNameParent": "INSURANCE",
"tagTree": {
"description": "Two level categorization tree.",
"displayName": "Kategorien",
"isClientGenerated": false,
"systemId": 1,
"systemName": "CATEGORIES",
"version": 4.03
}
}
}
],
"verwendungszweck": "CRED DE07ZZZ00000063475 Beitrag Lebensvers 2020 01 SEPA BASISLASTSCHRIFT wiederholend",
"wertstellungsdatum": "2023-07-04 18:00:00"
}
]
}
},
"schema": {
"items": {
"$ref": "#/components/schemas/AiConnectTransaction"
},
"type": "array"
}
}
},
"description": "Success, tags newly created or read from database"
},
"400": {
"description": "Bad request syntax or unsupported method"
},
"403": {
"description": "Tenant not set up for AI endpoints"
},
"408": {
"description": "Request timed out; try again later"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
},
"500": {
"description": "Server got itself in trouble"
}
},
"summary": "Get categories tags",
"tags": [
"Categories"
]
}
},
"/customer/v2/bankzugaenge/{accessId}/{productId}/kontoumsaetze?tag=freelancer-categories": {
"get": {
"description": "Returns freelancer-specific categorized transactions for a provided bank product.",
"operationId": "get_freelancer_categories",
"parameters": [
{
"description": "ID used to track end-to-end processing of the request",
"in": "header",
"name": "x-correlation-id",
"required": false,
"schema": {
"description": "ID used to track end-to-end processing of the request",
"examples": [
"f47ac10b-58cc-4372-a567-0e02b2c3d479",
"6ba7b810-9dad-41d1-80b4-00c04fd430c8",
"550e8400-e29b-41d4-a716-446655440000"
],
"title": "X-Correlation-Id",
"type": "string"
}
},
{
"description": "ID of the bank access",
"in": "path",
"name": "accessId",
"required": true,
"schema": {
"description": "ID of the bank access",
"examples": [
"a61f7249-7b32-42db-add0-1d4ee565aafc",
"0a461cd1-116b-4039-be98-543442ac4d75"
],
"title": "AccessId",
"type": "string"
}
},
{
"description": "ID of the bank product",
"in": "path",
"name": "productId",
"required": true,
"schema": {
"description": "ID of the bank product",
"examples": [
"DE62500105174269735379",
"DE85500105178475866425"
],
"title": "ProductId",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"default": {
"value": [
{
"betrag": -31.18,
"buchungsdatum": "2023-07-08 13:29:00",
"buchungstext": "",
"gegenkontoBic": "PBNKDEFF",
"gegenkontoIban": "DE08250100300000289304",
"gegenkontoInhaber": "Telekom Deutschland GmbH",
"gvCode": "56",
"hash": "c07f30f9-f06c-4dc6-b25b-2926a27e6dd3",
"id": "5bfcc9a3-854e-450c-a20b-1843a1d2aad2",
"primanotaNummer": "485656",
"tags": [
{
"entity": {
"displayName": "Kontoumsatz",
"entityClass": "TRANSACTION",
"id": "5bfcc9a3-854e-450c-a20b-1843a1d2aad2",
"userId": "0c168a52-3071-4f72-b79d-78422befa8e3"
},
"id": "0c69cf9a-109b-4cfa-9914-5045957325fe",
"relations": [
{
"href": "https://banksapi.io/tags/v1/tag-trees/",
"rel": "tag_trees"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/15/",
"rel": "tag_tree"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/15/tag-tree-items/",
"rel": "tag_tree_items"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/15/tag-tree-items/41/",
"rel": "tag_tree_item"
}
],
"tagTreeItem": {
"displayName": "Aufwendungen f\u00fcr Telekommunikation",
"systemId": 41,
"systemName": "TELECOMMUNICATIONS",
"tagTree": {
"description": "Freelancer categories tag tree.",
"displayName": "Freelancer-Kategorien",
"isTenantGenerated": false,
"systemId": 15,
"systemName": "FREELANCER_CATEGORIES",
"version": 0.1
}
}
}
],
"verwendungszweck": "Telekom Deutschland GmbH Festnetz Vertragskonto 5574442211 End to End Ref Zahlbeleg 93112306740 Mandatsref 00001234534 CRED DE93ZZZ00000078611 SEPA BASISLASTSCHRIFT wiederholend",
"wertstellungsdatum": "2023-07-08 13:29:00"
}
]
}
},
"schema": {
"items": {
"$ref": "#/components/schemas/AiConnectTransaction"
},
"type": "array"
}
}
},
"description": "Success, tags newly created or read from database"
},
"400": {
"description": "Bad request syntax or unsupported method"
},
"403": {
"description": "Tenant not set up for AI endpoints"
},
"408": {
"description": "Request timed out; try again later"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
},
"500": {
"description": "Server got itself in trouble"
}
},
"summary": "Get freelancer categories tags",
"tags": [
"Freelancer Categories"
]
}
},
"/customer/v2/bankzugaenge/{accessId}/{productId}/kontoumsaetze?tag=insurance-types": {
"get": {
"description": "Returns insurance division and product classification for a provided bank product.",
"operationId": "get_insurance_types",
"parameters": [
{
"description": "ID used to track end-to-end processing of the request",
"in": "header",
"name": "x-correlation-id",
"required": false,
"schema": {
"description": "ID used to track end-to-end processing of the request",
"examples": [
"f47ac10b-58cc-4372-a567-0e02b2c3d479",
"6ba7b810-9dad-41d1-80b4-00c04fd430c8",
"550e8400-e29b-41d4-a716-446655440000"
],
"title": "X-Correlation-Id",
"type": "string"
}
},
{
"description": "ID of the bank access",
"in": "path",
"name": "accessId",
"required": true,
"schema": {
"description": "ID of the bank access",
"examples": [
"a61f7249-7b32-42db-add0-1d4ee565aafc",
"0a461cd1-116b-4039-be98-543442ac4d75"
],
"title": "AccessId",
"type": "string"
}
},
{
"description": "ID of the bank product",
"in": "path",
"name": "productId",
"required": true,
"schema": {
"description": "ID of the bank product",
"examples": [
"DE62500105174269735379",
"DE85500105178475866425"
],
"title": "ProductId",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"default": {
"value": [
{
"betrag": -13.09,
"buchungsdatum": "2020-03-11 18:00:00",
"gegenkontoBic": "",
"gegenkontoIban": "",
"gegenkontoInhaber": "",
"hash": "f2769cb9-f39b-4bfb-8002-905dc30ad8e5",
"id": "81328b96-b872-4f04-a76a-09aeab2001cd",
"primanotaNummer": "12345",
"tags": [
{
"entity": {
"displayName": "Kontoumsatz",
"entityClass": "TRANSACTION",
"id": "81328b96-b872-4f04-a76a-09aeab2001cd"
},
"id": "7332c232-0079-4600-9e3e-bac24cb8c855",
"relations": [
{
"href": "https://banksapi.io/tags/v1/tag-trees/",
"rel": "tag_trees"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/2/",
"rel": "tag_tree"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/2/tag-tree-items/",
"rel": "tag_tree_items"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/2/tag-tree-items/164/",
"rel": "tag_tree_item"
}
],
"tagTreeItem": {
"displayName": "Kapitallebensversicherung",
"systemId": 164,
"systemName": "LIFE_ENDOWMENT",
"systemNameParent": "LIFE",
"tagTree": {
"description": "Two level fine grained insurance categorization tag tree.",
"displayName": "Versicherungsarten",
"isClientGenerated": false,
"systemId": 2,
"systemName": "INSURANCE_TYPES",
"version": 2.4
}
}
}
],
"verwendungszweck": "CRED DE07ZZZ00000063475 Beitrag Lebensvers 2020 01 SEPA BASISLASTSCHRIFT wiederholend",
"wertstellungsdatum": "2020-03-11 18:00:00"
}
]
}
},
"schema": {
"items": {
"$ref": "#/components/schemas/AiConnectTransaction"
},
"type": "array"
}
}
},
"description": "Success, tags newly created or read from database"
},
"400": {
"description": "Bad request syntax or unsupported method"
},
"403": {
"description": "Tenant not set up for AI endpoints"
},
"408": {
"description": "Request timed out; try again later"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
},
"500": {
"description": "Server got itself in trouble"
}
},
"summary": "Get insurance types tags",
"tags": [
"Insurance Types"
]
}
},
"/tags/v1/tag-trees/": {
"get": {
"description": "Returns all available tag trees.\n\nThis endpoint can be used to get an overview of all available tag trees and a mapping of IDs and names.",
"operationId": "get_tag_trees",
"parameters": [
{
"description": "ID used to track end-to-end processing of the request",
"in": "header",
"name": "x-correlation-id",
"required": false,
"schema": {
"description": "ID used to track end-to-end processing of the request",
"examples": [
"f47ac10b-58cc-4372-a567-0e02b2c3d479",
"6ba7b810-9dad-41d1-80b4-00c04fd430c8",
"550e8400-e29b-41d4-a716-446655440000"
],
"title": "X-Correlation-Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"default": {
"value": [
{
"description": "Two level categorization tree.",
"displayName": "Kategorien",
"isClientGenerated": false,
"relations": [
{
"href": "https://banksapi.io/tags/v1/tag-trees/1/",
"rel": "self"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/",
"rel": "tag_trees"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/1/tag-tree-items/",
"rel": "tag_tree_items"
}
],
"systemId": 1,
"systemName": "CATEGORIES",
"version": 3.7
},
{
"description": "Two level fine grained insurance categorization tag tree.",
"displayName": "Versicherungsarten",
"isClientGenerated": false,
"relations": [
{
"href": "https://banksapi.io/tags/v1/tag-trees/2/",
"rel": "self"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/",
"rel": "tag_trees"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/2/tag-tree-items/",
"rel": "tag_tree_items"
}
],
"systemId": 2,
"systemName": "INSURANCE_TYPES",
"version": 2.4
}
]
}
},
"schema": {
"items": {
"$ref": "#/components/schemas/TagsTagTree"
},
"title": "Response Get Tag Trees",
"type": "array"
}
}
},
"description": "Success, tag trees read from database"
},
"400": {
"description": "Bad request syntax or unsupported method"
},
"403": {
"description": "Request forbidden -- authorization will not help"
},
"408": {
"description": "Request timed out; try again later"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Server got itself in trouble"
}
},
"summary": "Get tag trees",
"tags": [
"Tags"
]
}
},
"/tags/v1/tag-trees/{tagTreeId}/": {
"get": {
"description": "Returns a specific tag tree.",
"operationId": "get_tag_tree",
"parameters": [
{
"description": "The system ID of the tag tree",
"in": "path",
"name": "tagTreeId",
"required": true,
"schema": {
"description": "The system ID of the tag tree",
"examples": [
"1",
"3",
"7"
],
"title": "Tagtreeid",
"type": "integer"
}
},
{
"description": "ID used to track end-to-end processing of the request",
"in": "header",
"name": "x-correlation-id",
"required": false,
"schema": {
"description": "ID used to track end-to-end processing of the request",
"examples": [
"f47ac10b-58cc-4372-a567-0e02b2c3d479",
"6ba7b810-9dad-41d1-80b4-00c04fd430c8",
"550e8400-e29b-41d4-a716-446655440000"
],
"title": "X-Correlation-Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"default": {
"value": {
"description": "Two level categorization tree.",
"displayName": "Kategorien",
"isClientGenerated": false,
"relations": [
{
"href": "https://banksapi.io/tags/v1/tag-trees/1/",
"rel": "self"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/",
"rel": "tag_trees"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/1/tag-tree-items/",
"rel": "tag_tree_items"
}
],
"systemId": 1,
"systemName": "CATEGORIES",
"version": 3.7
}
}
},
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/TagsTagTree"
},
{
"additionalProperties": true,
"type": "object"
}
],
"title": "Response Get Tag Tree"
}
}
},
"description": "Success, tag tree read from database"
},
"400": {
"description": "Bad request syntax or unsupported method"
},
"403": {
"description": "Request forbidden -- authorization will not help"
},
"408": {
"description": "Request timed out; try again later"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Server got itself in trouble"
}
},
"summary": "Get a tag tree",
"tags": [
"Tags"
]
}
},
"/tags/v1/tag-trees/{tagTreeId}/tag-tree-items/": {
"get": {
"description": "Returns all tag tree items of a specific tag tree.",
"operationId": "get_tag_tree_items",
"parameters": [
{
"description": "The system ID of the tag tree",
"in": "path",
"name": "tagTreeId",
"required": true,
"schema": {
"description": "The system ID of the tag tree",
"examples": [
"1",
"3",
"7"
],
"title": "Tagtreeid",
"type": "integer"
}
},
{
"description": "system id of a tag tree item of the tag tree with the system name 'CATEGORIES'",
"in": "query",
"name": "categoryTagTreeItemId",
"required": false,
"schema": {
"description": "system id of a tag tree item of the tag tree with the system name 'CATEGORIES'",
"examples": [
1,
7,
11
],
"minimum": 1,
"title": "Categorytagtreeitemid",
"type": "integer"
}
},
{
"description": "ID used to track end-to-end processing of the request",
"in": "header",
"name": "x-correlation-id",
"required": false,
"schema": {
"description": "ID used to track end-to-end processing of the request",
"examples": [
"f47ac10b-58cc-4372-a567-0e02b2c3d479",
"6ba7b810-9dad-41d1-80b4-00c04fd430c8",
"550e8400-e29b-41d4-a716-446655440000"
],
"title": "X-Correlation-Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"default": {
"value": [
{
"description": "Transactions in the field of banking and finance",
"displayName": "Bank und Finanzen",
"relations": [
{
"href": "https://banksapi.io/tags/v1/tag-trees/1/tag-tree-items/1/",
"rel": "self"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/",
"rel": "tag_trees"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/1/",
"rel": "tag_tree"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/1/tag-tree-items/",
"rel": "tag_tree_items"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/1/tag-tree-items/1/",
"rel": "tag_tree_item"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/1/tag-tree-items/None/",
"rel": "tag_tree_item_parent"
}
],
"systemId": 1,
"systemName": "BANKFINANCE",
"tagTree": {
"description": "Two level categorization tree.",
"displayName": "Kategorien",
"isClientGenerated": false,
"systemId": 1,
"systemName": "CATEGORIES",
"version": 3.7
}
},
{
"description": "Transactions including invoices & bills",
"displayName": "Vertragsrechnungen",
"relations": [
{
"href": "https://banksapi.io/tags/v1/tag-trees/1/tag-tree-items/2/",
"rel": "self"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/",
"rel": "tag_trees"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/1/",
"rel": "tag_tree"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/1/tag-tree-items/",
"rel": "tag_tree_items"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/1/tag-tree-items/2/",
"rel": "tag_tree_item"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/1/tag-tree-items/None/",
"rel": "tag_tree_item_parent"
}
],
"systemId": 2,
"systemName": "BILLS",
"tagTree": {
"description": "Two level categorization tree.",
"displayName": "Kategorien",
"isClientGenerated": false,
"systemId": 1,
"systemName": "CATEGORIES",
"version": 3.7
}
}
]
}
},
"schema": {
"items": {
"$ref": "#/components/schemas/ExtensiveTagTreeItem"
},
"title": "Response Get Tag Tree Items",
"type": "array"
}
}
},
"description": "Success, tag tree items read from database"
},
"400": {
"description": "Bad request syntax or unsupported method"
},
"403": {
"description": "Request forbidden -- authorization will not help"
},
"408": {
"description": "Request timed out; try again later"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Server got itself in trouble"
}
},
"summary": "Get tag tree items",
"tags": [
"Tags"
]
}
},
"/tags/v1/tag-trees/{tagTreeId}/tag-tree-items/{tagTreeItemId}/": {
"get": {
"description": "Returns a specific tag tree item of a specific tag tree.",
"operationId": "get_tag_tree_item",
"parameters": [
{
"description": "The system ID of the tag tree",
"in": "path",
"name": "tagTreeId",
"required": true,
"schema": {
"description": "The system ID of the tag tree",
"examples": [
"1",
"3",
"7"
],
"title": "Tagtreeid",
"type": "integer"
}
},
{
"description": "The system ID of the tag tree item",
"in": "path",
"name": "tagTreeItemId",
"required": true,
"schema": {
"description": "The system ID of the tag tree item",
"examples": [
"1",
"17",
"42"
],
"title": "Tagtreeitemid",
"type": "integer"
}
},
{
"description": "ID used to track end-to-end processing of the request",
"in": "header",
"name": "x-correlation-id",
"required": false,
"schema": {
"description": "ID used to track end-to-end processing of the request",
"examples": [
"f47ac10b-58cc-4372-a567-0e02b2c3d479",
"6ba7b810-9dad-41d1-80b4-00c04fd430c8",
"550e8400-e29b-41d4-a716-446655440000"
],
"title": "X-Correlation-Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"default": {
"value": {
"description": "Transactions in the field of banking and finance",
"displayName": "Bank und Finanzen",
"relations": [
{
"href": "https://banksapi.io/tags/v1/tag-trees/1/tag-tree-items/1/",
"rel": "self"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/",
"rel": "tag_trees"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/1/",
"rel": "tag_tree"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/1/tag-tree-items/",
"rel": "tag_tree_items"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/1/tag-tree-items/1/",
"rel": "tag_tree_item"
},
{
"href": "https://banksapi.io/tags/v1/tag-trees/1/tag-tree-items/None/",
"rel": "tag_tree_item_parent"
}
],
"systemId": 1,
"systemName": "BANKFINANCE",
"tagTree": {
"description": "Two level categorization tree.",
"displayName": "Kategorien",
"isClientGenerated": false,
"systemId": 1,
"systemName": "CATEGORIES",
"version": 3.7
}
}
}
},
"schema": {
"$ref": "#/components/schemas/ExtensiveTagTreeItem"
}
}
},
"description": "Success, tag tree item read from database"
},
"400": {
"description": "Bad request syntax or unsupported method"
},
"403": {
"description": "Request forbidden -- authorization will not help"
},
"408": {
"description": "Request timed out; try again later"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Server got itself in trouble"
}
},
"summary": "Get a tag tree item",
"tags": [
"Tags"
]
}
}
},
"servers": [
{
"description": "Production server",
"url": "https://banksapi.io"
}
],
"tags": [
{
"description": "Provides categorized transactions based on everyday spending types such as groceries shopping or rental payments.\n\nThe categories are a two-level hierarchy, where the first level is the main category, such as `Living` and the second level is a subcategory such as `Clothing and Acessories`. The endpoint strongly relates to the endpoint `insurance-types`. If an insurance type is detected, the category is set to `INSURANCE` and the main class of the insurance type, the division, is used as the subcategory.\n\nTo get the full list of categories, use: `GET /tags/v1/tags/tag-trees/1/tag-tree-items/`\n\n## Categorization Logic\nWe use a **hybrid model**, that combines a **basic model** and an **AI model**. The basic model runs first. If it cannot find a category, the AI model runs as well. If the found category has a sufficient confidence, it is returned. If the basic model yields multiple tags, the AI model runs as well. Majority voting in combination with a confidence threshold is used to determine the best fitting category.\n\n### Basic Model\nThe basic model searches for **keywords and regular expression** based substrings in note to payee, counterparty name and posting text. It includes the main categories of the insurance classifier to precisely detect insurance transactions. There are several additional steps for specific types of transactions, counterparties and categories to further improve the accuracy of this model.\n\n### Artificial Intelligence Model\nThe model architecture is a **bidirectional recurrent neural network with long short-term memory and an attention mechanism**. The samples used for training this model do not contain any user related identifiers. The training encompasses semantically-meaningful word and sub-word embeddings, pre-trained in an unsupervised setting as well as human and automatically labeled data, providing a total of more than a million training samples. Even before a human labeler processes a transaction, each transaction gets anonymized. Amounts get slightly shifted randomly and all sensible information such as names and addresses are automatically removed from all texts. With this process, data privacy is fully ensured.",
"name": "Categories"
},
{
"description": "Identifies insurance division and product in insurance-related transactions.\n\nWe use a sophisticated classification model to identify insurance types in transaction data.\nThe model combines pattern matching and machine learning techniques,\nwhich allows us to detect and accurately classify insurance-related transactions.\n\nSimilar to the `categories` endpoint, the classes (which we call insurance types) are organized in a two-level hierarchy.\nThe first level is the insurance division, such as \"Life\", \"Liability\", or \"Property\".\nThe second level is the insurance product, such as\n\"Occupational Disability Insurance\" (a subclass of \"Life\") or\n\"Pet Owner Liability Insurance\" (a subclass of \"Liability\").\n\nThere are a few exceptions in this division and product scheme:\n- `UNRELATED` is used for transactions that do not relate to insurance at all.\n Since transactions are always tagged with a two-level hierarchy, there is `UNRELATED_OTHER`.\n- `OTHER` is used for transactions that are insurance-related\n but do not fit into any of the other classes or lack sufficient information to define the division.\n Consequently, there is a subclass `OTHER_OTHER` and a subclass within each division, e.g., `LIFE_OTHER` or `LIABILITY_OTHER`.\n\nThe `categories` endpoint is strongly related to this endpoint.\nIt calls this endpoint first, and if the category is not `UNRELATED`, it uses `INSURANCE` as the first level and the division as the second level.\n\nTo get a full list of insurance types, use:
\n`GET /tags/v1/tags/tag-trees/2/tag-tree-items/`",
"name": "Insurance Types"
},
{
"description": "Identifies normalized business partners and returns detailed information such as address and website.\n\nA business partner is the financial entity or individual that provides the good or service that the transaction is related to. It differs from the payment handler or the bank.\nFor instance, if you pay your rent, the business partner is your landlord or property management company, not the bank that processes the payment.\nThis includes private individuals - for example, when receiving rent from a tenant or paying rent to a private landlord.\n\n### How Detection Works\n\nThe detection uses sophisticated matching based on multiple data points including keywords, regular expressions, IBAN numbers, Creditor IDs, and more.\nThis ensures accurate identification across various transaction formats, even when the same business partner appears with different names or abbreviations across transactions.\n\n**Example**: All of the following data points match to the same business partner:\n- Creditor ID: `DE07ZZZ00000063475`\n- Keywords: `Allianz Lebensvers.AG` or `Allianz LV`\n- IBAN: `DE77700202700062328142`\n- Regular Expression: `ALLIANZ LEBEN331.143.774`\n\nThese are all normalized to the tag tree item with system name `Allianz Lebensversicherungs-AG` and the human-readable display name `Allianz Lebensversicherung`.\n\n### Practical Applications\n\nThis endpoint is particularly valuable when displaying counterparty information in user interfaces. The raw counterparty name (`gegenkontoInhaber`) from transaction data often has limitations:\n- **Not normalized**: Same business partner may appear with different names or abbreviations\n- **Payment service providers**: May show intermediaries like `PayPal` instead of the actual merchant\n- **Missing information**: Credit card transactions and other payment methods may have empty or incomplete counterparty fields\n- **Poor readability**: Technical names or codes that aren't user-friendly\n\nBusiness partner detection solves these issues by providing consistent, machine and human-readable names, IDs and additional information.\n\n### Database & Integration\n\nOur database contains extensive information about business partners including their categories, industries, and sectors, which we directly leverage in other endpoints like `categories` and `insurance-types`.\n\nFor instance, if the business partner `Rewe` is detected, we automatically classify the transaction as `Groceries` in `categories` because it's a grocery store chain in Germany, or if the business partner `CosmosDirekt` is detected, we immediately classify the transaction as insurance-related in `insurance-types` because it's an insurance company.\n\nWe continuously improve and extend our database with more business partners and more detailed information and updates.\n\n### Missing and Unknown Business Partners\nSince we are returning a business partner for each transaction, if no business partner from our database is detected, we use the tag tree item with the system name `UNKNOWN`.\nThis is common for private individuals and businesses not yet in our database, as well as transactions without sufficient information to identify a business partner.\n\nTo get a full list of business partners, use:
\n`GET /tags/v1/tags/tag-trees/3/tag-tree-items/`",
"name": "Business Partners"
},
{
"description": "Gives detailed freelancer transactions categories in accordance with the Einnahmen\u00fcberschussrechnung (E\u00dcR).\n\nThis endpoint provides specialized categorization for freelancers and self-employed individuals, focusing on tax-relevant categories that align with German tax reporting requirements. The categories are specifically designed to help with expense tracking and tax preparation.\n\nThe endpoint supports the same hierarchical categorization structure as the main categories endpoint but with a focus on business-related expenses and income streams relevant to freelancers.\n\nTo get a full list of freelancer categories, use:
\n`GET /tags/v1/tags/tag-trees/4/tag-tree-items/`",
"name": "Freelancer Categories"
},
{
"description": "Identifies recurring transactions, broadly referred to as \"contracts\", by analyzing the user's full transaction history across all connected accounts and banks.\n\nIt categorizes each transaction using the classification logic from the `categories`, `insurance-types`, and `business-partners` endpoints.\nOnce categorized, recurring patterns are identified, and contract-like structures are formed based on transaction frequency, amount regularity, and counterparty consistency.\n\nThe system supports a wide range of recurring transaction types, such as rent, utilities, insurance, loans, subscriptions, salary, charity, and any other repeating financial obligations and income streams.\nIt also includes analytical insights to help with financial forecasting and decision-making.\n\n### Key Features\n\n- **Categorization** \n Includes classification data from the `categories`, `insurance-types`, and `business-partners` endpoints.\n\n- **Frequency Analysis**\n Identifies how often transactions occur and determines recurring patterns (e.g., monthly, quarterly, annually).\n\n- **Statistical Summary** \n Provides metrics including mean, median, total volume, standard deviation, and growth rate.\n\n- **Temporal Data** \n Reports on first, latest, and predicted next occurrences of a recurring transaction pattern.\n\n- **Amount Development** \n Tracks amount evolution and pricing changes over time.\n\n- **Contract Details**\n Lists contract and customer numbers, detected from transaction descriptions.\n\n- **Non-Regular Transactions** \n Intelligently identifies and separates transactions that don't follow the main contract pattern but are still related to the same contract (e.g., refunds, adjustments, or one-time fees within an energy or insurance contract).\n\n- **Loan & Credit Metadata** \n Attempts to estimate loan metadata such as total amount, interest rate, and installment terms where applicable.\n\n- **Active Status** \n Indicates whether a contract is currently active based on recent transaction activity.\n\n- **Traceability** \n Links back to source transactions and provides chronological amount development over time.\n\n### Non-Regular Transaction Handling\n Due to non-regular transactions potentially skewing calculations, several statistical attributes are provided multiple times - some including all transactions and others excluding non-regular ones.\n This intelligent approach allows for flexible analysis depending on whether refunds and adjustments should be included in averages and projections.\n\n### Missing Frequency Information\nThe system can detect contracts even when no clear frequency is established. Frequency information may be missing for one of two reasons:\n- **Single Transaction Contracts**: When only one transaction exists but shows clear contract indicators\n- **Irregular Timing**: When transactions appear contract-related but have inconsistent periods or recent timing changes\n\nFor some use cases, the frequency is essential, which is why we implemented a sophisticated fallback mechanism for contracts with only a single transaction.\nIn such cases, the attribute `periodConfidenceLevel` expresses the uncertainty of the period. When this attribute is not present, the period can be treated as fully reliable.\nTherefore, uncertain periods can be filtered out by excluding cases where `periodConfidenceLevel` is present and below 1.0.",
"name": "Contracts"
},
{
"description": "Provides cashflow statistics and predictions based on a user's full transaction history.\n\nThis endpoint analyzes a user's transaction history to generate comprehensive cashflow insights, including income and expense patterns, spending trends, and financial predictions.\nThe analysis categorizes transactions and provides statistical summaries to help understand financial behavior.\n\n### Key Features\n\n- **Dual-Axis Analysis** \n Provides cashflow data organized by both categorization and time components.\n You can switch the focus between the two dimensions, either sorted by categories on the outer level with time on the inner level, or vice versa.\n\n- **Multiple Time Aggregations** \n Time components include weekly, monthly, quarterly, annual, and total aggregations, allowing tailored analysis.\n\n- **Flexible Categorization** \n Uses either `categories` or `business-partners` as the categorization basis for organizing cashflow data.\n\n- **Predictive Analytics** \n Generates predictions based on historical data from the previous 12 cycles (e.g., 12 months), incorporating recurring transaction patterns from the `contracts` endpoint for enhanced accuracy.\n For instance, if the user's salary is pending for the current month, the prediction will account for this expected income.\n Predictions are calculated for the current and the next cycle.\n Therefore, the current cycle has both statistical and predictive data, while all other cycle only contain either statistics (past cycles) or predictions (next cycle).\n Note: Currently, predictions are available when the focus of the analysis is on categorization according to `categories`.\n\n- **Savings Filtering** \n Optional exclusion of savings transactions to prevent distortion of expense statistics when savings shouldn't be considered as regular expenses for specific use cases.\n\n- **Category Level Control** \n When using `categories` for categorization, it's possible to limit to main categories only for higher-level analysis.\n\n- **Aggregated Totals** \n When the analysis focuses on time periods and uses `categories` as the categorization basis, special aggregated tag tree items are included:\n - NET (overall cashflow)\n - INCOME (all income transactions)\n - EXPENSES (all expense transactions)\n\n These totals exclude transfer transactions to provide accurate cashflow summaries for each time period.\n Note: These totals are not included when using `business-partners` categorization or when the focus is on individual categories.",
"name": "Cashflow"
},
{
"description": "Estimates a user's currently disposable money by analyzing their financial activity within the current salary cycle, from the last salary payment up to the next expected one.\n\nThe endpoint processes transactions by categorizing them according to the `categories` endpoint, generating contracts from the `contracts` endpoint, and predicting future cashflows to provide comprehensive financial insights for the current salary period.\n\n### Key Features\n\n- **Salary Cycle Analysis** \n Focuses analysis on the current salary cycle, providing relevant insights for the specific time period between salary payments.\n\n- **Multi-Source Integration** \n Combines transaction categorization, contract analysis, and cashflow predictions to deliver accurate disposable money estimates.\n\n- **Real-Time Calculations** \n Provides current financial position as well as projections for the remainder of the salary cycle.\n\n- **Fixed vs. Flexible Expenses** \n Distinguishes between predictable contract-based expenses (fixed) and variable spending patterns (flexible) for more accurate forecasting.\n\n### Practical Applications\n\nThis endpoint empowers users to make informed financial decisions by providing clarity on their available funds throughout the salary cycle:\n\n- **Investment Planning** - Safely allocate surplus funds for investments or savings without compromising essential expenses\n- **Affordability Assessment** - Determine whether you can make a purchase now or should wait until the next salary arrives\n- **Budget Optimization** - Make data-driven spending decisions based on projected cashflows rather than current account balance alone\n\n### Important Notes\n\n**Salary Detection Requirement:** The detection of an active salary is fundamental to this endpoint. If no salary payment can be identified, the response will be empty, even if other regular income exists.",
"name": "Disposable Money"
},
{
"description": "Analyzes a user's life journey by detecting both current life stages and significant life events through comprehensive transaction analysis.\n\nThe following two endpoints provide complementary perspectives on a user's personal and financial development:\n\n- **Life Stages** (`/life/stages/`) - Identifies current states and phases across four key life domains\n- **Life Events** (`/life/events/`) - Detects significant transitions and milestones with historical dates\n\n### Life Stages\n\nLife stages represent ongoing states or phases in a user's life, detected through contract analysis and transaction patterns.\nThe analysis covers four essential domains:\n\n- **Labour Market** - Professional and academic career status\n- **Parenthood** - Family status and presence of children\n- **Housing** - Ownership and rental arrangements for accommodation\n- **Savings** - Retirement preparation and savings activities\n\n### Life Events \n\nLife events capture significant moments of change or transition in a user's life.\nThese are time-specific occurrences that often mark the beginning or end of a life stage.\n\n- **Career Milestones** - First employment, job changes, career transitions\n- **Housing Changes** - First apartment, relocations, homeowner-ship\n- **Family Events** - Marriage, birth of children, family changes \n- **Financial Transitions** - Major income changes, retirement events\n\n### Key Differences\n\n- **Life Stages** focus on *current status* - \"What is the user's situation now?\"\n- **Life Events** focus on *historical transitions* - \"When did significant changes occur?\"\n- **Complementary Insights** - Together they provide a complete picture of life progression\n\n### Practical Applications\n\n- **Financial Planning** - Align products and services with life phase and recent changes\n- **Risk Assessment** - Understand stability vs. transition periods in user's life \n- **Personalized Offers** - Target recommendations based on both current needs and recent events\n- **Customer Journey Mapping** - Track progression through different life phases over time",
"name": "Life"
},
{
"description": "Identifies sales opportunities by analyzing a user's financial profile, life events, and insurance gaps to detect when they may be receptive to specific financial products or services.\n\nThis endpoint leverages data from the `contracts`, `life-events`, and `life-stages` endpoints to identify optimal moments for financial product recommendations.\nBy analyzing patterns in income, expenses, life transitions, and insurance coverage, it determines when users are most likely to need and purchase financial products.\n\n### How Detection Works\n\nThe endpoint analyzes user data across multiple dimensions to identify sales opportunities:\n\n- **Insurance Gap Analysis** - Detects missing essential insurance products (liability, occupational disability, private health insurance)\n- **Life Event Recognition** - Identifies significant life changes that typically drive financial product needs\n- **Financial Pattern Analysis** - Recognizes income increases, savings potential, and windfall events\n- **Behavioral Triggers** - Combines multiple indicators to determine optimal sales timing\n\n### Sales Trigger Categories\n\n**Missing Insurance Products:**\n- **Private Liability Insurance** - User lacks basic liability coverage\n- **Occupational Disability Insurance** - Missing income protection for work-related disabilities \n- **Private Health Insurance** - Absent private health coverage (triggered only for high earners \u20ac3,200+ monthly)\n\n**Life Event Triggers:**\n- **First Apartment** - User has moved to their first independent residence\n- **New Apartment** - User has relocated, indicating potential insurance updates needed\n- **First Employment** - User has entered the workforce for the first time\n- **New Employment** - User has changed jobs, potentially affecting insurance needs\n- **First Child** - User has become a parent, creating new protection needs\n\n**Financial Opportunity Triggers:**\n- **Salary Increase** - User has received a significant pay raise, increasing purchasing power\n- **Savings Potential** - User demonstrates consistent ability to save money over time\n- **Large Income Event** - User has received substantial one-time income (2x+ average monthly income)\n\n### Practical Applications\n\nThis endpoint enables financial institutions and advisors to:\n\n- **Personalized Marketing** - Target users with relevant product offers at optimal times\n- **Needs-Based Selling** - Identify genuine product gaps rather than generic sales approaches \n- **Lifecycle Management** - Align product recommendations with natural life transitions\n- **Risk Assessment** - Understand which users may urgently need certain protections\n\n### Flexible Configuration\n\nThe sales trigger system is highly adaptable to specific business needs and can be extended significantly:\n\n- **Customizable Thresholds** - All detection parameters can be adjusted (income thresholds, time windows, savings requirements, etc.)\n- **New Trigger Development** - Additional sales triggers can be created for specific products, market segments, or business strategies\n- **Industry-Specific Adaptations** - Triggers can be tailored for different financial sectors (banking, insurance, investment, etc.)\n- **Advanced Logic** - Complex multi-factor triggers combining various life events, financial patterns, and behavioral indicators can be implemented\n\nThis foundation provides extensive scalability for sophisticated sales intelligence systems tailored to unique business requirements.\n\nTo get a full list of sales triggers, use:
\n`GET /tags/v1/tags/tag-trees/5/tag-tree-items/`",
"name": "Sales Triggers"
},
{
"description": "Provides comprehensive affordability analysis by evaluating income, expenses, and financial behavior patterns to assess a user's creditworthiness and financial stability.\n\n### Practical Applications\n\n- **Credit Risk Assessment** - Evaluate loan applications by analyzing expense-to-income ratios and payment behavior\n- **Financial Product Recommendations** - Match users with suitable financial products based on spending patterns\n- **Investment Advisory** - Determine safe investment thresholds based on discretionary income analysis\n- **Budget Planning** - Help users understand their financial capacity for major purchases or commitments\n\n### Key Financial Metrics\n\nThe analysis generates comprehensive metrics across multiple dimensions:\n\n- **Income Analysis** - Separates regular (contract-based) from irregular income streams\n- **Expense Categorization** - Breaks down expenses into necessities and luxuries with detailed subcategory analysis\n- **Financial Ratios** - Calculates critical ratios like expenses-to-income, luxuries-to-income, and necessities-to-income\n- **Discretionary Income** - Computes available money after necessities for financial decision-making\n- **Savings Capacity** - Determines monthly surplus or deficit based on income minus total expenses\n\n### Advanced Risk Indicators\n\nThe system monitors various financial health indicators:\n\n- **Credit Behavior** - Detects existing loans, mortgage payments, and credit card usage patterns\n- **Payment Issues** - Identifies return debits, reminder charges, debt collection, and seizure payments\n- **Gambling Activity** - Tracks recreational gambling expenses as a risk factor\n- **Financial Literacy Score** - Evaluates financial management competency based on account balances and transaction history\n\n### Data Processing Window\n\nAnalysis typically covers a **6-month historical window** to ensure statistical relevance while capturing recent financial patterns.\nThe system intelligently adjusts the analysis period based on available transaction history and ensures sufficient data completeness for accurate predictions.\n\n### Necessity vs. Luxury Classification\n\nExpenses are automatically classified using the `categories` tag tree system:\n\n- **Necessities** - Essential expenses like rent, utilities, groceries, fuel, and basic insurance\n- **Luxuries** - Discretionary spending including entertainment, dining out, non-essential shopping, and premium services\n\nThis classification enables precise calculation of discretionary income and spending flexibility for financial planning purposes.\n\n### Related Endpoints\n\n- **`credit-attributes`** - Provides complementary credit risk assessment with focus on creditworthiness indicators, life stage analysis, and detailed credit contract evaluation for comprehensive lending decisions",
"name": "Affordability"
},
{
"description": "Identifies user interests and lifestyle patterns by analyzing spending behavior, contract relationships, and life stages to determine specific affinities for targeted product recommendations and personalized services.\n\n### Multi-Dimensional Detection System\n\nThe affinity detection engine operates across three complementary data sources:\n\n- **Contract Analysis** - Analyzes existing contracts and insurance types to infer interests (e.g., gym membership suggests fitness affinity)\n- **Transaction Patterns** - Examines spending frequency and amounts in specific categories over time\n- **Life Stage Integration** - Correlates current life stages with typical associated interests and needs\n\n### Transaction-Based Detection\n\nThe system monitors spending patterns over a **6-month analysis window** using sophisticated threshold-based detection:\n\n- **Frequency Thresholds** - Detects consistent spending in specific categories (e.g., monthly gym memberships for fitness affinity)\n- **Transaction Count Analysis** - Requires minimum number of transactions per month to establish genuine interest patterns \n- **Parent Category Matching** - Can detect affinities at both granular level (specific merchants) and broader category level\n- **Statistical Validation** - Uses percentage of months meeting criteria to ensure sustained interest rather than isolated events\n\n### Practical Applications\n\n- **Targeted Marketing** - Deliver personalized product recommendations based on detected lifestyle interests\n- **Customer Segmentation** - Group users by similar interests for focused campaign strategies \n- **Product Development** - Understand customer preferences to design relevant financial products\n- **Cross-selling Opportunities** - Identify users likely to be interested in specific services or partnerships\n\n### Example Affinities Detected\n\nThe system can identify various lifestyle and interest-based affinities, including:\n\n- **Sportive** - Detects fitness enthusiasts through gym memberships and sports-related spending\n- **Pet owner** - Identifies pet owners via pet-related expenses and animal insurance contracts\n- **Traveler** - Recognizes frequent travelers through travel-related transaction patterns\n- **Foodie** - Spots food enthusiasts based on dining out and culinary spending habits\n- **Fashion Enthusiast** - Identifies fashion-conscious users through clothing and accessories purchases\n- **Parent** - Detected through life stage analysis rather than transaction patterns\n- **Car Owners** - Car owners identified through fuel purchases and vehicle-related expenses like taxes and insurance\n- **Technophiles** - Technology enthusiasts detected via electronics purchases\n- **Avid Investors** - Identifies investment-minded users through banking and investment transactions\n- **Home & Garden** - Home improvement enthusiasts via furnishing and garden expenses\n\n### Extensibility and Customization\n\nThe affinity detection system is designed with extensibility in mind, allowing for future enhancements and customization:\n\n- **Extendable Category Mappings** - The system can be extended to define which spending categories trigger specific affinities.\n- **Adjustable Threshold Values** - Thresholds for spending frequencies and amounts can be adjusted to fine-tune detection.\n- **Configurable Time Windows** - The analysis periods for different types of interests can be modified.\n- **Adaptable Detection Rules** - New affinities can be added and existing detection logic can be adapted based on business needs.\n\nThis adaptability allows the system to be tailored to different market segments and evolving customer behavior patterns.",
"name": "Affinities"
},
{
"description": "Provides comprehensive credit risk assessment by analyzing financial behavior patterns, income stability, expense patterns, and creditworthiness indicators to evaluate a user's financial profile for lending decisions.\n\n### Core Financial Analysis\n\nThe system combines multiple data sources to create a holistic credit risk profile:\n\n- **Contract Analysis** - Leverages the `contracts` endpoint to identify recurring financial obligations and income streams\n- **Life Stage Intelligence** - Incorporates `life-stages` data to assess life situation impact on financial stability \n- **Asset Evaluation** - Includes bank products and investment analysis to determine overall financial position\n- **Risk Factor Detection** - Identifies payment issues, gambling behavior, and other creditworthiness indicators\n\n### Key Financial Metrics\n\nThe analysis generates comprehensive metrics across multiple financial dimensions:\n\n**Income Analysis**\n- **Total Income** - Complete monthly income assessment across all sources\n- **Salary Income** - Regular employment income with employment length tracking\n- **Fixed Income** - Contract-based recurring income (excluding salary)\n- **Variable Income** - Non-contract irregular income streams\n- **Windfall Detection** - Identifies unusually large income transactions that may skew regular patterns\n\n**Expense Analysis** \n- **Total Spending** - Complete monthly expense overview\n- **Fixed Spending** - Contract-based recurring expenses\n- **Variable Spending** - Non-contract discretionary spending\n- **Savings Behavior** - Monthly savings patterns and capacity\n\n**Credit-Specific Metrics**\n- **Active Credit Contracts** - Current mortgage, financial credit, and leasing obligations\n- **Passive Credit Contracts** - Historical credit arrangements\n- **Credit Card Usage** - Number of active credit cards and usage patterns\n- **Payment Reliability** - Risk indicators including return debits, reminder charges, and debt collection\n\n### Advanced Risk Assessment\n\n**Life Stage Context**\nAnalyzes four key life domains relevant to creditworthiness:\n- **Labor Market Status** - Employment stability and career stage\n- **Housing Situation** - Homeownership vs. tenancy status\n- **Relationship Status** - Marital status and household stability \n- **Parenthood** - Family responsibilities and associated financial commitments\n\n**Financial Health Indicators**\n- **Net Cashflow** - Monthly surplus/deficit with positive cashflow ratio\n- **Income Stability** - Employment length and contract regularity\n- **Risk Activities** - Gambling expenses and other high-risk financial behaviors\n- **Payment Issues** - Historical payment failures and collection activities\n\n### Statistical Analysis Window\n\nAnalysis covers a **6-month rolling window** to ensure:\n- Statistical relevance with sufficient transaction history\n- Capture of recent financial behavior patterns\n- Adjustment for seasonal variations in income and expenses\n- Focus on current financial capacity rather than outdated patterns\n\n### Asset and Investment Integration\n\n**Bank Products**\n- Account balances and overdraft utilization\n- Credit limits and drawn amounts\n- Product diversification analysis\n\n**Investment Portfolio**\n- Investment holdings and market exposure\n- Risk tolerance assessment through investment choices\n- Overall asset allocation patterns\n\n### Practical Applications\n\n- **Loan Origination** - Comprehensive risk assessment for loan applications\n- **Credit Limit Determination** - Data-driven credit limit setting\n- **Financial Product Matching** - Recommend appropriate financial products based on risk profile\n- **Portfolio Risk Management** - Monitor existing customer credit risk changes\n\n### Related Endpoints\n\n- **`affordability`** - Provides complementary financial analysis focusing on income-to-expense ratios, discretionary income calculation, and financial capacity assessment for enhanced credit decisions",
"name": "Credit Attributes"
},
{
"description": "Provides access to the foundational taxonomy system that powers classification across all AI endpoints.\nThe Tags system serves as the central repository for hierarchical classification vocabularies used throughout the platform.\n\n### Tag Tree & Tag Tree Item\n\nThe system is built around two fundamental concepts:\n\n- **Tag Trees** - Versioned classification hierarchies that represent specific business domains (e.g., spending categories, insurance types, business partners)\n- **Tag Tree Items** - Individual classification labels within each hierarchy, forming the leaves of the taxonomy tree\n\n### Data Structure\n\n- **System Name** - Unique identifier for programmatic use (e.g., `LIVING_GROCERIES`)\n- **System ID** - Numeric identifier for mapping to customer's own naming schemes\n- **Display Name** - Human-readable name for direct UI display (e.g., \"Lebensmittel\")\n- **Description** - Detailed scope clarification (e.g., \"Payments from grocery shopping\")\n\nSome Trag Tree Items contain additional metadata such as addresses, IBANs, or phone numbers, depending on the classification domain.\n\n#### Example\nThe endpoint `categories` uses the Tag Tree Items, such as the one with the system name `LIVING_GROCERIES`, from the Tag Tree with the system name `CATEGORIES` to classify transactions.\n\n### Tag Instance Architecture\n\nAll classification endpoints follow a consistent **tag instance** pattern:\n- Each classified transaction or entity (e.g., a user) receives tag instances linking back to specific Tag Tree Items and Tag Trees\n- Tag instances maintain traceability to source data while providing standardized classification\n\n\n**Instance-Specific vs. Static Data:**\n- **Tag Trees and Tag Tree Items** contain only static, universal classification data\n- **Tag Instances** contain dynamic, instance-specific information such as classification confidence scores\n- Some endpoints (e.g., `disposable-money`) primarily return instance-specific calculations while maintaining Tag Tree (Item) consistency for standardized classification references\n\n### Cross-Endpoint Integration\n\nTag Trees and Tag Tree Items are designed for reuse across multiple endpoints, ensuring classification consistency, for instance:\n\n- `categories` endpoint: Uses `CATEGORIES` tag tree as primary classification source\n- `contracts` endpoint: Incorporates `CATEGORIES`, `INSURANCE_TYPES`, `BUSINESS_PARTNERS` to build contracts\n- `credit-attributes` endpoint: Leverages `CATEGORIES` for expense analysis, `LIFE_STAGES` for risk assessment, and more\n- `affordability` endpoint: Uses `CATEGORIES` to distinguish necessities from luxuries\n\n### Practical Applications\n\n- Browse available classes before using classification endpoints\n- Understand the structure and relationships within each taxonomy\n- Create mappings between your own classification schemes and the platform's standardized tags",
"name": "Tags"
},
{
"description": "Provides user-defined transaction tagging rules for automated categorization based on counterparty information.\n\nTagging rules allow users to create custom categorization logic that takes precedence over AI-based classification. When a transaction matches an existing tagging rule, it gets automatically tagged with the specified tag tree item instead of running through the categorization model.\n\n### Rule Structure\n\nEach tagging rule consists of:\n\n- **Counterparty Information** - Name and IBAN used to identify matching transactions\n- **Tag Tree Item** - The classification label to apply when the rule matches (e.g., `LIVING_GROCERIES` from the `CATEGORIES` tag tree)\n\n### Rule Matching Logic\n\nTagging rules are applied to future transactions based on counterparty matching:\n- Both counterparty name and IBAN are used for precise transaction identification\n- When a transaction's counterparty information matches an existing rule, the associated tag tree item is automatically applied\n- This automated tagging bypasses the standard AI categorization process, ensuring consistent classification for specific counterparties\n\n### Rule Management Constraints\n\n**Requirements:** At least one of counterparty name or IBAN must exist\n\n**Uniqueness:** Each user can only have one tagging rule per unique counterparty (name and IBAN combination).\nAttempting to create duplicate rules for the same counterparty will overwrite the existing rule\n\n**Modification:** To change the tag tree item, a new rule must be created which replaces the existing rule\n\n**Payment Service Providers**: Be aware that some payment service providers, such as PayPal, themselves act as counterparties for transactions.\nIn such cases, the counterparty name and IBAN may not reflect the actual merchant or service provider.\nUsers should consider this when creating tagging rules to ensure accurate categorization.\nThis limitation will be addressed in future updates to further enhance the tagging rule functionality.\n\n### Integration with Tag System\n\nTagging rules leverage the platform's standardized tag taxonomy:\n- The same Tag Trees and Tag Tree Items are used for consistent classification\n- For instance, a rule can specify the Tag Tree Item with the system name `LIVING_GROCERIES` from the `CATEGORIES` Tag Tree\n\n### Practical Applications\n\n- **Personal Categorization** - Override AI suggestions with user-preferred classifications\n- **Bulk Processing** - Apply consistent tagging to historical and future transactions from the same counterparty",
"name": "Tagging Rules"
}
]
}