HomeGuidesAPI Reference
Log In
Guides

Implementation Guide

Getting Started

Qwist Link does not require any backend integration. Three steps separate you from your first artifacts:

  1. Sign up to the Qwist Console and create an application
  2. Generate and distribute a Qwist Link
  3. Access the results in the Qwist Console

1. Sign up and create an application

Sign up to the Qwist Console and create an application. Each application represents an integration of yours with Qwist and is issued its own client_id and client_secret pair. For Qwist Link, only the client_id is needed. To configure the capabilities of your application — including which reports (income-report, risk-report, user-insights) are generated for your users — contact our support team. Accounts and transactions are always produced and require no additional configuration.

2. Generate and Distribute a Qwist Link

A Qwist Link is a static URL that you can construct without any server-side logic.

https://regshield.qwist.cloud/link?client_id={CLIENT_ID}&user_id=USER_ID&language={LANGUAGE}&reporting_period={MONTHS}
https://api.finx-s.qwist.cloud/link?client_id={CLIENT_ID}&user_id=USER_ID&language={LANGUAGE}&reporting_period={MONTHS}
https://regshield.qwist.cloud/link?client_id=f2e46016-bde5-462b-...&[email protected]

Query Parameters

ParameterRequiredDefaultDescription
client_idYes-Your Qwist client identifier.
user_idYes-A unique identifier for the end user, chosen by you. Used to associate the resulting artifacts with a user in the Console.
languageNoenLanguage code for the Widget UI (e.g.de, en).
reporting_periodNo12Number of months of transaction history to include in generated reports.
📘

Choosing the user_id

The user_id is a free-form string that you control. Recommendation is to use a stable identifier from your own system — for example your internal customer ID or an email address — so that you can later correlate artifacts in the Console with users in your application.

Distributing the Link

Once generated, the link can be delivered to your end user through any channel:

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

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

3. Access Results in the Console

Once a user has successfully completed the flow, the artifacts are available in the Qwist Console.

  1. Log in to the Qwist Console.
  2. Open the Qwist Link results section.
  3. The Console displays a list of users who have completed the flow, identified by the user_id you provided when generating the link.
  4. Open a user's details page to see all artifacts generated for that user.
  5. Download each artifact as JSON.

The set of artifacts shown for each user reflects your client configuration: accounts and transactions are always present; reports appear if they were enabled during onboarding.

👍

Looking for API-based access?

Qwist Link currently makes results available exclusively through the Console. Programmatic access to Qwist Link artifacts is on our roadmap — get in touch if this is on your critical path.