---
title: "Create risk report"
method: POST
path: "/rest/risk-reports"
tags: ["Risk Report"]
---

# Create risk report

`POST /rest/risk-reports`

Create risk report directly via API (without using the widget). This endpoint is only  relevant for licensed partners with a direct API integration.

## Request body

- object
  - `name` string — The person name that will be used for account verification (Financial Ident verification)
  - `account_ids` Schema[] — Restrict the risk report to given accounts (do not consider other accounts for the report) — unresolved $ref
  - `reporting_period` integer — Number of months to the past for which to generate the risk report.

## Response `200`

Risk report

- object
  - `id` string, UUID, required — Report id
  - `period` number, required — Number of months for which the report was requested. Default value is 12 months
  - `accounts` object[], required — Provides account-specific risk reports. The first entry in the list will be the main account, which is identified as the account associated with the primary income source, if such an account exists.
    - `name` string, required — Name of the account.
    - `type` Items, required — unresolved $ref
    - `owners` string[], required — List of names of all the account holders.
    - `iban` Iban, required — unresolved $ref
    - `currency` Currency, required — unresolved $ref
    - `is_jointly_managed` boolean, required — Indicates that the account has been opened by two or more individuals or entities.
    - `is_main_account` boolean, required — Indicates whether the account is a primary income source (primary income was detected on this account)
    - `last_transaction_on` Schema, required — unresolved $ref
    - `balance` object, required — Balance report
      - `days_in_overdraft` number, required — Number of days the balance was negative
      - `average` object, required — Average balance
        - `one_month` number, float, required — Average balance over 1 month (30 days)
        - `three_months` number, float, required — Average balance over 3 months (90 days)
        - `six_months` number, float, required — Average balance over 6 months (180 days)
    - `verification_result` object, required — Account verification result
      - `provided` Provided, required — unresolved $ref
      - `matched` Matched, required — unresolved $ref
  - `income` object, required — Income report
    - `regular` object, required — Regular income aggregations (with a contract)
      - `summary` Summary — unresolved $ref
      - `streams` Items[] — Regular income summary by category (stream) — unresolved $ref
    - `variable` object, required — Variable income aggregations (without a contract)
      - `summary` Summary — unresolved $ref
      - `streams` Items[] — Variable income summary by category — unresolved $ref
    - `closeness` number, required — Number of days since the last credit transaction
    - `consumption_ratio` number, required — The consumption ratio of income measures the proportion of income spent over a specific period. It is calculated by dividing total expenses by total income for that period (`expenses / income`). For example, a `consumption_ratio` of 0.5 indicates that half of the income was spent during the `reporting_period`.
    - `risk_indicators` object, required — This section includes aggregated data on potentially risky income transactions, categorized into sub-categories such as Chargeback, Gambling, Lottery, and Refund.
  - `expenses` object, required — Expenses report
    - `regular` object
      - `summary` Summary — unresolved $ref
    - `variable` object
      - `summary` Summary — unresolved $ref
    - `risk_indicators` object — This section includes aggregated data on potentially risky transactions, categorized into sub-categories such as ATM, Chargeback, Gambling, Debt Collection, and Loan.

## Other responses

- `400` — unresolved $ref
- `401` — unresolved $ref

---

[API](https://skmtc.net/qwist/apis/finx-api.md) · [All operations](https://skmtc.net/qwist/apis/finx-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/qwist/finx-api/revisions/b75f5c1aa39e/schema)