Skip to content

me-box/driver-truelayer

Repository files navigation

driver-truelayer

A DataBox driver to stream financial data from TrueLayer. TrueLayer supports a series of UK banks (soon to be expanded to more countries). At the moment it has only been tested with Monzo bank.

Status

This is work in progress but getting better ;-).

Authentication

If you wish to use this driver with your own TrueLayer account then:

  • Sign up in https://truelayer.com and log in.
  • Create a new app and set the redirect_url to https://127.0.0.1/driver-truelayer/ui/truelayer-redirect.
  • Copy and paste client_id and client_secret into the driver and click Authorize.
  • In the driver settings, choose the bank account you wish to monitor and the Refresh Interval (in minutes).

Note: (if enabled in the driver) you can use a mock bank and mock account(s) for testing - follow the authentication flow and select 'mock bank'. The login screen suggests a default mock user to try.

Data stored

This driver writes transactional event data into a store-json for later processing.

It saves the following streams of data:

  1. truelayerUserBalance: the balance on every refresh update (30 minutes by default)
  2. truelayerUserTransactions: detailed transactions of the monitored account.

These can then be accessed store-json API.

See truelayer types for transactions and balances

Issues

  • add value examples

  • redirect URLs are hard-coded as https://127.0.0.1/... so will only work from a local browser (not the app)

  • only the success flow is handled, e.g. user cancelling authentication isn't handled (raises exception, view times out).

  • the client secret is accessible - should be at least hidden as a password field.

  • there is no status visible to the user, e.g. that it has been configured (or not), and with which account (if any) after the initial authentication flow has completed.

  • the authentication flow ends with a redirect to an app page in a separate browser tab, i.e. not within the core-ui.

  • there is no way to stop the driver once successfully configured (other than uninstalling it and authenticating successfully again with a different account). This is partly because the authentication failures are not handled, so old authentication information is retained and used, but an explicit option would be good.

Databox is funded by the following grants:

EP/N028260/1, Databox: Privacy-Aware Infrastructure for Managing Personal Data

EP/N028260/2, Databox: Privacy-Aware Infrastructure for Managing Personal Data

EP/N014243/1, Future Everyday Interaction with the Autonomous Internet of Things

EP/M001636/1, Privacy-by-Design: Building Accountability into the Internet of Things (IoTDatabox)

EP/M02315X/1, From Human Data to Personal Experience

About

A Databox (@me-box) driver to stream bank data through TrueLayer to a datastore

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published