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

# List institutions

> List institutions - Banking



## OpenAPI

````yaml v2/api-reference/openapi.json GET /v2/institutions
openapi: 3.0.0
info:
  title: Trio API v2
  version: 2026-10-19.v2
servers:
  - url: https://api.sandbox.trio.com.br
    variables: {}
  - url: https://api.qa.trio.com.br
    variables: {}
  - url: https://api.trio.com.br
    variables: {}
security: []
tags: []
paths:
  /v2/institutions:
    parameters:
      - description: >-
          Version of the v2 contract the client is written against. Each
          breaking change publishes a new version.
        example: 2026-10-19.v2
        in: header
        name: Trio-Version
        required: true
        schema:
          enum:
            - 2026-10-19.v2
          type: string
          x-struct: null
          x-validate: null
      - description: >-
          ID of another org to act on instead of the API key's own org. The
          key's org must have been granted access to it, and the request is
          refused with 403 FORBIDDEN otherwise. When that access or the API key
          is read-only, only GET and HEAD requests may carry it. When the target
          org requires mTLS, so does the request. Leave it out to act on the
          key's own org.
        in: header
        name: Trio-Target-Org-Id
        required: false
        schema:
          format: uuid
          type: string
          x-struct: null
          x-validate: null
    get:
      tags:
        - Institutions
      summary: List institutions
      description: List institutions - Banking
      operationId: TrioFoundationWeb.V2.InstitutionController.index
      parameters:
        - description: Bank ISPB
          in: query
          name: ispb
          required: false
          schema:
            type: string
            x-struct: null
            x-validate: null
        - description: Bank Number
          in: query
          name: number
          required: false
          schema:
            type: string
            x-struct: null
            x-validate: null
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2_list_institutions_response'
          description: Institutions
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2_error'
          description: >-
            Malformed request: a body that is not valid JSON
            (MALFORMED_REQUEST), or a Trio-Version header that is missing or not
            the current one (INVALID_TRIO_VERSION).
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2_error'
          description: Missing or invalid API key credentials (INVALID_CREDENTIALS).
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2_error'
          description: >-
            The API key may not do this (FORBIDDEN): for instance
            Trio-Target-Org-Id names an org it has no access to, or writes
            through a read-only access.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2_error'
          description: >-
            Invalid input (INVALID_PARAMETER, REQUIRED_PARAMETER, or the code of
            the rule the request breaks). A request outside the operation's
            schema lists the offending fields in `errors`.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2_error'
          description: >-
            A service needed to answer is unavailable
            (TRIO_SERVICE_UNAVAILABLE).
      callbacks: {}
      security:
        - authorization: []
components:
  schemas:
    V2_list_institutions_response:
      description: List of financial institutions
      example:
        data:
          - authorized: true
            display_name: 001 - 000000001 - Nome do Banco Ltda
            full_name: Nome do Banco Ltda
            id: 41234d60-f6a9-4c9c-8cc3-5769ce9bbea2
            inserted_at: '2024-10-17T13:32:59.374149Z'
            ispb: '00000001'
            name: Nome do Banco
            number: '001'
            updated_at: '2024-10-17T13:32:59.374149Z'
      properties:
        data:
          items:
            $ref: '#/components/schemas/V2_institution'
          type: array
          x-struct: null
          x-validate: null
      title: V2 list institutions response
      type: object
      x-struct: Elixir.TrioFoundationWeb.Schemas.Banking.V2.Institution.ListResponse
      x-validate: null
    V2_error:
      example:
        error:
          error_code: INVALID_PARAMETER
          error_message: 'Invalid parameters: /amount: Invalid integer. Got: string'
          errors:
            - field: /amount
              message: 'Invalid integer. Got: string'
      properties:
        error:
          properties:
            error_code:
              description: >-
                Stable UPPER_SNAKE identifier of the error, for programs and
                logs. Branch on this, not on the message.
              type: string
              x-struct: null
              x-validate: null
            error_message:
              description: Human readable explanation of the error.
              type: string
              x-struct: null
              x-validate: null
            errors:
              description: >-
                Only on INVALID_PARAMETER for a request outside the operation's
                schema: one entry per offending field.
              items:
                properties:
                  field:
                    description: JSON pointer to the field, e.g. /amount.
                    type: string
                    x-struct: null
                    x-validate: null
                  message:
                    description: What is wrong with it.
                    type: string
                    x-struct: null
                    x-validate: null
                required:
                  - field
                  - message
                type: object
                x-struct: null
                x-validate: null
              type: array
              x-struct: null
              x-validate: null
          required:
            - error_code
            - error_message
          type: object
          x-struct: null
          x-validate: null
      required:
        - error
      title: V2 error
      type: object
      x-struct: Elixir.TrioFoundationWeb.Schemas.HTTP.V2Error
      x-validate: null
    V2_institution:
      description: A financial institution
      example:
        authorized: true
        display_name: 001 - 000000001 - Nome do Banco Ltda
        full_name: Nome do Banco Ltda
        id: 41234d60-f6a9-4c9c-8cc3-5769ce9bbea2
        inserted_at: '2024-10-17T13:32:59.374149Z'
        ispb: '00000001'
        name: Nome do Banco
        number: '001'
        updated_at: '2024-10-17T13:32:59.374149Z'
      properties:
        authorized:
          description: Authorized institution?
          type: boolean
          x-struct: null
          x-validate: null
        display_name:
          description: Institution display name
          type: string
          x-struct: null
          x-validate: null
        full_name:
          description: Institution full name
          type: string
          x-struct: null
          x-validate: null
        id:
          description: Institution ID
          format: uuid
          type: string
          x-struct: null
          x-validate: null
        inserted_at:
          description: Creation date and time
          format: date-time
          type: string
          x-struct: null
          x-validate: null
        ispb:
          description: Institution ISPB
          type: string
          x-struct: null
          x-validate: null
        name:
          description: Institution name
          type: string
          x-struct: null
          x-validate: null
        number:
          description: Institution bank number
          type: string
          x-struct: null
          x-validate: null
        updated_at:
          description: Last update date and time
          format: date-time
          type: string
          x-struct: null
          x-validate: null
      title: V2 institution
      type: object
      x-struct: Elixir.TrioFoundationWeb.Schemas.Banking.V2.Institution.InstitutionData
      x-validate: null
  securitySchemes:
    authorization:
      scheme: basic
      type: http

````

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