Bank Connections

List banks available to connect

Returns all active banks with certified AIS v6 and Consent v2 support that SIX currently permits this application to connect to. Use this to build a bank picker: take the providerId of the bank the user selects and pass it to POST /bank/connect to start the consent flow.

Each item has providerId (the id to connect with), name, abbreviation, url, and logo. logo is null unless ?logos=true is set, in which case it is a data: URI (SVG) suitable for direct display.

get/bank/providers

Request

Base URL
https://api.vocal.email/v1
Auth
- API key in header X-API-Key
- or HTTP bearer
TypeScript
https://skmtc.dev/vocal/apis/magic-heidi-invoicing-software-api/docs/bank/providers/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

logosboolean

When true, include each bank's logo as a data: URI in logo.

Response

List of connectable banks

dataunknown

successtrue required

Example response

{
  "data": {},
  "success": true
}

Changes

No recorded changes to this operation across all 5 revisions of this API.