Skip to content
Developers

API reference / Banks

POST/v1/connection-links

Create connection link

Requires connections:create. Resource restrictions also apply. Create connection links.

The customer must open the returned link and approve the connection at their bank.

Request examples

These examples use HTTP directly. Keep API keys on your server.

Shell
curl -X POST 'https://api.bankmcp.app/v1/connection-links' \
  -H "Authorization: Bearer $BANKING_API_KEY" \
  -H 'Content-Type: application/json' \
  --data '{"name":"Example Bank","country":"DE","psu_type":"personal"}'
TypeScript
const response = await fetch('https://api.bankmcp.app/v1/connection-links', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.BANKING_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "Example Bank",
    "country": "DE",
    "psu_type": "personal"
  }),
});
if (!response.ok) throw new Error(`Banking returned ${response.status}`);
const data = await response.json();

Request body

Content-Type: application/json

namestringrequired

Bank name exactly as returned by search_banks.

countrystring

Only for banks with several options (distinct BICs, e.g. ING or N26): any country of the option that holds the account. Omit it to let the user choose on the page.

psu_type"personal" | "business"

Defaults to personal, or to the only type the bank offers. Pass business only for business accounts.

Response

200 · application/json

urlstringrequired

The bank's connect page in the portal: give it to the user to open.

bankobjectrequired
Show bank schema
namestringrequired
countrystring | nullrequired
Show country schema
Option 1: string

string — ISO 3166-1 alpha-2 country code, e.g. DE

Option 2: null

null

psu_type"personal" | "business" | nullrequired
Show psu_type schema
Option 1: "personal" | "business"

"personal" | "business"

Option 2: null

null

optionsarray<object>
Show options schema
countrystringrequired

ISO 3166-1 alpha-2 country code, e.g. DE

countriesarray<string>required
Show countries schema

string — ISO 3166-1 alpha-2 country code, e.g. DE

bicstring | nullrequired
Show bic schema
Option 1: string

string

Option 2: null

null

instructionsstringrequired

Errors

Errors contain error, code and an optional action. Read the error and retry guide.

StatusCode
400INVALID_INPUT
401INVALID_API_KEY
403INSUFFICIENT_PERMISSION
404NOT_FOUND
409CONFLICT
413REQUEST_TOO_LARGE
429rate_limit.feature
500REQUEST_FAILED
502INVALID_RESPONSE
503UNAVAILABLE

Try this request

Sent directly to https://api.bankmcp.app. Your key stays in this page’s memory and is never saved.

This sends a real action with your key’s permissions. Review the request before sending.