As part of this natural evolution and progression, we have taken the decision to deprecate this older version 0.9 of the API by the end of July 2018.  

We understand that you will need some time to upgrade to the new version and we are here to help you.  The exciting news is that we have just released a new version of the API 2.0.

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:

We are on version 2.0 right now and have made significant advances since 0.9 which includes:

Version 1.0

  • Connections are now contained in a new User resource. This will make it much easier for you to administer connections as you no longer need to worry about keep track of all the connection id's.

  • You can now request to refresh all of the users connections with a single api call! 

  • You can now see a list of all the connections that a user has setup.

  • Transactions are now paginated to make it faster to retrieve transaction data.

  • In addition to the above, the most significant change which we have made is to make the connection creation and the data retrieval (from the banks) an asynchronous process. This has significant benefits as it enables you to track the progress of each connection when retrieving data. This also means that longer running processes will no longer time-out. 

Version 2.0

  • Transactions can now be filtered by the following properties: account, transaction date, connection, transaction status and institution

  • Classification of expense records

  • Ability to refresh all connections simultaneously by simply invoking /users/:id/refresh

  • The ability to 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

  • many more

In addition we have  also released a series of SDKs that help you accelerate development. You can check these out here: 

Most importantly the biggest significant update we have made is to the pricing structure. In version 0.9 we charged on a per connection basis, so you would essentially be charged every single time one of your users linked their financial institution. With version 2.0 we have changed this to be on a per user basis (regardless of the number of banks the user connects via your app). This makes is simple for you to calculate the fees.

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

  • To use the new API you will need to specify the following version request header on all calls: basiq-version: 2.0

  • Note that If you don't specify the new version number, the system will default to 1.0 (the previous version).

  • 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:

  1. 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).

  2. 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"}]

  3. 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.

What will happen to the current version of the API you are using (0.9)?

  • We plan to depreciate the old version (0.9) by the end of July 2018 

  • Note that although we will continue to support version 1.0 but will not be adding any new features to it. 

  • We strongly encourage you to migrate over to take advantage of the new features and improved performance.

Did this answer your question?