Get Institution

Get Institution

Fetches details about a single institution.

URL

GET
/institutions/{institution_id}
Request
curl --request GET \
  --url https://api.moneykit.com/institutions/[institution_id] \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
const options = {method: 'GET', headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'}};

fetch('https://api.moneykit.com/institutions/[institution_id]', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));
import requests

url = "https://api.moneykit.com/institutions/[institution_id]"

headers = {"Authorization": "Bearer REPLACE_BEARER_TOKEN"}

response = requests.request("GET", url, headers=headers)

print(response.text)
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://api.moneykit.com/institutions/[institution_id]"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer REPLACE_BEARER_TOKEN")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.moneykit.com/institutions/[institution_id]")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer REPLACE_BEARER_TOKEN'

response = http.request(request)
puts response.read_body
import Foundation

let headers = ["Authorization": "Bearer REPLACE_BEARER_TOKEN"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.moneykit.com/institutions/[institution_id]")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
Response
{
  "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
}
{
  "error_code": "api_error.auth.expired_access_token",
  "error_message": "Access token expired",
  "documentation_url": string
}
{
  "error_code": "institution_error.not_found",
  "error_message": "Institution not found",
  "documentation_url": string
}
{
  "error_code": "api_error.rate_limit_exceeded",
  "error_message": "Rate limit exceeded",
  "documentation_url": string
}

institution_id

: string

required

The institution ID to fetch.

example: chase

Responses

200

Institution found

institution_id

: string

required

MoneyKit's unique ID for this institution.

example: chase

institution_id_aliases

: array

required

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

example: bf6856b2-0460-4e1e-b837-8dd9c1338bc1

example: ins_56

name

: string

required

The name of the institution.

example: Chase

country

: 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.

US GB CA

example: US

Allowed values:

"US"

"GB"

"CA"

domain

: string

required

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

example: chase.com

color

: string

required

The primary color of this institution, represented as hexcode.

example: #0A89FF

color_dark

: string

required

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

example: #0A89FF

401

Invalid access_token or insufficent API client scope.

404

Institution not found

error_code

: string

required

institution_error.not_found

default: "institution_error.not_found"

Allowed values:

"institution_error.not_found"

error_message

: string

required

default: "Institution not found"

documentation_url

: string

required

429

Rate limit exceeded.

error_code

: string

required

api_error.rate_limit_exceeded

default: "api_error.rate_limit_exceeded"

Allowed values:

"api_error.rate_limit_exceeded"

error_message

: string

required

Error message

default: "Rate limit exceeded"

documentation_url

: string

required