Saved connections
Link a bank login once with your customer key, then sync, verify, list and delete saved connections.
A saved connection (a profile) stores a bank login encrypted under your customer key. You collect the login once. Later fetches only need your key.
Link an account
Section titled “Link an account”Collect the bank login in your own interface, then create a profile:
const profile = await banklink.profiles.create({ bank: 'fnb', fields: { username, password }, nickname: 'Operations account', onOtp: async () => collectOtpPrivately(),});// profile.id, profile.bankId, and profile.data: the first fetch's resultcreate signs in to the bank straight away and returns the first result in data. If that first sign-in fails, the profile isn’t kept, so a wrong password isn’t saved. Store profile.id in your own database.
const result = await banklink.profiles.sync(profile.id, { fromDate: '2026-10-01', toDate: '2026-10-31', onOtp: async () => collectOtpPrivately(),});Filter what comes back:
| Option | Meaning |
|---|---|
fromDate, toDate |
Date range, YYYY-MM-DD |
accounts |
Only these account numbers, when one login holds several accounts |
The result comes back as unknown. Validate its shape before you use it.
v2 has no Pulses. To fetch on a schedule, call profiles.sync from your own scheduler (cron, a queue or a task runner).
Check a login still works
Section titled “Check a login still works”profiles.verify(id) runs the link step again: it signs in to the bank with the saved login and confirms it still works. Use it after the account holder changes their password, or before a scheduled run. It counts as a bank login.
List and delete
Section titled “List and delete”const profiles = await banklink.profiles.list();await banklink.profiles.delete(profile.id);list returns metadata only: id, bankId, nickname, kid (the customer key it’s encrypted to), credentialVersion and createdAt. delete removes the saved login.
Limits
Section titled “Limits”Each saved connection allows 3 bank logins in 10 minutes. A wrong password retried quickly is how bank lockouts happen. See Errors and limits.