> ## Documentation Index
> Fetch the complete documentation index at: https://docs.usepatchwork.co/llms.txt
> Use this file to discover all available pages before exploring further.

# List banks

> Banks and mobile money providers, with the `code` to send to `POST /v1/identify`. Pass `currency`, `country`, or both; `country` alone uses that country's currency, and `USD` spans several countries. Not billed.




## OpenAPI

````yaml /openapi.yaml get /v1/identify/banks
openapi: 3.1.0
info:
  title: Patchwork API
  version: 1.0.0
  description: >
    Public data-plane API. Two products today: Identify (bare account
    resolution) and Loom (threads, runs, and outcomes). Every response is a JSON
    envelope — `status: success` with `data`, or `status: error` with `error`.
  contact:
    url: https://usepatchwork.co
servers:
  - url: https://api.usepatchwork.co
security:
  - bearerAuth: []
tags:
  - name: Identify
    description: Resolve an account or wallet to the institution and rails behind it.
  - name: Extract
    description: >-
      Turn a document into structured data, and manage the schema types that
      shape it.
  - name: Loom
    description: Threads, messages, runs, and outcomes for an embedded agent.
  - name: Files
    description: Upload bytes once, get a durable handle, reference it from any product.
  - name: Voice
    description: Transcribe an utterance, speak a reply, list the available voices.
  - name: MCP
    description: >-
      The grants your users hold when they reach an agent from their own AI
      client.
paths:
  /v1/identify/banks:
    get:
      tags:
        - Identify
      summary: List banks
      description: >
        Banks and mobile money providers, with the `code` to send to `POST
        /v1/identify`. Pass `currency`, `country`, or both; `country` alone uses
        that country's currency, and `USD` spans several countries. Not billed.
      operationId: listBanks
      parameters:
        - name: currency
          in: query
          schema:
            type: string
            enum:
              - NGN
              - GHS
              - ZAR
              - KES
              - XOF
              - EGP
              - RWF
              - USD
        - name: country
          in: query
          schema:
            type: string
            enum:
              - NG
              - GH
              - ZA
              - KE
              - CI
              - EG
              - RW
      responses:
        '200':
          description: Banks, sorted by name.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvelopeBanks'
              example:
                status: success
                data:
                  - name: Guaranty Trust Bank
                    code: '058'
                    type: bank
                    scheme: nuban
                    country: NG
                    currency: NGN
                    rail: nuban
        '400':
          description: >
            Neither `currency` nor `country` given (`missing_parameter`), or an
            unsupported value (`unsupported_currency`, `unsupported_country`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '502':
          description: The bank directory could not be fetched (`banks_unavailable`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    EnvelopeBanks:
      type: object
      required:
        - status
        - data
      properties:
        status:
          type: string
          const: success
        data:
          type: array
          items:
            $ref: '#/components/schemas/Bank'
    Error:
      type: object
      required:
        - status
        - error
      properties:
        status:
          type: string
          const: error
        error:
          type: object
          required:
            - message
            - code
          properties:
            message:
              type: string
              description: Human-readable explanation.
            code:
              type: string
              description: Stable machine-readable code.
            details:
              description: Optional extra context.
    Bank:
      type: object
      required:
        - name
        - code
        - type
        - currency
      properties:
        name:
          type: string
        code:
          type: string
          description: The `code` to send to `POST /v1/identify`.
        type:
          type: string
          enum:
            - bank
            - mobile_money
        scheme:
          type: string
          description: >
            Local clearing scheme: `nuban`, `ghipss`, `kepss`, `basa`, `bceao`,
            `bnr`, `iban`, `mobile_money`, or `mobile_money_business`.
        country:
          type: string
          description: ISO 3166-1 alpha-2.
        currency:
          type: string
          description: ISO 4217.
        rail:
          type: string
          description: >
            Identify rail that accepts this code. Omitted for a scheme Identify
            does not resolve, such as `mobile_money_business`.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >
        Identify accepts a workspace API key (`sk_…`). Loom accepts either a
        short-lived session token (direct) or a workspace API key (relay).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.