---
title: "Search banks"
method: POST
path: "/v1/banks/brands/search"
tags: ["Banks"]
---

# Search banks

`POST /v1/banks/brands/search`

## Request

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

Search the bank catalog. One result per bank, with every way to connect it and which one we recommend, replacing the one-result-per-provider shape of /banks/search. Reads the nightly catalog only: a bank a provider listed since last night appears here after the next harvest.

## Request body

- object
  - `query` string, required
  - `market` string
  - `limit` integer

## Response `200`

Matching banks

- object
  - `success` true, required
  - `data` object, required
    - `brands` object[], required
      - `key` string, required
      - `name` string, required
      - `slug` string, nullable, required
      - `market` string, required
      - `logoUrl` string, nullable, required
      - `websiteUrl` string, nullable, required
      - `description` string, nullable, required
      - `tags` string[], required
      - `matchedOn` 'name' | 'alias' | 'tag' | 'routing' | 'domain' | 'fts' | 'live', required
      - `provisional` boolean, required
      - `accountTypes` string[]
      - `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

## Other responses

- `400`: Invalid request
- `401`: Unauthorized
- `404`: 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)