Initiate risk report (ongoing)

post

https://api.finx-s.qwist.cloud/ongoing/risk-report

Create a widget link to initiate the ongoing risk report generation.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

state

string

A client-provided identifier that helps track a specific user's journey through the widget flow. When you initially create the widget session, you can set this value to any string that helps identify the user's context (e.g., a session ID, user ID, or transaction reference). When the user completes their interaction and is redirected back to your redirect_uri, this same state value is returned as a query parameter. This mechanism allows you to securely match the returning user with their original session and maintain context about who they are and what they were doing, particularly important in scenarios with multiple concurrent widget sessions.

redirect_uri

url

required

The URL where users will be redirected after completing their interaction with the Widget.

The redirect includes the following query parameters:

state: Your original state value passed during initialization
success: Boolean indicating whether the flow completed successfully
cancel: Boolean indicating if the user canceled the flow (only present when canceled)
code: Authorization code valid for 1 hour, used to obtain an access token (only present on successful completion)
flow_id: Unique identifier for accessing flow-specific resources

language

string

enum

The display language used in the Widget UI.

Allowed:

accounts

array of objects

Defaults to

List of identifiers that will auto select the appropriate accounts.

accounts

account_types

array of objects

Defaults to

This will auto select a connection strategy based on the available account types. It is not guaranteed to retrieved all types, but best effort is taken based on order (first is highest priority).

account_types

allow_multi_selection

boolean

Defaults to true

Indicates whether to allow multiple accounts to be selected. Ignored if accounts is set.

reporting_period

integer

≥ 4

Defaults to 12

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

name

string

Name provided by the user to be checked against the account-holder names.

save_secrets

boolean

Defaults to false

Controls whether credentials are automatically saved on the nrich platform. When set to true, credentials are securely stored without requesting user permission. When false (default), users are presented with the option to save their credentials within the Widget UI. This setting helps streamline future authentication processes if credentials are saved.

user_id

string

The user's email address that serves as their unique identifier in the system. This should ideally be the same email address used for registering with your application, as it will receive a verification email. Each email must be unique across all Widget users. Note: This field is not used when authenticating via user_auth.

Responses

201Widget link created

400Bad request.

401You are not authorized.