HomeGuidesAPI Reference
Log In
Guides

Implementation Guide

Construct a Qwist Link URL, distribute it to your users, and access the resulting artifacts in the Qwist Console. No backend integration required.

No backend integration required. Qwist Link is a static URL - you construct it once per user and send it to them directly.

📘

No token exchange, no callback URL

Unlike other nrich products, Qwist Link does not require a server-side API call to create a flow. There is no authorization code exchange and no redirect callback to your server. Results are accessed via the Qwist Console.

Step 1

Sign up to the Qwist Console and create an application

Step 2

Construct and distribute your Qwist Link

Step 3

Access results in the Qwist Console

1. Sign up and create an application

Sign up to the Qwist Console and create an application. Each application is issued a client_id - this is the only credential you need to construct a Qwist Link.

To enable additional reports (income-report, risk-report, user-insights) for your application, contact our support team. accounts and transactions are always produced and require no additional configuration.

2. Construct and distribute the link

A Qwist Link is a URL you build by filling in the parameters below - no server-side logic required.

Production:

https://regshield.qwist.cloud/link?client_id={CLIENT_ID}&user_id=USER_ID&language={LANGUAGE}&reporting_period={MONTHS}

Sandbox:

https://api.finx-s.qwist.cloud/link?client_id={CLIENT_ID}&user_id=USER_ID&language={LANGUAGE}&reporting_period={MONTHS}

Example:

https://regshield.qwist.cloud/link?client_id=f2e46016-bde5-462b-b4a3-...&user_id=customer_12345&language=de&reporting_period=12

Parameters

ParameterRequiredDefaultDescription
client_idYes-Your Qwist application identifier, found in the Console.
user_idYes-A stable identifier you choose for this user. Used to find their artifacts in the Console.
languageNoenWidget UI language. Supported: de, en, es, fr, ar.
reporting_periodNo12Months of transaction history to include in generated reports.
📘

Choosing a user_id

Use a stable identifier from your own system - your internal customer ID or email address. This is how you will identify which artifacts belong to which user in the Console. If the same user completes the flow twice with the same user_id, their new artifacts are grouped under the same entry.

Distributing the link

Once constructed, send the link to the user through any channel:

  • As a button or hyperlink on a webpage
  • In a transactional or marketing email
  • In an SMS or messenger message
  • Via a customer portal or chatbot

When the user opens the link, the nrich Widget guides them through bank selection and authentication. After the flow completes, artifacts are generated and become available in the Console.

🚧

If the user abandons the flow

If a user closes the Widget before completing authentication, no artifacts are generated and they will not appear in the Console. You can re-send the same link at any time. The user_id remains consistent, so any subsequent completion will appear under the same user entry.

3. Access results in the Console

Once a user completes the flow, their artifacts are available in the Qwist Console.

  1. Log in to the Qwist Console.
  2. Open the Qwist Link results section.
  3. Find the user by the user_id you used when constructing the link.
  4. Open their details page to see all generated artifacts.
  5. Download each artifact as JSON.

The artifacts shown reflect your application's configuration. accounts and transactions are always present. Reports appear if they were enabled during onboarding.

📘

Programmatic access to Qwist Link artifacts is on the roadmap

Results are currently only available through the Console. API-based access to Qwist Link artifacts is planned - get in touch if this is on your critical path.