Bank institution

List of supported bank (and other institutions).

Resource representation

{
  "id": "42",
  "ext_id": "ins_10",
  "name": "American Express",
  "url": "https://www.americanexpress.com/",
  "logo": "https://api.toshl.com/bank/institutions/42/logo",
  "provider": "plaid"
}

Properties

id readonly `string`	Institution id.
ext_id readonly `string`	Institution ext id.
name readonly `string`	Institution name.
country read, write `string`	Institution country Regex: `[A-Z]{2}`
url readonly `string`	Institution url.
logo readonly `string`	Institution logo url if institution has a logo.
auto_refresh readonly `boolean`	Auto refresh is set to `true` if institution can be automatically refreshed without users interaction after connection is established.
instructions readonly `string`	Additional instructions for institution (if available).
provider readonly `string`	Institution provider Possible values: `plaid, toshl, saltedge, saltedge-partner`
flow readonly `string`	Login flow type for institution Possible values: `custom, form, redirect`
form read, write `array`	Login form fields.
name readonly `string`	Field name
label readonly `string`	Field label
type readonly `string`	Field type Possible values: `text, password, option`
value readonly `string`	Field value
options readonly `array`	Field options
connect_url readonly `string`	URL where user must be redirected to start the connecting process. The client must append `next` query parameter to the URL. When user successfully finishes the authentication process `token` will be appended to the `next` URL. This is the token that must be used to create a connection.
token readonly `string`	Token used to open Plaid Link.
partner readonly `boolean`	`true` if institution is a partner
regulated readonly `boolean`	`true` if this institution is regulated via PSD2/Open Banking.
type readonly `string`	How Toshl connects to institution (via API or scraping). Possible values: `scraping, api`

* denotes required field/parameter.

Page last modified: 08 Jan 2024