---
title: "Get a bank"
method: GET
path: "/v1/banks/brands/{brandId}"
tags: ["Banks"]
---

# Get a bank

`GET /v1/banks/brands/{brandId}`

## Request

- Base URL: `https://api.banksync.io`
- URL: `https://api.banksync.io/v1/banks/brands/{brandId}`
- Auth: one of:
  - API key in header `X-API-Key`
  - HTTP bearer

One bank and every way to connect it, including which we recommend, how much history stands behind that recommendation, and any way we cannot offer here — kept visible with its reason rather than dropped, because an absence reads as "this bank is unreachable".

## Path parameters

- `brandId` string, required: Bank ID

## Response `200`

The bank

- object
  - `success` true, required
  - `data` object, required
    - `brand` object, required
      - `key` string, required
      - `name` string, required
      - `slug` string, required
      - `market` string, required
      - `logoUrl` string, nullable, required
      - `websiteUrl` string, nullable, required
      - `description` string, nullable, required
      - `tags` string[], required
      - `institutionType` string, nullable, required
      - `accountTypes` string[], required
      - `ways` object[], required
        - `providerInstanceId` string, required
        - `providerInstitutionId` string, nullable, required
        - `targeting` 'portal' | 'picker', required
        - `consent` 'cdr' | 'psd2' | 'null', nullable, required
        - `recommended` boolean, required
        - `health` 'healthy' | 'degraded' | 'unknown', required
        - `waitlistOnly` boolean, required
        - `ineligibleReason` 'instance_disabled' | 'provider_down' | 'admin_discouraged' | 'portal_hidden' | 'no_portal' | 'null', nullable, required
        - `providerLabel` string, required
        - `portalCount` integer, required
        - `oauthSupported` boolean, required
        - `products` string[], required
        - `attempts` number, required
        - `sampleSufficient` boolean, required
        - `note` object, nullable, required
          - `hint` string, required
          - `severity` 'info' | 'degraded' | 'broken', required
      - `explored` boolean, required

## Other responses

- `401`: Unauthorized
- `404`: Bank not found, or the bank catalog is not enabled in this environment

---

[API](https://skmtc.dev/banksync/apis/banksync-api.md) · [All operations](https://skmtc.dev/banksync/apis/banksync-api/llms.txt) · [OpenAPI document](https://skmtc.dev/banksync/apis/banksync-api/revisions/94465f5ee922?raw)