Quickstart
Install the Node.js SDK, turn on v2 for an API key, and fetch bank data once.
This gets you from nothing to a decrypted result with a one-off fetch. A one-off fetch needs no customer key and stores nothing.
1. Get a key with v2
Section titled “1. Get a key with v2”In the dashboard, open Settings → API Keys. Create a live key with Allow v2 ticked, or choose Turn on v2 on an existing live key. See API keys.
2. Install the SDK
Section titled “2. Install the SDK”You need Node.js 20 or later.
npm install @banklink/sdk@0.4.03. Fetch once
Section titled “3. Fetch once”import { BanklinkV2 } from '@banklink/sdk/v2';
const banklink = new BanklinkV2({ apiKey: process.env.BANKLINK_API_KEY! });
const result = await banklink.profiles.syncOnce({ bank: 'fnb', fields: await collectBankLoginPrivately(), fromDate: '2026-10-01', onOtp: async () => collectOtpPrivately(), onStatus(status) { showProgress(status); },});collectBankLoginPrivately, collectOtpPrivately and showProgress are your own code. fields are the login fields the bank needs. banklink.banks.list() returns them for each bank (see Banks).
The result comes back as unknown. Validate its shape before you use it. Keep logins, one-time PINs and results out of your logs.
Next steps
Section titled “Next steps”- To fetch the same account again without asking for the login each time, set up a customer key and a saved connection.
- Show the account holder what the bank is waiting for with progress events.
- Handle failures with the typed errors.