Skip to content

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

Banklink Docs

API keys

Turn on v2 for a live API key without changing what it can do on v1, and keep it safe.

v2 uses the same API keys as v1. A key needs v2 turned on before it can call v2.

In the dashboard, open Settings → API Keys:

  • For a new key, keep Allow v2 ticked when you create it. It’s ticked by default for live keys.
  • For an existing live key, choose Turn on v2. Keys with v2 show a v2 badge.

Turning on v2 keeps every v1 permission the key already had, so your v1 integration carries on unchanged. You need editor access or above.

Pass the key to the SDK:

const banklink = new BanklinkV2({ apiKey: process.env.BANKLINK_API_KEY! });

v2 has no sandbox yet. Test keys (sk_test_…) are refused with test_key_not_supported. A live key without v2 is refused with forbidden. Use the v1 sandbox for synthetic data.

Keep keys server-side. Don’t put them in browser or mobile code.

Restrict a key to your servers

A key can be limited to a list of IP addresses or CIDR ranges, at most 25. Calls with that key from any other address return 403 ip_not_allowed, so a leaked key is useless outside your network. A key without a list works from any address. Set the list in the dashboard under Settings → API Keys.

Your API key identifies your organisation to Banklink. Your customer key unlocks saved bank logins and decrypts results. Rolling an API key doesn’t touch the customer key, and the other way round. If one leaks, check which one before you act.