Skip to main content
GET
/
institutions
/
{institution_id}
/institutions/{institution_id}
curl --request GET \
  --url http://localhost:8080/institutions/{institution_id} \
  --header 'Authorization: Bearer <token>'
{
  "institution_id": "chase",
  "institution_id_aliases": [
    "bf6856b2-0460-4e1e-b837-8dd9c1338bc1",
    "ins_56"
  ],
  "name": "Chase",
  "country": "US",
  "domain": "chase.com",
  "color": "#0A89FF",
  "color_dark": "#0A89FF",
  "is_featured": true
}
curl -i -X GET \
  'http://localhost:8080/institutions/{institution_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'moneykit-version: 2023-02-18'

{
  "institution_id": "chase",
  "institution_id_aliases": [
    "bf6856b2-0460-4e1e-b837-8dd9c1338bc1",
    "ins_56"
  ],
  "name": "Chase",
  "country": "US",
  "domain": "chase.com",
  "color": "#0A89FF",
  "color_dark": "#0A89FF",
  "is_featured": true
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
moneykit-version
string
default:2023-02-18

Path Parameters

​
institution_id
string
required

The institution ID to fetch.

Response

Institution found

​
institution_id
string
required

MoneyKit's unique ID for this institution.

Example:

"chase"

​
institution_id_aliases
string[]
required

Alternative institution IDs that point to this institution that can be used for lookup.

Example:
[
  "bf6856b2-0460-4e1e-b837-8dd9c1338bc1",
  "ins_56"
]
​
name
string
required

The name of the institution.

Example:

"Chase"

​
country
enum<string>
required

The two-letter country code for this institution. Note that British institutions are designated GB (not UK). Possible values are: US, GB, CA. An enumeration.

Available options:
US,
GB,
CA
Example:

"US"

​
color
string
required

The primary color of this institution, represented as hexcode.

Example:

"#0A89FF"

​
is_featured
boolean
required

True for institutions that should be visually promoted to the end-user.

​
domain
string

The domain of the institution's customer-facing website.

Example:

"chase.com"

​
color_dark
string

The dark-mode primary color of this institution, represented as hexcode.

Example:

"#0A89FF"