Skip to content
Developers

API reference / Access

GET/v1/access

Inspect key access

Returns key metadata, never the secret.

Reads use stored data and do not refresh the bank.

Request examples

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

Shell
curl 'https://api.bankmcp.app/v1/access' \
  -H "Authorization: Bearer $BANKING_API_KEY"
TypeScript
const response = await fetch('https://api.bankmcp.app/v1/access', {
  headers: {
    Authorization: `Bearer ${process.env.BANKING_API_KEY}`,
  },
});
if (!response.ok) throw new Error(`Banking returned ${response.status}`);
const data = await response.json();

Response

200 · application/json

idstringrequired
namestringrequired
prefixstringrequired
permissionsarray<"banks:read" | "accounts:read" | "balances:read" | "transactions:read" | "institutions:read" | "connections:create" | "banks:refresh" | "history:import" | "banks:disconnect" | "merchants:resolve" | "merchants:correct">required
Show permissions schema

"banks:read" | "accounts:read" | "balances:read" | "transactions:read" | "institutions:read" | "connections:create" | "banks:refresh" | "history:import" | "banks:disconnect" | "merchants:resolve" | "merchants:correct"

resourcesobject | object | objectrequired
Show resources schema
Option 1: object
type"all"required
Option 2: object
type"banks"required
bank_idsarray<string>required
Show bank_ids schema

string — Bank ID from list_banks, e.g. "DE:N26" (country code and bank name).

Option 3: object
type"accounts"required
account_idsarray<string>required
Show account_ids schema

string

created_atstringrequired
expires_atstringrequired
last_used_atstring | nullrequired
Show last_used_at schema
Option 1: string

string

Option 2: null

null

revoked_atstring | nullrequired
Show revoked_at schema
Option 1: string

string

Option 2: null

null

issued_bystring | nullrequired
Show issued_by schema
Option 1: string

string

Option 2: null

null

Errors

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

StatusCode
400INVALID_INPUT
401INVALID_API_KEY
403STEP_UP_REQUIRED
404NOT_FOUND
409CONFLICT
413REQUEST_TOO_LARGE
429RATE_LIMITED
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.