Quickstart: Basiq dashboard
Phase 1 - Setup and configuration invite team members
Register for a dashboard account
Registering for a Basiq account is easy and free! Simply hit get started and fill in your details to register
Configuring your dashboard account
Customise your dashboard so it aligns with your company branding
- Configure your organisation's details
- Add your organisation's logo
Establish your permission sets
Establish permission sets that can be applied at a user and API level to ensure that data is being viewed by the correct people.
Invite and manage team members
Collaborate with people from your business within the dashboard and provide access where required.
Editing profile account settings and enabling 2FA
Edit your profile details and keep your account secure by enabling two factor authentication.
Application setup
Establish your application environments with ease in the dashboard.
Basiq’s recommendation when setting up applications:
- Each application created will have its own data. Data cannot be shared between applications, including users. We recommend you create an application for production & an application for dev as bare minimum. You can create as many applications as you like, depending on the approach you aim to take
- When creating an application, you will be prompted to select the payments environment. Choose ‘sandbox’ for test data, ‘production’ for live data, or have it disabled if payments will not be used. Note that this selection cannot be changed once the application is created.
Generate an API key
If you are integrating with the Basiq API you can generate your API key with ease.
Phase 2 - Design
Customising your consent UI via the dashboard editor
Our integrated CDR compliant consent UI provides organisations with an out of the box solution to manage the complex nature of capturing customers consent to access their financial data. Quickly edit and configure an application’s consent UI and flow in just a few clicks via the Basiq dashboard, removing the need to update JSON files. From the customise UI editor you can also:
- Personalising text and messaging that greets end users so it aligns with your brand’s tone of voice. All consent policy fields can be configured including duration, policies, text and more.
- Configuring institutions you want to show or hide to end users. Allowing multiple institution connections, to determine if your end user should be able to connect more than one institution at a time.
- Preview changes in real time in the Dashboard UI editor before publishing to your live application.
- Determine data management behaviour by choosing how you would like to handle your end users data after consent revocation.
Consent Tab Settings
| Section | Feature | Description |
|---|---|---|
| Title and Subtitle | Brand name | Identifies your service in the consent UI, establishing a clear brand presence for users during the consent process. This should be recognisable and consistent with your other branding. |
| Title | Custom text fields for setting the main title hat appear in the consent UI, which can be used to communicate the purpose of the data sharing to the user effectively. | |
| Subtitle | Custom text fields for setting the subtitle that appear in the consent UI, which can be used to communicate the purpose of the data sharing to the user effectively. | |
| Purposes | [Your Purpose] | Defines the specific reasons for data collection. This section is to articulate the scope and intent of the data retrieval to users, ensuring transparency in data usage. |
| Permissions | Detailed control over the types of financial data the application will access, such as account names, balances, and transaction details. This ensures users are informed about what data is being accessed and for what purpose. | |
| Name and occupation | [Checkbox - unchecked] | |
| Name, occupation, contact details | [Checkbox - checked] | |
| Organisation profile | [Checkbox - unchecked] | |
| Organisation profile and contact details | [Checkbox - unchecked] | |
| Account name, type and balance | [Checkbox - checked] | |
| Account balance and details | [Checkbox - checked] | |
| Transaction details | [Checkbox - checked] | |
| Data | Duration (days) | Determines the validity period of user consent for data sharing. A standard setting is 365 days, but it can be adjusted according to specific business needs or regulatory requirements. |
| Data retrieval span (days) | Specifies the extent of historical financial data that users allow to access upon giving consent. This can range from a recent few days to an extensive span of up to two years, enabling detailed financial analysis. | |
| Retain data by default | When enabled, the system will automatically retain the retrieved financial data for the set duration. This setting is essential for maintaining continuous data access for analysis without prompting users for re-consent. |
Appearance Tab Settings
| Section | Feature | Description |
|---|---|---|
| Header Image | Image selection | Manage the upload and display of a custom header image for brand visibility |
| Always display header image | Check this option to always display headers on all screens. | |
| Font | Font | Select the font style that will be used throughout the UI, aiding in brand consistency. If you have a custom font, please contact Basiq to discuss its integration. |
| Primary color | Use this to change primary color. E.g # 130F26 | |
| Secondary color | Use this to change secondary color. E.g # 130F26 | |
| Inactive color | Use this to change inactive color. E.g # 7F888C | |
| Heading size (px) | Adjust the size of heading texts in pixels. | |
| Paragraph size (px) | Adjust the size of paragraph texts in pixels. | |
| Line height (px) | Adjust the height of lines in pixels for readability. | |
| Buttons | Primary button | Customise text and background color, along with border radius for primary buttons. |
| Secondary button | Customise text and background color, along with border radius for secondary buttons. | |
| Border radius (px) | Customise the border radius of your buttons. | |
| Colors | Control the UI's overall appearance, including background color and the colors used for messages indicating success, failure, or warnings. | |
| Success | # 4FC35A | |
| Warning | # FABE34 | |
| Failure | # FE493F | |
| Background | # FFFFFF | |
| Links | # 0459A8 | |
| Accreditation | # 2784DA | |
| Wrapper | Desktop width (px) | Define the width of the desktop UI wrapper in pixels to ensure proper layout fitting. |
Institution Tab Settings
| Section | Description |
|---|---|
| Select all Checkbox | Facilitates the selection or deselection of all financial institutions in the list for ease of management. |
| Institution List | A list where you can select which financial institutions will be available for users to connect with, tailored to the services and regions your application supports. |
Flow Tab Setting
| Section | Feature | Description |
|---|---|---|
| Preferences | Skip success screen | A toggle to bypass the confirmation screen after successful consent, offering a more streamlined experience for users. Useful for repeat users who are familiar with the process and do not require additional confirmation. |
| Allow multiple connections | Permits users to connect multiple bank accounts from different financial institutions, broadening the scope of data aggregation for a more comprehensive financial overview. | |
| Analytics (GTM) | This field accepts a Google Tag Manager tracking code, which allows for the collection of analytics on how users interact with the consent UI, providing insights into user behaviour and potential areas for UI improvement. | |
| External URLs | Redirect URL | The web address users will be redirected to after the consent process is completed. This URL is critical for maintaining a seamless user journey through the consent procedure, whether granting or revoking consent. |
You can also read more from here.
Phase 3 - Operational
Create a new user and manage users
Connect your users bank accounts and request additional consent
After configuring your consent UI Generate a Magiclink for users to securely connect their banking details.
Has a user already submitted their details but forgot an account? Simply generate and send them a new link for them to connect it, so you can always have the complete financial picture
Check a users accounts and transactions
Review transaction details of accounts connected by a user, filter transaction results and more.
Refresh a connection
Basiq makes it easy to keep your customers' financial data in sync. Instantly refresh any bank connection to retrieve the latest account details and transaction data.
Phase 4: Implement Insights (Reports)
Generating a consumer affordability insights report
NOTE: Generating reports is charged on a per report basis. Reports generated will be included in your monthly bill.
Monitor connector statuses via the status page
Troubleshoot job errors
Understand how to deep dive into job errors and follow some best practice tips on how best to troubleshoot.
Phase 5: Go live
How to enable your account for live data
Upon signing your agreement with Basiq you will be enabled with access to live banking data. Access to web connector data will be instant and Open Banking data will be available once you have completed the required security and compliance steps.
Simply choose the institutions you want to enable in your consent UI and you’ll be ready to start accessing consumer consented data.
How to connect a user via CDR
Below is the CDR user Journey.
Quick Links
Updated 9 days ago