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

# List all supported institutions

> Get a list of all supported institutions. Use the institution IDs when creating new financial connections.



## OpenAPI

````yaml /openapi/v1.json get /finance/institutions
openapi: 3.2.0
info:
  title: Synci
  version: '1.0'
  description: >-
    Synci is a platform for integrating financial accounts with your favorite
    apps.
servers:
  - url: https://api.synci.io/api/v1
security:
  - oauth2: []
  - http: []
tags:
  - name: Finance
    kind: nav
  - name: Connections
    parent: Finance
  - name: Accounts
    parent: Finance
  - name: Transactions
    parent: Finance
  - name: Institutions
    parent: Finance
  - name: Destinations
    kind: nav
  - name: YNAB
    parent: Destinations
  - name: Lunch Money
    parent: Destinations
  - name: Google Sheets
    parent: Destinations
  - name: SimpleFIN
    parent: Destinations
  - name: Notion
    parent: Destinations
  - name: Account
    kind: nav
  - name: Webhooks
    parent: Account
  - name: User
    parent: Account
  - name: rule-engine
    summary: Rules
    kind: nav
  - name: Rules
    parent: rule-engine
  - name: Rule Logs
    parent: rule-engine
  - name: Transfers
    kind: nav
  - name: Transfer Links
    parent: Transfers
  - name: Transfer Logs
    parent: Transfers
paths:
  /finance/institutions:
    get:
      tags:
        - Institutions
      summary: List all supported institutions
      description: >-
        Get a list of all supported institutions. Use the institution IDs when
        creating new financial connections.
      operationId: financial.institutions.index
      parameters:
        - name: page[size]
          in: query
          description: The number of results that will be returned per page.
          schema:
            type: integer
            default: 25
        - name: page[number]
          in: query
          description: The page number to start the pagination from.
          schema:
            type: integer
        - name: filter[name]
          in: query
          schema:
            type: string
        - name: filter[integrator]
          in: query
          schema:
            type: string
        - name: filter[country]
          in: query
          schema:
            type: string
        - name: filter[bic]
          in: query
          schema:
            type: string
        - name: filter[category]
          in: query
          schema:
            type: string
        - name: filter[external_id]
          in: query
          schema:
            type: string
        - name: filter[supports_card_accounts]
          in: query
          schema:
            type: string
        - name: filter[supports_pending_transactions]
          in: query
          schema:
            type: string
        - name: filter[supported]
          in: query
          description: |-
            Filter by support status. Only supported institutions are
            listed unless you ask otherwise: `filter[supported]=false`
            lists the retired ones instead.
          schema:
            type: string
        - name: filter[domain]
          in: query
          description: |-
            Filter by data domain: `bank` returns banking institutions,
            `asset` returns brokerages and crypto exchanges. Synci's demo
            banks are not part of `bank` here; list them with
            `filter[integrator]=DEMO`.
          schema:
            type: string
        - name: filter[search]
          in: query
          description: Search for supported banks by name or BIC/SWIFT code
          schema:
            type: string
        - name: sort
          in: query
          schema:
            type: array
            items:
              type: string
              enum:
                - id
                - '-id'
                - name
                - '-name'
                - category
                - '-category'
          explode: false
        - name: fields[institutions]
          in: query
          schema:
            type: array
            items:
              type: string
              enum:
                - id
                - name
                - integrator
                - country
                - bic
                - external_id
                - supported
                - logo
                - domain
                - category
          explode: false
      responses:
        '200':
          description: Paginated set of `InstitutionResource`
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/InstitutionResource'
                  links:
                    type: object
                    properties:
                      first:
                        type:
                          - string
                          - 'null'
                      last:
                        type:
                          - string
                          - 'null'
                      prev:
                        type:
                          - string
                          - 'null'
                      next:
                        type:
                          - string
                          - 'null'
                    required:
                      - first
                      - last
                      - prev
                      - next
                  meta:
                    type: object
                    properties:
                      current_page:
                        type: integer
                        minimum: 1
                      from:
                        type:
                          - integer
                          - 'null'
                        minimum: 1
                      last_page:
                        type: integer
                        minimum: 1
                      links:
                        type: array
                        description: Generated paginator links.
                        items:
                          type: object
                          properties:
                            url:
                              type:
                                - string
                                - 'null'
                            label:
                              type: string
                            active:
                              type: boolean
                          required:
                            - url
                            - label
                            - active
                      path:
                        type:
                          - string
                          - 'null'
                        description: Base path for paginator generated URLs.
                      per_page:
                        type: integer
                        description: Number of items shown per page.
                        minimum: 0
                      to:
                        type:
                          - integer
                          - 'null'
                        description: Number of the last item in the slice.
                        minimum: 1
                      total:
                        type: integer
                        description: Total number of items being paginated.
                        minimum: 0
                    required:
                      - current_page
                      - from
                      - last_page
                      - links
                      - path
                      - per_page
                      - to
                      - total
                required:
                  - data
                  - links
                  - meta
        '401':
          $ref: '#/components/responses/AuthenticationException'
