Accesses8

Account Verification2

Accounts5

Aggregations6

Artifacts1

Catalog4

Categorization2

Client Authorization2

Contracts7

Customizable Widget8

Financial Timeline3

Income Report4

Insurances3

Loans3

Notifications6

Payments10

Risk Report4

Securities3

Strong Customer Authentication9

Synchronizations2

Transaction Upload2

Transactions4

User Management6

Version1

Risk Report

Create risk report

Changed on Nov 3, 2026

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

post/rest/risk-reports

Request

Base URL
https://api.nrich.qwist.cloud
Auth
HTTP bearer
TypeScript
https://skmtc.dev/qwist/apis/finx-api/docs/rest/risk-reports/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

namestring

The person name that will be used for account verification (Financial Ident verification)

account_idsSchema[] (unresolved $ref)

Restrict the risk report to given accounts (do not consider other accounts for the report)

reporting_periodinteger

Number of months to the past for which to generate the risk report.

Response

Risk report

idstring UUID required

Report id

periodnumber required

Number of months for which the report was requested. Default value is 12 months

Changes

Nov 3, 2026398592d93b1f Revision changes
- breaking
  the / request property type changed from no type to string
- breaking
  the // response's property type changed from no type to string, and format from no format to ISO 4217:2015 for status
- breaking
  the /// response's property type changed from no type to object for status
- breaking
  the /// response's property type changed from no type to object for status
- info
  added the optional property //// to the response with the status
- info
  added to the /// response property allOf list for the response status
- info
  added to the /// response property allOf list for the response status
- info
  added subschema #1 subschema #2 to the / response property allOf list for the response status
- info
  removed from the /// response property allOf list for the response status
- info
  removed from the /// response property allOf list for the response status
- info
  removed subschema #1 subschema #2 from the / response property allOf list for the response status
- info
  the response's property default value EUR was added for the status
- info
  added the required property //// to the response with the status
- info
  added the required property //// to the response with the status
- info
  added the required property //// to the response with the status

Operation history