Improvement ❤️

Changelog - Overview

This changelog will help partners and developers stay informed about the changes and enhancements implemented over time.

Available Flows

1. Connect Flow (Default)

Changelog Entry: Improved user interface and added customisable elements for the Connect Flow.

Details: We have enhanced the visual design and customisation options for the Connect Flow. Partners can now fine-tune the appearance and functionality to better align with their brand and user experience requirements.

2. Manage Consent

Changelog Entry: Enhanced Manage Consent Flow for improved user experience.

Details: The Manage Consent Flow has been refined to offer an even more user-friendly experience. It now includes features to make it easier for users to review and manage their consents.

3. Extend Consent

Changelog Entry: Extended and Renewed Consent Flow now includes customisation options.

Details: The Extend Consent Flow has been expanded to allow users to renew their consent more easily. Additionally, new customisation options have been added, enabling partners to personalise the user journey.

4. Payments Flow (If Payments are Enabled)

Changelog Entry: Enhanced Payments Flow with improved design and functionality.

Details: For platforms with payment functionality enabled, the Payments Flow has been updated with improvements to design and functionality. This ensures a seamless payment consent and transaction experience for users.

👍

Quick Links

Connect Flow (Default)

Manage Consent

Extend Consent

Payments Flow

Basiq Dashboard 💟

We are thrilled to announce a series of substantial improvements to the Dashboard Reports feature, aiming to enhance user interactions and optimise the overall user experience.

Print and Export Reports to PDF 📄

You can now easily print or export reports to PDF directly from the Basiq Dashboard. Simply click on the Print button on the top right to print. Please refer to below image.

Average Monthly Credits/Debits 💸

We've added a new feature on the Summary page that displays average monthly credits and debits, providing you with more insightful financial data.

Customisable Request Consent Actions: 📧

On the Request Consent page, partners can now specify custom action methods such as "connect", "manage", "extend," and "update".

Improved Permission Sets: 🔍

We've revamped the grouping of permission sets for Events and Webhooks, ensuring a more organised and intuitive experience when managing permissions.

Enhanced Phone Number Validation: 📱

Our phone number validation system has been updated to support new formats, making it easier to input and verify phone numbers accurately.

Updated Favicon: 🌍

We've given the Basiq Dashboard a fresh look with an updated favicon.

Transaction Sorting: 🎉

Transactions on the Dashboard are now ordered correctly, providing a more seamless and logical viewing experience.

New Metrics ME042 and ME043: 🆕

Two new metrics, ME042 and ME043, have been added for income.

Basiq Connect Enhancement: 📱

The Basiq Connect feature, along with the associated NPM package, now supports the same action parameters as ConsentUI, aligning the functionalities and providing a more seamless experience for users.

Improvements 🎉

We have enhanced the Permission Sets to support Events and Webhooks Endpoints. Several new endpoints have been added to the list of permissions to provide more comprehensive control and access to these features.

Action Required:

If you are a partner with custom permission sets, you can update them via our BASIQ dashboard. It is essential to update them to include the following endpoints to ensure uninterrupted access to Webhooks and Events features:

Webhooks Endpoints:

• POST /notifications/webhooks - Create a new webhook.
• GET /notifications/webhooks - Retrieve a list of webhooks.
• POST /notifications/webhooks/{id} - Update an existing webhook.
• GET /notifications/webhooks/{id} - Retrieve details of a specific webhook.
• DELETE /notifications/webhooks/{id} - Delete a webhook.
• GET /notifications/webhooks/{id}/messages - Retrieve messages for a specific webhook.
• GET /notifications/webhooks/{id}/messages/{id} - Retrieve a specific message for a webhook.
• POST /notifications/messages/test - Send a test message.

Events Endpoints:

• GET /events - Retrieve a list of events.
• GET /events/types - Retrieve event types.
• GET /events/types/{id} - Retrieve details of a specific event type.

By updating your custom permission sets to include these endpoints, you can take full advantage of our enhanced Events and Webhooks functionality.

If you have any questions or require further assistance, please don't hesitate to reach out to our support team.

Improvements 💟

Improvements: Dashboard User Search Enhancement