components:
  schemas:
    InstitutionResource:
      type: object
      properties:
        id:
          type: string
        integrator:
          type: string
          description: The integrator used to connect to this institution.
        region:
          type: string
          description: >-
            Residency region connections to this institution are stored in
            (`eu`, `us`).
        country:
          type: string
          description: ISO 3166-1 alpha-2 country code.
        name:
          type: string
          description: Name of the institution.
        bic:
          type: string
          description: Institution Identifier Code (BIC/SWIFT code).
        external_id:
          type: string
          description: The ID of the institution as provided by the integrator.
        logo:
          type: string
          description: URL to the institution's logo, as provided by the integrator.
        supported:
          type: string
          description: >-
            Whether the institution is supported. Will be true in most cases,
            but might be false if the integrator stops supporting an
            institution.
        supports_pending_transactions:
          type: string
          description: Whether the institution supports pending transactions.
        supports_card_accounts:
          type: string
          description: Whether the institution supports card accounts.
        max_historical_days:
          type: string
          description: >-
            The maximum number of days of historical data this institution can
            provide.

            `null` where the provider imposes no such limit and fetches whatever
            the bank

            holds, which is the case for every US institution. Do not read null
            as zero.
        max_access_valid_for_days:
          type: string
          description: >-
            Also known as consent lifetime. The maximum number of days access to
            this institution may be valid for.

            For most European institutions this ranges from 90 to 180 days.
            `null` where access does not

            expire on a schedule and no periodic re-consent is required, which
            is the case for every US

            institution: those connections break only when the bank breaks them.
        supported_products:
          type: string
          description: >-
            The kinds of data this institution can serve, e.g. `["ACCOUNTS",
            "TRANSACTIONS", "INVESTMENTS"]`.

            `null` means the provider does not report it, NOT that the
            institution serves nothing: treat it

            as no information rather than as a negative. Only US institutions
            report it today.
        category:
          type:
            - string
            - 'null'
          description: The category of the financial institution.
        updated_at:
          type: string
          description: The date and time when the institution was last updated.
      required:
        - id
        - integrator
        - region
        - country
        - name
        - bic
        - external_id
        - logo
        - supported
        - supports_pending_transactions
        - supports_card_accounts
        - max_historical_days
        - max_access_valid_for_days
        - supported_products
        - category
        - updated_at
      title: InstitutionResource
  responses:
    AuthenticationException:
      description: Unauthenticated
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                description: Error overview.
            required:
              - message
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://api.synci.io/oauth/authorize
          tokenUrl: https://api.synci.io/oauth/token
          scopes:
            profile:read: View your name, email, and profile details
            accounts:read: View your connected financial accounts and balances
            accounts:write: >-
              Update, sync, and remove your financial accounts, and change their
              settings
            transactions:read: View your transactions
            transactions:write: Create, update, and delete your transactions
            sensitive:read: >-
              See sensitive identifiers like account numbers and account holder
              names
            transfer-links:read: View your transfer links and their transfer history
            transfer-links:write: Create, update, and delete transfer links, and undo transfers
            rules:read: View your rules and rule activity
            rules:write: Create, update, and delete rules, and undo rule actions
            webhooks:read: View your webhook endpoints
            webhooks:write: >-
              Create, update, and delete webhook endpoints, and rotate their
              secrets
            destinations:read: View your connected destinations
            destinations:write: Connect, update, and remove destinations
            financial-connections:read: View your connected institutions
            financial-connections:write: Manage your connected institutions
    http:
      type: http
      description: Bearer token (personal access token or OAuth access token)
      scheme: bearer

````

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