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

# 4 - List Pix Keys

> <p>Scopes:</p>
<b>api.pix api.chave.listar</b>

Through this endpoint, the partner can query and list the Pix keys associated with their account. Both customers and partners can perform this verification, as long as they have previously registered their keys.


## OpenAPI

````yaml get /api/Chave/Listar
openapi: 3.0.1
info:
  title: Api Externa BMP SPI
  description: '<p><strong>Build Number: </strong>#0.0</p>'
  version: v1
servers:
  - url: https://api.ext.pix.dbs.moneyp.com.br/
    description: Localhost
security:
  - Bearer: []
paths:
  /api/Chave/Listar:
    get:
      tags:
        - Chave
      summary: Listar chaves PIX
      description: "<p>Scopes:</p>\r\n<b>api.pix api.chave.listar</b>"
      parameters:
        - name: ContaDto.Agencia
          in: query
          description: |-
            Número da agência bancária.*

            Observações:
            - O número da agência pode ter no máximo 4 caracteres.
          schema:
            type: string
            description: |-
              Número da agência bancária.*

              Observações:
              - O número da agência pode ter no máximo 4 caracteres.
        - name: ContaDto.AgenciaDigito
          in: query
          description: >-
            Dígito verificador da agência bancária.


            Observações:

            - O dígito verificador da agência bancária pode ter no máximo 1
            caracter.
          schema:
            type: string
            description: >-
              Dígito verificador da agência bancária.


              Observações:

              - O dígito verificador da agência bancária pode ter no máximo 1
              caracter.
        - name: ContaDto.Conta
          in: query
          description: >-
            Número da conta bancária.


            Observações:

            - O número da conta bancária pode ter no máximo 12 caracteres.

            - Para que seja possível localizar a conta, é necessário informar o
            'número da conta com dígito' (```contaPgto```) ou o 'número da
            conta' (```conta```) e o 'dígito verificador' (```contaDigito```).

            - Caso o 'número da conta com dígito' (```contaPgto```) seja
            informado, não é necessário preencher os campos 'número da conta'
            (```conta```) e 'dígito verificador' (```contaDigito```).

            - Caso nenhum dos campos referentes ao número da conta seja
            informado, ocorrerá erro na requisição devido à falta de informação
            vital.
          schema:
            type: string
            description: >-
              Número da conta bancária.


              Observações:

              - O número da conta bancária pode ter no máximo 12 caracteres.

              - Para que seja possível localizar a conta, é necessário informar
              o 'número da conta com dígito' (```contaPgto```) ou o 'número da
              conta' (```conta```) e o 'dígito verificador' (```contaDigito```).

              - Caso o 'número da conta com dígito' (```contaPgto```) seja
              informado, não é necessário preencher os campos 'número da conta'
              (```conta```) e 'dígito verificador' (```contaDigito```).

              - Caso nenhum dos campos referentes ao número da conta seja
              informado, ocorrerá erro na requisição devido à falta de
              informação vital.
        - name: ContaDto.ContaDigito
          in: query
          description: >-
            Dígito verificador do número da conta bancária.


            Observações:

            - O dígito verificador do número da conta bancária pode ter no
            máximo 1 caracter.
          schema:
            type: string
            description: >-
              Dígito verificador do número da conta bancária.


              Observações:

              - O dígito verificador do número da conta bancária pode ter no
              máximo 1 caracter.
        - name: ContaDto.ContaPgto
          in: query
          description: >-
            Número da conta bancária seguido do dígito verificador.


            Observações:

            - O número da conta seguido do dígito verificador pode ter no máximo
            20 caracteres.
          schema:
            type: string
            description: >-
              Número da conta bancária seguido do dígito verificador.


              Observações:

              - O número da conta seguido do dígito verificador pode ter no
              máximo 20 caracteres.
        - name: ContaDto.TipoConta
          in: query
          description: |-
            Tipo da conta.*

            Valores:
            1 - Corrente
            2 - Poupanca
            3 - Pagamento
            4 - Salario
          schema:
            allOf:
              - $ref: '#/components/schemas/BMPSPB.Infra.Enums.TipoConta'
            description: |-
              Tipo da conta.*

              Valores:
              1 - Corrente
              2 - Poupanca
              3 - Pagamento
              4 - Salario
        - name: ContaDto.ModeloConta
          in: query
          description: |-
            Modelo da conta.*

            Valores:
            1 - Movimento
            2 - Escrow
            3 - Vinculada
          schema:
            allOf:
              - $ref: '#/components/schemas/BMPSPB.Infra.Enums.ModeloConta'
            description: |-
              Modelo da conta.*

              Valores:
              1 - Movimento
              2 - Escrow
              3 - Vinculada
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/BMPSPB.Domain.Messaging.API.Pix.Chave.Listar.ListarResponse
        '400':
          description: Erro de negócio
          content:
            application/json:
              schema:
                type: object
                properties:
                  sucesso:
                    type: boolean
                  mensagem:
                    type: string
        '500':
          description: Erro interno do servidor
          content:
            application/json:
              schema:
                type: object
                properties:
                  sucesso:
                    type: boolean
                  mensagem:
                    type: string
components:
  schemas:
    BMPSPB.Infra.Enums.TipoConta:
      enum:
        - 1
        - 2
        - 3
        - 4
      type: integer
      description: ''
      format: int32
    BMPSPB.Infra.Enums.ModeloConta:
      enum:
        - 1
        - 2
        - 3
      type: integer
      description: ''
      format: int32
    BMPSPB.Domain.Messaging.API.Pix.Chave.Listar.ListarResponse:
      type: object
      properties:
        sucesso:
          type: boolean
        mensagem:
          type: string
          nullable: true
        chaves:
          type: array
          items:
            $ref: >-
              #/components/schemas/BMPSPB.Domain.Messaging.API.Pix.Chave.Listar.ListarResponseItem
          nullable: true
      additionalProperties: false
    BMPSPB.Domain.Messaging.API.Pix.Chave.Listar.ListarResponseItem:
      type: object
      properties:
        chave:
          type: string
          nullable: true
        tipoChave:
          allOf:
            - $ref: '#/components/schemas/BMPSPB.Infra.Enums.TipoChavePix'
        nomeCorrentista:
          type: string
          nullable: true
        tipoPessoa:
          allOf:
            - $ref: '#/components/schemas/BMPSPB.Infra.Enums.TipoPessoa'
        documentoFederal:
          type: string
          nullable: true
      additionalProperties: false
    BMPSPB.Infra.Enums.TipoChavePix:
      enum:
        - 0
        - 1
        - 2
        - 3
        - 4
      type: integer
      description: ''
      format: int32
    BMPSPB.Infra.Enums.TipoPessoa:
      enum:
        - 1
        - 2
      type: integer
      description: ''
      format: int32
  securitySchemes:
    Bearer:
      type: apiKey
      description: Copie 'Bearer ' + token
      name: Authorization
      in: header

````