POST /service/scoring/account/calculate

Calculate risk scoring for accounts

Calculate risk scoring for accounts

application/json

Request Body

inquiryId string required
accounts integer[] required
fromDate date-time required
toDate date-time required
excludedTransactionIds string[]
currency CurrencyCode

ISO 4217 currency code.

Responses

• 200

---

Calculate risk scoring for accounts

application/json

Schema

Example (from schema)

---

Schema

monthly object
properties
minMax object

property name* decimal

Amount of transaction in format: 0.00 without thousand separator, exact to two decimal places.
NOTE: If amount is provided with more than two decimal places then amount will be rounded to two decimal paces.

sample object
fromDate date-time
toDate date-time
days integer
numberOfTransactions integer
totals object

property name* decimal

Amount of transaction in format: 0.00 without thousand separator, exact to two decimal places.
NOTE: If amount is provided with more than two decimal places then amount will be rounded to two decimal paces.

transactions object[]
Array [
id string
created date-time
description string
amount decimal
Amount of transaction in format: 0.00 without thousand separator, exact to two decimal places.
NOTE: If amount is provided with more than two decimal places then amount will be rounded to two decimal paces.
currency CurrencyCode
ISO 4217 currency code.
balanceAfterTransaction decimal
Amount of transaction in format: 0.00 without thousand separator, exact to two decimal places.
NOTE: If amount is provided with more than two decimal places then amount will be rounded to two decimal paces.
status AccountTransactionStatus
Possible values: [booked, pending]
Account transaction status (booked or pending).
creditorName string
categorization object
code string
Possible values: <= 4 characters
Transaction category code (based on ISO 18245:2023 merchant category codes). As recognized by our categorization engine.
description string
Possible values: <= 512 characters
Transaction category description as recognized by our categorization engine. Not necessary coinciding with the recognized category code.
groupId integer
Transaction category group id category code belong to
groupDescription string
Transaction category group description
accountIban IBAN
Possible values: >= 15 characters and <= 34 characters
IBAN account number with country prefix
]
excludedTransactions object[]
Array [
id string
created date-time
description string
amount decimal
Amount of transaction in format: 0.00 without thousand separator, exact to two decimal places.
NOTE: If amount is provided with more than two decimal places then amount will be rounded to two decimal paces.
currency CurrencyCode
ISO 4217 currency code.
balanceAfterTransaction decimal
Amount of transaction in format: 0.00 without thousand separator, exact to two decimal places.
NOTE: If amount is provided with more than two decimal places then amount will be rounded to two decimal paces.
status AccountTransactionStatus
Possible values: [booked, pending]
Account transaction status (booked or pending).
creditorName string
categorization object
code string
Possible values: <= 4 characters
Transaction category code (based on ISO 18245:2023 merchant category codes). As recognized by our categorization engine.
description string
Possible values: <= 512 characters
Transaction category description as recognized by our categorization engine. Not necessary coinciding with the recognized category code.
groupId integer
Transaction category group id category code belong to
groupDescription string
Transaction category group description
accountIban IBAN
Possible values: >= 15 characters and <= 34 characters
IBAN account number with country prefix
]
transactionGroups object
property name* string[]
Array [
string
]
categories object[]
Array [
category object
code string
Possible values: <= 4 characters
Transaction category code (based on ISO 18245:2023 merchant category codes). As recognized by our categorization engine.
description string
Possible values: <= 512 characters
Transaction category description as recognized by our categorization engine. Not necessary coinciding with the recognized category code.
groupId integer
Transaction category group id category code belong to
groupDescription string
Transaction category group description
amount decimal
Amount of transaction in format: 0.00 without thousand separator, exact to two decimal places.
NOTE: If amount is provided with more than two decimal places then amount will be rounded to two decimal paces.
]
currency CurrencyCode

ISO 4217 currency code.

risk ScoreRisk

Possible values: [unknown, low, medium, high]

{
  "monthly": {},
  "minMax": {},
  "sample": {
    "fromDate": "2025-10-30T15:47:48.767Z",
    "toDate": "2025-10-30T15:47:48.767Z",
    "days": 0,
    "numberOfTransactions": 0
  },
  "totals": {},
  "transactions": [
    {
      "id": "string",
      "created": "2025-10-30T15:47:48.767Z",
      "description": "string",
      "amount": 12.3,
      "currency": "EUR",
      "balanceAfterTransaction": 12.3,
      "status": "booked",
      "creditorName": "string",
      "categorization": {
        "code": "string",
        "description": "string",
        "groupId": 0,
        "groupDescription": "string"
      },
      "accountIban": "AT483200000012345865"
    }
  ],
  "excludedTransactions": [
    {
      "id": "string",
      "created": "2025-10-30T15:47:48.767Z",
      "description": "string",
      "amount": 12.3,
      "currency": "EUR",
      "balanceAfterTransaction": 12.3,
      "status": "booked",
      "creditorName": "string",
      "categorization": {
        "code": "string",
        "description": "string",
        "groupId": 0,
        "groupDescription": "string"
      },
      "accountIban": "AT483200000012345865"
    }
  ],
  "transactionGroups": {},
  "categories": [
    {
      "category": {
        "code": "string",
        "description": "string",
        "groupId": 0,
        "groupDescription": "string"
      },
      "amount": 12.3
    }
  ],
  "currency": "EUR",
  "risk": "unknown"
}

Loading...