> ## 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 Pix keys

> List all available Pix keys



## OpenAPI

````yaml v2/api-reference/openapi.json GET /v2/pix/keys
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/pix/keys:
    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:
        - Pix Keys
      summary: List Pix keys
      description: List all available Pix keys
      operationId: TrioFoundationWeb.V2.Pix.KeyController.index
      parameters:
        - description: Bank account ID
          in: query
          name: bank_account_id
          required: true
          schema:
            $ref: '#/components/schemas/UUID'
        - description: >-
            Parameter used for pagination. It is a base64 encoded param used to
            access the previous page of results. It is provided alongside a
            metadata section if there is a previous page.
          example: >-
            g3QAAAABZAACaWRtAAAAJDU4ZjFlYzhlLWFmYTktNDk0My05M2I1LWQ2ZGM3OWI0M2VhYQ==
          in: query
          name: before
          required: false
          schema:
            type: string
            x-struct: null
            x-validate: null
        - description: >-
            Parameter used for pagination. It's a base64 encoded param used to
            access the previous page of results. Provided along with the data in
            the metadata section if there is a previous page.
          example: >-
            g3QAAAABZAACaWRtAAAAJGJhYTNiNmM1LTAyYTYtNGQ5Ny05NzU1LTI3OGFiNjRiN2Y1MQ==
          in: query
          name: after
          required: false
          schema:
            type: string
            x-struct: null
            x-validate: null
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2_Pix_Key_list_response'
          description: Keys
        '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:
    UUID:
      description: Unique identifier
      format: uuid
      title: UUID
      type: string
      x-struct: null
      x-validate: null
    V2_Pix_Key_list_response:
      description: Pix Key list response
      example:
        data:
          - bank_account_id: 41234d60-f6a9-4c9c-8cc3-5769ce9bbea2
            id: 41234d60-f6a9-4c9c-8cc3-5769ce9bbea2
            inserted_at: '2020-01-10T10:00:00Z'
            key: '12345678900'
            status: created
            tax_number: '12345678900'
            type: tax_number
            updated_at: '2020-01-10T10:00:00Z'
        metadata:
          after: null
          before: null
          has_more: false
      properties:
        data:
          items:
            $ref: '#/components/schemas/V2_Pix_Key_response'
          type: array
          x-struct: null
          x-validate: null
        metadata:
          description: Pagination cursors
          properties:
            after:
              description: Cursor to the next page
              nullable: true
              type: string
              x-struct: null
              x-validate: null
            before:
              description: Cursor to the previous page
              nullable: true
              type: string
              x-struct: null
              x-validate: null
            has_more:
              description: Whether a next page exists
              type: boolean
              x-struct: null
              x-validate: null
          type: object
          x-struct: null
          x-validate: null
      title: V2 Pix Key list response
      type: object
      x-struct: Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Key.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_Pix_Key_response:
      description: Pix Key response
      example:
        bank_account_id: 41234d60-f6a9-4c9c-8cc3-5769ce9bbea2
        id: 41234d60-f6a9-4c9c-8cc3-5769ce9bbea2
        inserted_at: '2020-01-10T10:00:00Z'
        key: '12345678900'
        status: created
        tax_number: '12345678900'
        type: tax_number
        updated_at: '2020-01-10T10:00:00Z'
      properties:
        bank_account_id:
          description: Bank Account ID
          format: uuid
          type: string
          x-struct: null
          x-validate: null
        id:
          description: Unique identifier
          type: string
          x-struct: null
          x-validate: null
        inserted_at:
          description: Inserted at
          format: date-time
          type: string
          x-struct: null
          x-validate: null
        key:
          description: Pix Key key
          type: string
          x-struct: null
          x-validate: null
        status:
          description: Pix Key Status
          type: string
          x-struct: null
          x-validate: null
        tax_number:
          description: Tax number of the key owner
          type: string
          x-struct: null
          x-validate: null
        type:
          description: Pix Key type
          type: string
          x-struct: null
          x-validate: null
        updated_at:
          description: Updated at
          format: date-time
          type: string
          x-struct: null
          x-validate: null
      title: V2 Pix Key response
      type: object
      x-struct: Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Key.KeyData
      x-validate: null
  securitySchemes:
    authorization:
      scheme: basic
      type: http

````

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