Skip to content

Commit f76539d

Browse files
committed
feat/PROD-48147/new quant flow documentation
1 parent d831e23 commit f76539d

File tree

5 files changed

+137
-3
lines changed

5 files changed

+137
-3
lines changed
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
title: Get Consent for a Bank Account
3+
parent: Connect Your Bank Accounts
4+
layout: default
5+
nav_order: 1
6+
---
7+
8+
# Step 1: Get Consent for a Bank Account
9+
10+
Providing consent is the essential first step to securely connecting your bank to Quant Flow. This process, often facilitated by Open Banking, is a regulatory requirement that gives you control and security.
11+
12+
## What is Consent?
13+
14+
Consent is your formal authorization for Quant Flow to access specific financial data from your bank, such as transaction histories and account details. This is done through a secure portal directly with your bank, meaning your login credentials are never shared with or seen by Quant Flow.
15+
16+
## How to Get Consent
17+
18+
1. Navigate to the **Bank Accounts** section in your Quant Flow dashboard.
19+
2. Click **"Connect New Bank Account"**.
20+
3. Select your bank from the list of supported institutions.
21+
4. You will be securely redirected to your own bank's website or app.
22+
5. Authenticate yourself directly with your bank (e.g., using your mobile banking app, card reader, or password).
23+
6. Your bank will clearly show what data you are sharing and for how long. Review and confirm this request.
24+
25+
## Consent Expiry (UK Accounts)
26+
27+
For accounts based in the United Kingdom, regulations require that access consents are renewed every **90 days**. Quant Flow will notify your Admin Users well before a consent expires to ensure a seamless, uninterrupted service.
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
title: Connect Your Bank Accounts
3+
layout: page
4+
nav_order: 3
5+
---
6+
7+
# Connect Your Bank Accounts to Quant Flow
8+
9+
Welcome to the heart of your financial automation. Connecting your bank accounts is a secure and straightforward process that unlocks the full power of Quant Flow for your company.
10+
11+
Once connected, you can automate payments, reconcile transactions, and gain real-time financial insights—all from a single dashboard.
12+
13+
## How It Works: A Simple Three-Step Process
14+
15+
Linking a new bank account to your company's Quant Flow profile is designed to be quick and compliant.
16+
17+
1. **Grant Consent (Authorize)**
18+
* **What it is:** You securely provide Quant Flow with permission to access transaction data from your bank. This is a standard regulatory requirement known as Open Banking (in the UK/Europe) or similar frameworks globally.
19+
* **Who does it:** Any Admin User for your company. The authorization is given for the entire company, not just an individual user.
20+
21+
2. **Link & Activate**
22+
* **What it is:** Once consent is granted, you "activate" the bank account for use within Quant Flow. This is when the magic starts.
23+
* **Who does it:** An Admin User decides which consented accounts to activate.
24+
* **The Key:** The number of bank accounts you can actively **link and use** is determined by your **Quant Flow User Plan**. Think of your plan as defining how many simultaneous automation streams you can have.
25+
26+
3. **Manage & Automate**
27+
* **What it is:** With an active bank account linked, you can now create powerful automations (like rule-based payments, cash flow forecasts, and reconciliation scripts) that run seamlessly.
28+
* **You are in control:** You can view connection status, extend consents, or deactivate accounts at any time from your dashboard.
29+
30+
## Key Things to Know
31+
32+
* **Company-Wide Access:** All Admin Users under your `CompanyID` can view and manage your company's bank connections. This ensures transparency and collaborative financial management.
33+
* **Your Plan, Your Capacity:** Your subscription plan defines the number of bank accounts you can have **active and automated** at once. You can always upgrade your plan to link more accounts.
34+
* **Secure by Design:** We use robust, bank-level security and never store your online banking credentials.
35+
36+
---
37+
38+
**Ready to get started?** Explore the guides below to learn about each step in detail.
39+
{: .note .p-3 }
40+
41+
* [How to Get Consent for a Bank Account](./get_consent)
42+
* [How to Link and Activate a Bank Account](./link_account)
43+
* [Managing Your Connected Accounts](./manage_consents)
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
title: Link and Activate a Bank Account
3+
parent: Connect Your Bank Accounts
4+
layout: default
5+
nav_order: 2
6+
---
7+
8+
# Step 2: Link and Activate a Bank Account
9+
10+
After you have successfully granted consent, the next step is to activate the bank account within Quant Flow to start building automations.
11+
12+
## Consent vs. Activation
13+
14+
* **Consent:** The *permission* to access the data. A company can have consent for many bank accounts.
15+
* **Linking/Activation:** The *action* of using that consented account within your automations. The number of accounts you can activate is limited by your User Plan.
16+
17+
## How to Link an Account
18+
19+
1. Go to **Bank Accounts**. You will see a list of all accounts for which your company has given consent. They are going to be separated in two sections **"Active bank account"s, "Inactive bank accounts"**
20+
2. Find the account you wish to use in the **"Inactive bank accounts"** and click **"Activate"**.
21+
3. The system will check if you have available slots in your current User Plan.
22+
4. If you do, the account will become active and its status will change to **"Active"**. You can now create automations that use this account.
23+
5. If you have reached your plan's limit, you will be prompted to **upgrade your plan** before you can activate the new account.
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
title: Manage Your Connected Accounts
3+
parent: Connect Your Bank Accounts
4+
layout: default
5+
nav_order: 3
6+
---
7+
8+
# Managing Consents and Connected Accounts
9+
10+
You have full visibility and control over all your company's bank connections from the Quant Flow dashboard.
11+
12+
## Viewing Connected Accounts
13+
14+
The **Bank Accounts** overview page shows all accounts associated with your `CompanyID`, including:
15+
* **Account Name/Nickname**
16+
* **Bank Name**
17+
* **Account Number** (masked for security)
18+
* **Status:** (e.g., `Active`, `Inactive`, `Expired`, `Authorised`, `Revoked`)
19+
* **Consent Expiry Date**
20+
21+
## Extending Consent
22+
23+
For UK accounts, you must renew consent every 90 days.
24+
1. The system will show an **"In X days your bank account will expire, please extend"** warning next to relevant accounts.
25+
2. An Admin User can click **"Extend"** button.
26+
3. You will be guided through the same secure authentication process with your bank to grant a new 90-day consent. Your existing automations will continue to run without interruption.
27+
28+
## Deactivating an Account
29+
30+
You can deactivate an account at any time.
31+
1. Find the active account and select **"Deactivate"**.
32+
2. **Important Consideration:** Deactivating an account will pause **all automations** associated with it. This may disrupt scheduled payments, data feeds, or reconciliation processes. You will be asked to confirm this action.
33+
3. The account will move to an **"Inactive"** state but will retain its consent, allowing you to easily reactivate it later without going through the full bank authorization again (as long as the consent is still valid).
34+
35+
## Revoking Consent Entirely
36+
37+
If you wish to permanently remove Quant Flow's access to an account:
38+
1. You can **"Revoke Consent"** from either an Active or Inactive account.
39+
2. This action is irreversible and severs the connection to your bank.
40+
3. All automations for this account will be permanently halted.
41+
4. To use this account again in the future, you will need to start from the beginning of the consent process.

docs/sandbox/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: Sandbox
3-
layout: page
4-
nav_order: 3
2+
#title: Sandbox
3+
#layout: page
4+
#nav_order: 6
55
---
66

77
# Sandbox

0 commit comments

Comments
 (0)