API Updates 🌅

We are thrilled to announce the latest enhancements to our Accounts Endpoint (EP), which bring a host of new features and capabilities to enrich your experience. These updates are designed to provide you with deeper insights and greater flexibility in accessing account-related data.

New Features ❄️

amortisedLimit

• Introducing the amortisedLimit field, allowing you to access the available limit amortised according to the payment schedule. Even if absent, it's now assumed to be zero.

bundleName

• You can now benefit from the optional bundleName field, providing insight into whether an account is part of a bundle offering additional customer benefits.

creditLimit

• We've added support for creditLimit, indicating eligibility for various account types such as credit cards, loans, and mortgages.

meta

• Enhancing the meta field to offer comprehensive fee details including name, feeType, amount, balanceRate, transactionRate, accruedRate, accrualFrequency, currency, additionalValue, additionalInfo, additionalInfoUri, discounts, and eligibility. This includes descriptions and conditions for fees, their types, amounts, frequencies, and discount details.

lendingRates

• Now providing detailed information on lending rates with lendingRates, including type, rate, comparisonRate, calculationFrequency, applicationFrequency, interestPaymentDue, repaymentType, loanPurpose, tiers with conditions, and additional rate details.

termDeposit

• Included detailed information about term deposits, covering lodgementDate, maturityDate, maturityAmount, maturityCurrency, and maturityInstructions.

loan

• Expanded loan data to include various parameters such as startDate, endDate, repaymentType, loanAmount, loanCurrency, nextInstalmentDate, minInstalmentAmount, minInstalmentCurrency, maxRedraw, maxRedrawCurrency, minRedraw, minRedrawCurrency, offsetAccountEnabled, offsetAccountIds, and repaymentFrequency.

creditCard

• Detailed information about credit cards is now available, including minPaymentAmount, paymentDueAmount, paymentCurrency, and paymentDueDate.

📘

Documentation

Our documentation has been updated to reflect these exciting new additions to the Accounts Endpoint.

Dashboard Updates 🔧

We're thrilled to share the latest enhancements to our Basiq Dashboard:

Fresh Look and Feel

• We've given the dashboard a makeover to match the sleek design of our updated basiq.io website. Expect redesigned fonts, colors, and components that are easy on the eyes!

Improved Customise UI Layout

• We've revamped the customisation options for the Customise UI layout, making it even easier for you to tailor your dashboard experience to your preferences.

Consent Management

• Partners are no longer able to set custom text for consent scopes/permissions; it now defaults to CDR required wording read more here.

Enhanced Consent Functionality

• Need to reauthorise consent? No problem! We've added a handy "Reauthorise consent" option to the Request consent link parameters, giving you more control over your data permissions.

Check out our documentation for more on customising your Customise UI. Dive in and explore these exciting updates, and don't hesitate to reach out if you have any questions or feedback!

Latest Updates 🎄

Enhancements ❄️

Organisation Name Update: Partners now have the ability to update the Organisation name within the Organisation settings. This feature enhances customisation and control for partners over their dashboard settings.

Password Security Enhancement: To improve security, the dashboard registration process now requires a password with a minimum length of 12 characters. This change is part of our ongoing commitment to ensure the highest level of security and protection for our users.

Report Generation Speed Improvement: The speed of generating reports has been significantly improved, especially for reports without transactions included. This optimisation ensures a more efficient and smoother user experience when handling large sets of data.

Bug Fixes ⚓

Timezone Issue Resolution: Resolved a critical issue where Partners from certain timezones were unable to generate a Report with today's end date. This fix ensures that all users, regardless of their geographic location, have consistent and reliable access to report generation features.

If you have any questions or encounter any issues, please don't hesitate to reach out to our support team.

We are excited to announce the release of an enhanced action=reauthorise parameter, designed to improve the user experience and simplify consent management within the Basiq platform. The update includes a streamlined process for extending consent periods and addressing issues related to close-to-expiry connections.

Key Features:

Expiring Soon Connections:

Open banking connections with an expiryDate less than 7 days away are now conveniently categorised under the 'Expiring soon' section.

Simplified renewal process:

Once you see a renew button and click on it, you will be redirected to the data holder to extend the duration of your connections for the currently shared account. You may wish to extend sharing for the currently shared account or stop sharing it.

We believe these updates will enhance your interaction with the Basiq platform, providing a more efficient and user-friendly reauthorisation process. You can continue reading in our documentation here.

Thank you for your continued support!

New Features:

• Added MFA (Multi-Factor Authentication) support for Bendigo Bank, enhancing security for user interactions with the bank's services.

MFA Job Flow:

• Introduced a new job flow for Bendigo Bank that requires a slightly different approach compared to the standard job.
• Users can now identify if they are encountering an MFA challenge by checking the number of steps in the job process, as an MFA challenge typically consists of four steps.

Recommended Actions:

• We recommend users to verify the number of steps in the job process to determine if they are facing an MFA challenge.
• Adjust your workflow accordingly when dealing with MFA challenges specific to Bendigo Bank.

Non-UI Usage:

• For cases where you do not utilise our user interface (UI) when interacting with Bendigo Bank, it is essential to return "confirmed" (as a string) as an MFA response.
• This "confirmed" response indicates that your end user has opened an app, and Bendigo Bank relies on this response when establishing a connection.

Updated MFA Response for Bendigo Bank:

To respond to the MFA challenge when interacting with Bendigo Bank, you should use the following format:

POST /jobs/61723/mfa HTTP/1.1
Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/json

{
  "mfa-response": ["confirmed"]
}

If you have any questions or encounter any issues, please don't hesitate to reach out to our support team.

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"
  }
}