Skip to content

Banklink v2Customer-held keys and one-off fetches, through the Node.js SDK. v1 is unchanged.Migration guide

Banklink Docs

Banklink v2 is available

Every organisation can now use v2, with customer-held keys and one-off fetches through the Node.js SDK. v1 is unchanged.

Banklink v2 is open to every organisation. In v2, your application holds the key that unlocks a saved bank login, approves each fetch, and decrypts the result itself. See Banklink v2.

  • Turn on v2 for an API key. In Settings → API Keys, new live keys have Allow v2 ticked, and existing live keys have a Turn on v2 button. A key keeps all of its v1 permissions when v2 is added.
  • Node.js SDK 0.3.0. BanklinkV2 from @banklink/sdk/v2 handles customer keys, saved connections (profiles.create, profiles.sync) and one-off fetches (profiles.syncOnce). The default Banklink export still talks to v1.
  • Python SDK: coming soon. v2 support in the Python SDK is on the way. Until then, the Python SDK covers v1.
  • One-off fetches without a saved key. profiles.syncOnce uses a throwaway key that lives only for the job.
  • Progress you can show. onStatus reports each stage, including the deadline for approving a sign-in in a banking app.
  • Banks. FNB and Standard Bank. Capitec stays on v1 until the SDK supports its QR sign-in.

No. v1, Pulses, webhooks, the hosted link page and the dashboard all work as before. If you want to move an integration, follow Migrating to v2. Bank accounts need to be relinked through v2. Your sign-in, organisation and API keys stay the same.

v2 needs a live key. Test keys get test_key_not_supported, and there’s no hosted v2 sandbox yet.