We're excited to introduce significant enhancements to the Dashboard Reports feature, focusing on improving user search capabilities and overall user experience. This update brings about several changes to streamline user interaction and provide more efficient access to relevant data.

Key Changes:

Real-time Results:

Upon entering a search query and either hitting the 'Enter' key or clicking the search, the user list now updates dynamically to display the most relevant results.

Clear All Results:

To return to viewing the complete list of user results, users can simply submit an empty search query.

Pagination Enhancement:

In scenarios where there are multiple result pages, a user-friendly pagination element is now visible, featuring left and right arrow controls for easy navigation.

We believe these enhancements will greatly improve the usability of the Dashboard feature by enabling users to efficiently search and access the data they need. As always, we value your feedback and are committed to continuously enhancing our products to meet your needs.

Dashboard Search Example:

User Search Enhancement

If you have any questions or need assistance, please feel free to reach out to our dedicated support team. We are here to help and ensure a successful experience for you and your users.

Data Retrieval Addition ➕

• Introducing the "Data Retrieval Span (days)" feature in the Dashboard: Partners can now customize the duration of data retrieval for users connecting to specific institutions for the first time. The default value remains 730 days.

• When adjusted, the chosen value becomes part of the consent policy for the respective app. Permissible values range from 0 to 730 days.

• Please note that altering the value in the Dashboard does not retrospectively impact existing consents. For new connections, existing consents will continue to retrieve data for 730 days.

Note: This update is exclusively applicable to open banking consumers.

You can customise your consent UI within the customise UI by logging into your Basiq Dashboard.

If you have any questions or need assistance, please feel free to reach out to our dedicated support team. We are here to help and ensure a successful experience for you and your users.

Improvements 💟

accountOwnership

A value indicating the number of customers that have ownership of the account, according to the data holder's definition of account ownership. Does not indicate that all account owners are eligible consumers.

The enum options for accountOwnership are:

• UNKNOWN
• ONE_PARTY
• TWO_PARTY
• MANY_PARTY
• OTHER

For more info, please read our docs here.

{
  "type": "list",
  "data": [
    {
      "type": "account",
      "id": "s55bf3",
      "accountHolder": "GAVIN BELSON",
      "accountOwnership": "ONE_PARTY",
      "accountNo": "600000-157441965",
      "availableFunds": "420.28",
      "balance": "356.50",
      "creditLimit": "400000.00",
      "class": {
        "type": "mortgage",
        "product": "Hooli Home Loan"
      },
      "connection": "8fce3b",
      "currency": "AUD",
      "institution": "AU00000",
      "lastUpdated": "2019-09-28T13:39:33Z",
      "name": "Master Savings",
      "status": "available",
      "meta": {
        "fees": [
          {
            "name": "Dishonour fee",
            "feeType": "EVENT",
            "amount": "10.00",
            "accrualFrequency": "P1M"
          }
        ],
        "depositRates": [
          {
            "depositRateType": "VARIABLE",
            "rate": "0.0385",
            "applicationFrequency": "P1M"
          }
        ],
        "lendingRates": [
          {
            "lendingRateType": "PURCHASE",
            "rate": "0.2024",
            "applicationFrequency": "P1M"
          }
        ],
        "loan": {
          "startDate": "2019-10-01",
          "endDate": "2045-10-01",
          "repaymentType": "PRINCIPAL_AND_INTEREST",
          "minInstalmentAmount": "5500"
        },
        "creditCard": {
          "minPaymentAmount": "117.00",
          "paymentDueAmount": "5847.00",
          "paymentCurrency": "AUD",
          "paymentDueDate": "2023-12-12"
        }
      },
      "transactionIntervals": [
        {
          "from": "2018-07-01",
          "to": "2018-12-30"
        }
      ],
      "links": {
        "institution": "https://au-api.basiq.io/institutions/AU00000",
        "transactions": "https://au-api.basiq.io/users/ea3a81/transactions?filter=account.id.eq('s55bf3')",
        "self": "https://au-api.basiq.io/users/cd6fbd92/accounts/319ae910"
      }
    }
  ],
  "links": {
    "self": "https://au-api.basiq.io/users/cd6fbd92/accounts/319ae910"
  }
}

Token Endpoint Extension 📣

