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

# Find which providers cover a bank

> Answers *which provider should I connect this bank through* - call this before */api/v2/account/add* or */api/v2/account/add/lite*.

**name** searches bank names as free text. Each entry is one bank at one provider, carrying the **source** and the **id** to pass together as **source** and **institutionId** on the add call, plus **allowTransactions** and **allowStatements** so the provider that delivers the data you need can be picked.

A bank reachable through two providers appears twice, once per **source**, and either may be used. An **id** is only valid for the **source** listed beside it.

Unlike */api/v2/institutions*, which lists one provider's catalog at a time, this covers every provider in a single call.



## OpenAPI

````yaml /openapi-v2.json get /api/v2/institutions/provider-options
openapi: 3.1.0
info:
  title: LedgerSync V2 API
  version: '2.0'
servers:
  - url: https://ledgersyncappv2.com
    description: Production
  - url: https://staging.ledgersyncappv2.com
    description: Sandbox
security: []
tags:
  - name: account-api
    description: Account REST APIs
  - name: password-api
    description: Password REST APIs
  - name: transaction-api
    description: Transaction REST APIs
  - name: phone-verification-api
    description: Phone Verification REST APIs
  - name: employee-api
    description: Employee REST APIs
  - name: client-api
    description: Client REST APIs
  - name: check-api
    description: Check REST APIs
  - name: accounting-ai-api
    description: AI rule suggestion endpoints for external accounting integrations
  - name: institution-api
    description: Institution REST APIs
  - name: statement-api
    description: Statement REST APIs
  - name: authentication-api
    description: Auth REST APIs
paths:
  /api/v2/institutions/provider-options:
    get:
      tags:
        - institution-api
      summary: Find which providers cover a bank
      description: >-
        Answers *which provider should I connect this bank through* - call this
        before */api/v2/account/add* or */api/v2/account/add/lite*.


        **name** searches bank names as free text. Each entry is one bank at one
        provider, carrying the **source** and the **id** to pass together as
        **source** and **institutionId** on the add call, plus
        **allowTransactions** and **allowStatements** so the provider that
        delivers the data you need can be picked.


        A bank reachable through two providers appears twice, once per
        **source**, and either may be used. An **id** is only valid for the
        **source** listed beside it.


        Unlike */api/v2/institutions*, which lists one provider's catalog at a
        time, this covers every provider in a single call.
      operationId: getProviderOptions
      parameters:
        - name: name
          in: query
          required: false
          schema:
            type: string
        - name: page
          in: query
          required: false
          schema:
            type: integer
            format: int32
        - name: size
          in: query
          required: false
          schema:
            type: integer
            format: int32
        - name: Auth-Token
          in: header
          description: Authentication token provided during the authentication process
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Banks with the providers that cover them
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ProviderOptionsResponse'
        '403':
          description: You are not allowed to retrieve data
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ProviderOptionsResponse'
components:
  schemas:
    ProviderOptionsResponse:
      type: object
      properties:
        totalItems:
          type: integer
          format: int32
          description: Total rows available to page through for this search.
        truncated:
          type: boolean
          description: >-
            True when the search matched more banks than could be returned. The
            answer is a prefix rather than the whole set; narrow name rather
            than paging further.
        institutions:
          type: array
          description: >-
            One entry per bank and provider pair. A bank reachable through two
            providers appears twice, once per source, and either may be used to
            connect it.
          items:
            $ref: '#/components/schemas/InstitutionDto'
    InstitutionDto:
      type: object
      properties:
        id:
          type: string
          description: >-
            Pass this value as institutionId when adding an account with the
            same source.
        name:
          type: string
        email:
          type: string
        phone:
          type: string
        homeUrl:
          type: string
        imageUrl:
          type: string
        accountTypeDescription:
          type: string
        oauthEnabled:
          type: boolean
        source:
          type: string
          description: Bank-data provider this institution is reachable through.
          enum:
            - DEFAULT
            - FINICITY
            - FDE
            - MX
        allowStatements:
          type: boolean
          description: >-
            Whether this institution delivers statements through the given
            provider.
        allowTransactions:
          type: boolean
          description: >-
            Whether this institution delivers transactions through the given
            provider.

````

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