> ## 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.

# 23 - Consultar Reivindicação de Chave

> <p>Scopes:</p>
<b>api.pix api.reivindicacao.consultareivindicacao</b>

Por meio deste endpoint, o parceiro pode consultar uma reivindicação de chave Pix e verificar em que status se encontra a solicitação.

<Expandable title="Mensagens de requisições com erro">
  O retorno de uma requisição com status HTTP 400 (Bad Request) pode incluir as seguintes mensagens de erro:

  | Endpoint                                                          | Mensagem de erro |
  | ----------------------------------------------------------------- | ---------------- |
  | /api/Reivindicacao/Consultar	Nenhuma reivindicação foi encontrada |                  |
</Expandable>


## OpenAPI

````yaml get /api/Reivindicacao/Consultar
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/Reivindicacao/Consultar:
    get:
      tags:
        - Reivindicacao
      summary: Consulta uma Reivindacação de Chave PIX.
      description: "<p>Scopes:</p>\r\n<b>api.pix api.reivindicacao.consultareivindicacao</b>"
      parameters:
        - name: CodigoReivindicacao
          in: query
          description: Identificador UUID da reivindicação à ser consultada.*
          schema:
            type: string
            description: Identificador UUID da reivindicação à ser consultada.*
            format: uuid
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/BMPSPB.Domain.Messaging.API.Pix.Reivindicacao.ConsultarReivindicacaoResponse
        '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.Domain.Messaging.API.Pix.Reivindicacao.ConsultarReivindicacaoResponse:
      type: object
      properties:
        sucesso:
          type: boolean
        mensagem:
          type: string
          nullable: true
        chave:
          type: string
          nullable: true
        tipoChave:
          allOf:
            - $ref: '#/components/schemas/BMPSPB.Infra.Enums.TipoChavePix'
        statusReivindicacao:
          allOf:
            - $ref: '#/components/schemas/BMPSPB.Infra.Enums.StatusReivindicacao'
          nullable: true
        tipoReivindicacao:
          allOf:
            - $ref: '#/components/schemas/BMPSPB.Infra.Enums.TipoReivindicacao'
          nullable: true
        idReivindicacao:
          type: string
          format: uuid
          nullable: true
        dtInclusao:
          type: string
          format: date-time
        prazoResolucao:
          type: string
          format: date-time
          nullable: true
        prazoConclusao:
          type: string
          format: date-time
          nullable: true
        motivoConfirmacao:
          allOf:
            - $ref: '#/components/schemas/BMPSPB.Infra.Enums.MotivoConfirmacao'
          nullable: true
        motivoCancelamento:
          allOf:
            - $ref: '#/components/schemas/BMPSPB.Infra.Enums.MotivoCancelamento'
          nullable: true
        solicitanteCancelamento:
          allOf:
            - $ref: '#/components/schemas/BMPSPB.Infra.Enums.SolicitanteCancelamento'
          nullable: true
      additionalProperties: false
    BMPSPB.Infra.Enums.TipoChavePix:
      enum:
        - 0
        - 1
        - 2
        - 3
        - 4
      type: integer
      description: ''
      format: int32
    BMPSPB.Infra.Enums.StatusReivindicacao:
      enum:
        - 0
        - 1
        - 2
        - 3
        - 4
        - 5
      type: integer
      description: ''
      format: int32
    BMPSPB.Infra.Enums.TipoReivindicacao:
      enum:
        - 1
        - 2
      type: integer
      description: ''
      format: int32
    BMPSPB.Infra.Enums.MotivoConfirmacao:
      enum:
        - 0
        - 1
        - 2
        - 3
        - 4
      type: integer
      description: ''
      format: int32
    BMPSPB.Infra.Enums.MotivoCancelamento:
      enum:
        - 0
        - 1
        - 2
        - 3
        - 4
      type: integer
      description: ''
      format: int32
    BMPSPB.Infra.Enums.SolicitanteCancelamento:
      enum:
        - 0
        - 1
      type: integer
      description: ''
      format: int32
  securitySchemes:
    Bearer:
      type: apiKey
      description: Copie 'Bearer ' + token
      name: Authorization
      in: header

````