Customise UI
Customise your ConsentUI effortlessly to tailor the user experience according to your preferences and requirements.
Introduction:
Partners utilising the ConsentUI have the ability to customise various aspects of the interface through the Layout tab. This tab enables partners to adjust fonts, colors, text size, and the appearance of different elements within the ConsentUI.
Importance:
It's important to note that these customisations are instantly applied to all screens under the consent.basiq.io domain. This includes screens related to Consent Manage, Extend, Connect, and others.
Please be aware that the AuthUI project screens (found at connect.basiq.io) are not affected by these customisation options. The changes made in the Layout tab exclusively apply to the ConsentUI.
Partners can conveniently preview the live changes they make to the ConsentUI by utilising the Dashboard's editing feature. This allows partners to visualize the modifications and ensure they meet their desired design requirements.
Failures:
In the event of an error, such as the failure to load configuration values, the ConsentUI will gracefully fallback to default values. This ensures that the interface remains functional and consistent even if there are issues with the customisation settings.
Certain elements within the ConsentUI cannot be customised to maintain compliance. For example, the CDR logo will always remain on a white background, preserving the required branding standards.
Additional user interface (UI) elements, including shadows, divider lines, and loaders, are not customisable. However, they utilize a neutral black color with opacity. This design choice ensures that these elements stylistically blend with any color values chosen for customisation.
Icons within the ConsentUI inherit the color of their parent div. For instance, the 'info' button on the home screen will adopt the color of the paragraph text it is associated with. This behavior ensures a cohesive and consistent visual presentation throughout the interface.
Input fields within the ConsentUI inherit the 'accent' and 'inactive' color values. These fields are dynamic elements with multiple states, and their colors adapt accordingly. This design approach maintains visual harmony and provides clear visual cues to users based on the states of the input fields.
Glimpse
This is how the customiser UI looks like, loaded with an editor on the right hand side. The details are below:
Analytics (GTM)
In order to configure Google Tag Manager (GTM), the process begins with the utilisation of the Customiser feature. Through Customiser UI, partners are able to incorporate their own custom tags into the Analytics field of Google Tag Manager (GTM). This allows for a personalised and tailored tracking system.
Once the configuration is complete, additional code snippets are added to the ConsentUI. At present, the tracking setup primarily focuses on entire pages rather than individual elements such as buttons or links. This means that the tracking and analytics capabilities of the system are designed to monitor the navigation patterns of users, particularly their access to specific screens or pages.
However, it's important to note that the current setup does not include the identification of distinct actions within those pages. In other words, while the system can track user movement and interactions on a broader scale, it is unable to differentiate between different types of clicks or actions performed by users within those pages.
Customisable fields
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. |
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 consumer data | You should select this option if you anticipate that your organisation will need to retain CDR data once it is no longer required for CDR purposes only if it is authorised or required to retain the data by or under an Australian law. We will remove CDR data upon consent expiration. Data retention should be handled outside of Basiq. | |
Ask to retain de-identified data | In both cases for |
Appearance Tab Settings
Section | Feature | Description |
|---|---|---|
Header Image | Image selection | Manage the upload and display of a custom header image for brand visibility. The recommended size for header image is 1372x256 . |
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. |
Preview Screens
The Customise UI Preview feature allows partners to view and test different ConsentUI flows within your application. Partners can preview the appearance and functionality of three specific flows: Connect, Manage, Extend.
Available Flows
Connect Flow (Default)
The Connect Flow is the default ConsentUI flow. It is designed to help users connect their bank accounts to your platform. It typically involves selecting financial institutions, entering credentials, and providing consent for data access. With the Customise UI Preview, you can test the appearance and functionality of this flow.
Manage Consent
The Manage Consent Flow allows users to review and manage their existing consents. It's a user-friendly way for them to see which accounts they've connected, what data you have access to, and the ability to revoke or modify consents along with connections. The Customise UI Preview for this flow enables you to check how this management interface appears and functions.
Extend Consent
The Extend Consent Flow is used when users need to extend or renew their consent for data access. It's an important part of maintaining data access permissions. This feature in Customise UI Preview lets you review how the extension process works and how it's presented to the users.
Quick Links
You can get started here and let us know if you have any feedback for us to improve.
Mandatory Brand Name
We've made Brand name a mandatory value for all applications, including non-Business Consumer Changes (BCC). Partners who haven't defined it yet will be prompted to do so the next time they edit ConsentUI. Once Brand Name is added, the partners are able to 'save' their consent policy in the customise UI.
Updated 4 months ago