Getting Started
Getting Started with nrich
nrich is Qwist's open banking API. It gives your application access to bank account data, identity verification, income analysis, risk scoring, and payment initiation - all through a single integration.
Start in the sandboxGet sandbox credentials instantly at console.qwist.cloud. You'll have access to a demo bank for end-to-end testing with no approval required.
Which product do I need?
Retrieve bank account details, balances, and transaction history with one-time user consent. Best for onboarding flows, affordability snapshots, and credit checks.
Continuously sync all of a user's bank accounts across multiple banks, automatically refreshed up to 4× per day. Best for PFM apps, spending insights, and overdraft prevention.
Verify a user's identity by comparing their claimed name against the account holder name at their bank. No micro-deposits, no document uploads.
Get a verified breakdown of a user's income, regular expenses, and disposable income from their actual transaction history. Best for lending and affordability decisions.
Multi-dimensional financial risk profile - income stability, spending behaviour, overdraft history, gambling and debt indicators. Best for credit scoring and underwriting.
Initiate SEPA Credit Transfers directly from a user's bank account. Available in Germany and Italy.
Already have transaction data from another provider? Send it to nrich to get enrichment, income reports, and risk scores without switching your AIS provider.
No integration required. Share a static URL with your user - they connect their bank via the Widget, and artifacts appear in the Qwist Console. Best for pilots, small portfolios, and non-technical teams.
Quick decision guide
| I want to… | Product |
|---|---|
| Verify who someone is using their bank account | Account Verification |
| Check if someone can afford a loan or subscription | Income Verification or Risk Insights |
| Show a user all their accounts in one place | Financial Data (ongoing) |
| Pull account data once for a one-off check | Financial Data (one-time) |
| Score a borrower's credit risk | Risk Insights |
| Accept bank transfers as a payment method | Pay-by-Bank |
| Enrich transaction data I already have | Transaction Upload |
| Collect bank data without any coding or integration | Qwist Link |
How the API works
Every product follows the same pattern:
Call the API to generate a URL. Forward your user to it.
The nrich Widget guides the user through bank selection and Strong Customer Authentication (SCA).
After the user returns to your app, exchange the authorization code for an access token.
Use the access token to call the relevant report or data endpoints.
Two products skip this pattern entirely:
- Transaction Upload - no Widget, no OAuth. You upload transaction data directly from your server.
- Qwist Link - no server-side API calls at all. You construct a static URL and share it with the user. Results go to the Qwist Console, not to a callback on your server.
Base URLs
| Environment | Base URL |
|---|---|
| Sandbox (recommended for development) | https://api.finx-s.qwist.cloud |
| Production (for Licenced Customers) | https://api.finx-p.qwist.cloud |
| Production (for customers using the Qwist Licence) | https://regshield.qwist.cloud/ |
All examples in this documentation use the sandbox URL. Switch to production when you're ready to go live.
Authentication
Initial API calls use HTTP Basic Authentication:
Authorization: Basic {Base64(clientId:clientSecret)}Get your sandbox clientId and clientSecret from console.qwist.cloud.
For most API Access use the access_token from step 3 as a Bearer token in all requests.
Authorization: Bearer {access_token}What's next?
Start with the product that matches your use case, or explore the API Reference for the full endpoint specification.