May'23 ☁️

940

Accounts Metadata

🔨 What's Improved?

We have improved our API by extending the accounts EP with CDR attributes in our GET /accounts and GET /accounts/{id} endpoints within connectors data. The new attributes are below.

Fees:

  • name
  • feeType
  • amount
  • accrualFrequency

DepositRates:

  • depositRateType
  • rate
  • applicationFrequency

LendingRates:

  • lendingRateType
  • rate
  • applicationFrequency

Loan:

  • startDate
  • endDate
  • repaymentType
  • minInstalmentAmount

CreditCard:

  • minPaymentAmount
  • paymentDueAmount
  • paymentCurrency
  • paymentDueDate

These attributes provide information about fees, deposit rates, lending rates, loan details, and credit card information within the context of banking accounts and transactions.

for more updates, read more on GET /accounts and GET /accounts/ {id} endpoints.

May'23 🔨

What's New? 🌟

We have exciting news for you. We are going to launch Webhooks in a few weeks from now. 🚀

2066

BASIQ Webhooks

What is a Webhook?

A webhook is a reverse API, or server to server push notification. They work by sending out an HTTP request to a specified endpoint when an event is triggered. This makes webhooks ideal for integrating two applications. Webhooks are a way for Basiq to notify your application when certain events occur in our system. This allows your application to react in real-time to changes in our solution without needing to constantly poll our APIs for updates.

What is API Polling?

API polling is the process of repeatedly sending requests to the same endpoint and comparing subsequent responses you receive to determine if there is updated information.

Why use Webhooks?

Webhooks are a powerful way to integrate your application with other applications or services in real-time. Instead of manually polling for updates or changes, webhooks allow your application to automatically receive notifications or data when specific events occur.

Using webhooks can save you time and resources, improve your application's performance and enhance its functionality. With webhooks, your application can stay up-to-date with changes or events in other applications or services, and trigger actions based on the data received.

The Beta docs are coming soon. Stay tuned for more updates

If you have any questions or queries, please reach out to us by clicking on the bottom right chat option or email us at [email protected].

April '23 🐰

🔨 What's Improved?

Introduced jobIds parameter

Basiq allows your users to create multiple connections within a single flow when the Allow multiple connections feature is enabled in the Basiq dashboard. With the new jobIds parameter, you can retrieve all the jobIds from connection attempts appended to the Redirect URL.

This parameter makes it easier and more streamlined for you to track the progress of multiple connections within the same session. The Redirect URL contains all jobIds from that session, including the newest jobId like so:

http://www.your-redirect-url.com/?jobId=789&jobIds=123,456,789

Refer to the Dashboard configuration page for more information on how to enable the Allow multiple connections feature.

Updated Disclosure object

With this update, the Disclosure object (supporting party) will now be correctly stored when a consent is updated. This ensures that all necessary information related to the supporting party is accurately captured and stored.

Overall, these updates will help improve the functionality and user experience of the ConsentUI tool. Users will now have more comprehensive information at their disposal, enabling better tracking and management of consent-related tasks. Additionally, the improved consent storage will ensure that all necessary information is accurately captured and stored for future reference.

March '23 ☀️

🌟 What's Coming?

Slick new API Filters Improvements

 
We are excited to announce that we are updating all of our API filters. With this update, we will be returning more helpful error messages when invalid filters are used. Previously, our filters were failing silently, which made it difficult for developers to identify and resolve issues.

What does this mean for you?

With more accurate error messages, you will be able to quickly identify and fix any issues that may arise from using incorrect filters on our Endpoints. This improvement will undoubtedly enhance the development and usage of our API and improve the overall performance and reliability of our platform and your integration.

Stay tuned for the upcoming release of this improvement!

{
    "type": "list",
    "correlationId": "82038bb2-9fb4-9fb4-9fb4-9ca60b3a7555",
    "data": [
        {
            "type": "error",
            "code": "parameter-not-valid",
            "title": "Parameter value is not valid",
            "detail": "The provided filter parameter is in invalid format or unsupported",
            "source": {
                "parameter": "filter"
            }
        }
    ]
}

PermissionSets

We have recently announced new permission sets for Reports API. These updates provide users with greater control over data access and security, enabling administrators to grant specific permissions to groups of users.

With the new permission sets, administrators can control access to reports based on the user's role and profile. This allows for better management of data access, ensuring that users only have access to the data they need to perform their job functions.

The updated permission sets also allow for granular control over report access, giving administrators the ability to restrict access to specific reports or report folders. This is particularly useful in situations where sensitive data needs to be protected or when compliance regulations require strict data access controls.

Overall, the new permission sets for Reports with BASIQ API provide enhanced security and greater control over data access, making it easier for administrators to manage data access and ensuring that users have access to the data they need to perform their job functions.

683

Report Permissions

Keen to find out more about permissionSets, you read that docs here.

Improvements 💟

The Accounts endpoint has been extended to include Credit Limit information for applicable accounts.

Users can now retrieve their credit limit for eligible accounts using the Accounts endpoint.

The eligible account types are credit-card, loan and mortgage.

