Banklink v2
Fetch bank data with customer-held keys through the Node.js SDK. What v2 is, how it differs from v1, and where to start.
Banklink v2 is a second way to fetch bank data. In v2 you hold the key that unlocks a saved bank login. Your application approves each fetch and decrypts the result itself. You use v2 through the Node.js SDK (@banklink/sdk 0.3.0 and later) with the same Banklink sign-in, organisation and API keys you already have. v2 support in the Python SDK is coming soon.
v1 doesn’t change. Your current keys, Pulses, webhooks and hosted link pages keep working, and the v1 docs stay where they are. To move an existing integration, see Migrating from v1.
How v2 differs from v1
Section titled “How v2 differs from v1”| v1 | v2 | |
|---|---|---|
| Saved bank login | Encrypted with a Banklink key | Encrypted in your application. Only your customer key can approve its use |
| Who starts a fetch | Your API call, or a Pulse on a schedule | Your application, through the SDK |
| Where results go | The API response, the dashboard, webhooks or email | Back to your SDK, encrypted to your key, and decrypted there |
| What Banklink keeps | Linked accounts and stored transactions | Metadata and usage counts. No transaction history |
| Client | REST API, Node.js and Python SDKs | Node.js SDK. Python coming soon |
How a fetch works
Section titled “How a fetch works”- Your application asks for a job. The bank-connection worker answers with signed job details.
- The SDK checks the signature against Banklink’s published worker list, then approves a sealed release for that job alone.
- The worker opens the login for that job, signs in to the bank and fetches the data.
- The worker encrypts the result to your application’s key. The SDK decrypts it on your side.
The API in between only relays sealed payloads.
The bank-connection worker is run by Banklink. While a job runs, it opens the login to sign in to the bank and reads the data it fetches. Customer-held keys control when a saved login can be unlocked and protect what travels through the API. They don’t hide a running job from its operator. The security overview has the wider picture.
Start here
Section titled “Start here”- Quickstart: install the SDK and make your first fetch.
- API keys: turn on v2 for a key.
- Customer keys: create, back up and rotate the key that unlocks saved logins.
- Saved connections: link once, sync whenever you need to.
- SDK reference: every method and option.
What v2 doesn’t do yet
Section titled “What v2 doesn’t do yet”- Pulses, webhooks and email delivery. Schedule fetches in your own application.
- The hosted link page. Collect the bank login in your own interface.
- Transactions in the dashboard. v2 results only exist in your application.
- A sandbox. Test keys are refused. Use the v1 sandbox for synthetic data.
- Python. v2 support in the Python SDK is coming soon. Until then, the Python SDK covers v1.