Basiq has extended the POST /token endpoint for requests with the scope CLIENT_ACCESS. The new organisation fields should be included in the request body as follows:

{
    "scope": "CLIENT_ACCESS", 
    "userId": "10be99c6-1944-4552-bd6f-08d893875179",
    "orgName": "Accountants XYZ Pty Ltd",
    "orgRefID": "0123456789",
    "orgRefType": "ABN",
    "orgType": "Financial Broker"
}

The supported values for the orgRefType field are ABN, AFSL, and ACN.

The supported values for the orgType field are Accountant, Financial Broker, Financial Advisor, Legal Professional, Tax Agent, and Financial Counselling Agency.

You can use the provided token to initiate the consent UI and continue connecting to your institution securely. The token includes the necessary information, such as the Trusted Advisor details and other relevant data, to ensure a smooth and compliant consent process.

By utilizing this token, you can seamlessly integrate the Trusted Advisor access model into your application, allowing qualified professionals to access consumer data for providing financial advice. You can read more about Trusted Advisor Model here.

If you have any questions or need assistance during the onboarding process or while using the Trusted Advisor model, please feel free to reach out to our dedicated support team. We are here to help and ensure a successful experience for you and your users.

Deprecation ⚠️

We appreciate your continued support and usage of our platform. We are writing to inform you about an important update regarding the deprecation of our BASIQ Connect Control UI. However, we have some exciting news to share as well.

At Basiq, we are committed to constantly evolving and improving our platform and tools. We are deprecating our BASIQ Connect Control UI, in favour of a shiny new one.

Here are the key changes and improvements you can expect:

Consent Mechanism: We have introduced a consent mechanism in the user flow. This empowers users by clearly outlining the access they are granting us and giving them control over their data.

MFA Support: With the release of version 3.0 of our API, we now offer support for Multi-Factor Authentication. To make integration easier, we have published it as an NPM package.

We have also released the new Basiq Connect Component on the auth links which are hosted on https://connect.basiq.io

What happens to the old UI control?

While you can continue to use the old BASIQ Connect Control UI until further notice, we want to inform you that it is now considered a public archive in our GitHub repository. We will no longer be adding new features, including MFA support, to the old UI control.

For detailed installation and usage instructions for the new Basiq Connect Component, please refer to the documentation available here.

If you have any questions or require assistance with the upgrade process, please do not hesitate to reach out to support.

Thank you for your understanding and support as we strive to provide you with the best Open Banking platform.

Basiq - The Open Banking Platform

Improvements 💟

Changelog for Payment Errors:

• Detailed error response is provided in case of an error, including the reason, error code, title, and error message.
• The error response allows developers and users to easily identify and understand the error.
• Users can take appropriate actions based on the error information to resolve the issue.

You can access these payment rejection errors here.

To get started with payments, please refer to our payments documentation.

June '23 ❄️

🌟 What's new?

Basiq Webhooks

We are thrilled to introduce the much-awaited feature: Webhooks! 🎉

Webhooks provide a seamless way for Basiq to notify your application about important events occurring in our system. With this integration, you can now stay informed and react in real-time to changes within our solution without the need to continually poll our APIs for updates.

Here's what you need to know about Webhooks:

Real-time notifications: Webhooks enable your application to receive instant notifications whenever specific events occur in our system. This ensures that you are always up to date with the latest information.

Customizable event selection: You have the flexibility to choose which events you want to be notified about. Whether it's a new transaction, a user account update, or any other significant action, you can tailor the notifications to fit your specific needs.

Efficient and reliable: By utilizing Webhooks, you can optimize your application's resource usage by eliminating the need for continuous polling of our APIs. Instead, you'll receive timely notifications only when relevant events occur, improving efficiency and reducing unnecessary requests.

Getting started with Webhooks is a breeze. Simply follow our comprehensive documentation, which provides step-by-step instructions and code examples to help you integrate this exciting feature seamlessly into your application.

We believe that Webhooks will empower you to build even more dynamic and responsive applications on top of Basiq's powerful platform. Stay connected, react faster, and unlock new possibilities with real-time event notifications!

As always, if you have any questions or need assistance, our support team is here to help. Reach out to us, and we'll be glad to guide you through the process.

Happy coding!

The Basiq Team