Risk Factors
Risk
Required scope: company-risk · Endpoint: GET /risk
Identifies risk indicators based on problematic transaction patterns. Results are broken down per account and per calendar month.
Risk indicators
| Indicator | Description |
|---|---|
| Back debits | Returned direct debits — transactions that were reversed after being initially booked. A high count may signal payment difficulties or insufficient funds. |
| Garnishments | Garnishment payments, indicating active enforcement proceedings against the account holder. |
| Overdraft days | Number of days within the month where the account balance was below the account overdraw limit at end-of-day. |
Response structure
The response contains one entry per account under accountRisks:
| Field | Description |
|---|---|
accountRisks[].account | Basic account information (IBAN, account type, etc.) |
accountRisks[].monthlyOverview[] | Monthly risk summary for this account, sorted newest-first |
monthlyOverview[].month | Month in YYYY-MM format |
monthlyOverview[].backDebit.count | Number of returned direct debits |
monthlyOverview[].backDebit.transactionIDs | IDs of the underlying transactions |
monthlyOverview[].garnishment.count | Number of garnishment payments |
monthlyOverview[].garnishment.transactionIDs | IDs of the underlying transactions |
monthlyOverview[].overdraftDays | Number of days the account was in overdraft |