The update is below from our testing personas.

{
  "type": "list",
  "data": [
    {
      "type": "account",
      "id": "s55bf3",
      "accountHolder": "GAVIN BELSON",
      "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",
      "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"
  }
}

For further info, please check out our docs here.

March '23

by Ashman Malik

March '23 ☀️

🌟 What's new? 🌱

We are excited to announce that partners will now have access to additional customization options in the layout tab. These new features will allow partners to have more control over the appearance of their content, and include the ability to set a custom paragraph line height and change icon colors. These customization options are designed to help partners achieve their desired visual style and enhance the overall user experience. We hope these new features will provide partners with more flexibility and creative freedom to make their content stand out.

Here's a screenshot of what it's looking like.

1373

Customise UI (Layout Tab)

Error Handling 🪝

We are pleased to announce that ConsentUI has been updated to handle and display certain errors more effectively. With this update, ConsentUI will now correctly handle and display the following errors:

Disconnected: If the client's internet connection is lost, ConsentUI will display an appropriate message to indicate that the connection has been lost and the user may need to try again later.

430

Disconnected

Data deletion in progress: If data deletion is in progress, ConsentUI will display a message to inform the user that their data is being deleted and to try again later.

425

Data Deletion in Progress

Connections not enabled for a specific partner API key: If a partner API key does not have connections enabled, ConsentUI will display an error message indicating that connections need to be enabled for that partner API key.

Payments not enabled: If a partner tries to use the payment parameter but payments are not enabled, ConsentUI will display an error message indicating that payments need to be enabled.

We believe these improvements will provide a better user experience for partners and users alike, by providing more specific and informative error messages in these scenarios. We are committed to continuing to improve the functionality and usability of ConsentUI, and we look forward to sharing further updates in the near future. 💙

Consent UI Updates 📣

We are excited to announce that ConsentUI has been updated to display an expiry countdown for MFA (multi-factor authentication) connections, as well as providing the ability for users to retry or go back if the MFA connection expires.

With this update, users will be able to see the remaining time before the MFA connection expires, which will help them better manage their session and prevent any unexpected disconnections. In addition, if the MFA connection does expire, the user will be presented with options to retry or go back to the previous screen, making the overall experience more seamless and user-friendly.

We believe that these new features will provide a more streamlined and intuitive experience for users, particularly those who rely on MFA connections for added security. We are committed to continually improving the functionality and usability of ConsentUI, and look forward to sharing further updates in the future.

Consent Scopes Updates 🚀

We would like to inform our partners that, as part of our compliance with open banking requirements, it is no longer possible to add the account.detail scope without also including the account.basic scope.

This means that partners will need to include both the account.detail and account.basic scopes in any requests that require access to account information. This requirement is designed to ensure that partners are only accessing the minimum amount of data necessary to provide their services, while also maintaining a high level of security and compliance.

We understand that this may require partners to update their existing integrations, and we apologize for any inconvenience this may cause. However, we believe that this change is necessary to ensure that we are complying with industry standards and regulations, and maintaining the highest level of security and trust for our users.

We are committed to providing our partners with the necessary support to make this transition as smooth as possible. If you have any questions or concerns about this change, please do not hesitate to contact our support team. We appreciate your cooperation and understanding.

Discontinued Support ☔

We would like to inform our partners that as part of our ongoing efforts to improve the security and compliance of our platform, it is no longer possible to request unsupported scopes such as Direct Debits and Saved Payees.

This change is designed to ensure that partners are only requesting the minimum amount of data necessary to provide their services, while also ensuring compliance with industry standards and regulations. We believe that this change will help to maintain a high level of security and trust for our users, and reduce the risk of unauthorized access to sensitive data.

We understand that this may require partners to update their existing integrations, and we apologize for any inconvenience this may cause. However, we believe that this change is necessary to ensure the continued reliability and security of our platform.

We are committed to providing our partners with the necessary support to make this transition as smooth as possible.

📘

Future Updates

If you have any questions or concerns about this change, please do not hesitate to contact our support team at [email protected]. We appreciate your cooperation and understanding.

February '23

by Ashman Malik

February '23 ☀️

🌟 What's new?

Trusted Advisor Model Update

Trusted Advisor update is live on Consent UI. We will always display Application name.

💰 Payments UI

Payments UI has been updated to use action=payments parameter instead of Capture payment accounts toggle

ℹ️ Consent Scopes

  • Removed Direct Debits and Saved Payee scopes from consent permission list. We do not support retrieval of these via open banking

  • Updated scope requirements so that account.basic is required when adding account.detail.

January '23

by Ashman Malik

January '23 ❄️

🌟 What's new?

ConsentUI has been updated

Now shows Trusted Advisor details when available (if CDR Access Model is TA Organisation or TA Individual)

 

396

Trusted advisor can be TA organisation or TA individual.

December '22

by Ashman Malik

December '22 🔗

🌟 What's new?

Basiq Customise UI

Partners can use the Layout tab within ConsentUI customise to adjust the fonts, colors, text size and appearance of other elements of ConsentUI.

1662

Read more about this update here.