If you missed it, the exciting news here at Basiq is that we released a new version of the Connect API. The new version is now in production and is ready for use.

There are quite a few new features that have been added to make development easier, and for you to deliver a richer experience to your customers.

You access the documentation for the new version here: https://basiq.io/api/


Connect v2.0 features include:

  • Transactions can now be filtered by the following properties: account, transaction date, connection, transaction status and institution
  • Expenses are now categorised using our powerful classification engine using machine learning algorithms and a multitude of data sources
  • All connections can now be refreshed simultaneously by simply invoking /users/:id/refresh
  • Track the status of each data refresh — you can now see and display the progress to your users as a connection authenticates, acquires account data and transaction data
  • Refresh data from a cache using our Scheduler product — data is refreshed up to 5 times a day providing even more opportunities to fine tune performance
  • In addition we have also released a series of SDKs that help you accelerate development. You can check these out here: https://github.com/basiqio/
  • …plus much more, take a look at the API docs and reach out to us with any questions: https://basiq.io/api/

How to migrate data over to the new API version 2.0?

  1. To use the new API you will need to specify the following version request header on all calls: basiq-version: 2.0
  2. Note that If you don’t specify the new version number, the system will default to 1.0 (the previous version).
  3. We have made it real easy for you to migrate the connections across from 0.9 / 1.0 to 2.0. To migrate over from the current version, simply follow these instructions:
  • Create a user using the POST /users resource. This will give you a new userid in the response (you will need to save this ID against the user record in your local DB).
  • POST all the connection ID’s for the user (that you have stored in your app) to the following resource: /users/:id/link in the following format: [{“connectionId”: “xxxxxxxxx”}, {“connectionId”: “zzzzzzzz”}]
  • You will need to do the above for all of your users. Once this done, all of the users will be setup in the Basiq system along with their connections, and you can now safely switch your code over to using the new version of the API.