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

# Concluir uma reivindicação

> Use este endpoint para concluir uma reivindicação pelo reivindicador.
Como resultado, o vínculo entre a chave e a parte reivindicadora é
criado.


**Notas:**

- Para reivindicação de propriedade, o status deve ser CONFIRMED e o
prazo definido pelo campo CompletionPeriodEnd deve ter transcorrido.

- Para portabilidade, o status deve ser CONFIRMED.

- Esta operação finaliza a transferência da chave e cria a entrada no
DICT.



## OpenAPI

````yaml pt/openapi/v3-current/indirect-pix.yaml POST /v1/dict/claims/{claim_id}/complete
openapi: 3.0.3
info:
  title: Plugin BR Pix Indireto - API Completa
  description: |
    API completa para o sistema brasileiro de pagamentos instantâneos Pix,
    incluindo operações de dicionário de chaves Pix, geração/decodificação de
    QR Code, transações e limites de transações.
  version: 1.0.0
servers:
  - url: https://plugin-pix-indirect.api.lerian.net
security:
  - bearerAuth: []
paths:
  /v1/dict/claims/{claim_id}/complete:
    post:
      tags:
        - Claims API
      summary: Concluir uma reivindicação
      description: |-
        Use este endpoint para concluir uma reivindicação pelo reivindicador.
        Como resultado, o vínculo entre a chave e a parte reivindicadora é
        criado.


        **Notas:**

        - Para reivindicação de propriedade, o status deve ser CONFIRMED e o
        prazo definido pelo campo CompletionPeriodEnd deve ter transcorrido.

        - Para portabilidade, o status deve ser CONFIRMED.

        - Esta operação finaliza a transferência da chave e cria a entrada no
        DICT.
      parameters:
        - $ref: '#/components/parameters/ClaimId'
        - $ref: '#/components/parameters/XAccountId'
        - $ref: '#/components/parameters/XRequestId'
      responses:
        '200':
          description: Reivindicação concluída com sucesso.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClaimObject'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFormat'
              examples:
                ErrorPIX0001:
                  $ref: '#/components/examples/ErrorPIX0001'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFormat'
              examples:
                ErrorPIX0147:
                  $ref: '#/components/examples/ErrorPIX0147'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFormat'
              examples:
                ErrorPIX0113:
                  $ref: '#/components/examples/ErrorPIX0113'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFormat'
              examples:
                ErrorPIX0160:
                  $ref: '#/components/examples/ErrorPIX0160'
                ErrorPIX0161:
                  $ref: '#/components/examples/ErrorPIX0161'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFormat'
              examples:
                ErrorPIX0146:
                  $ref: '#/components/examples/ErrorPIX0146'
                ErrorPIX0148:
                  $ref: '#/components/examples/ErrorPIX0148'
                ErrorPIX0149:
                  $ref: '#/components/examples/ErrorPIX0149'
                ErrorPIX0162:
                  $ref: '#/components/examples/ErrorPIX0162'
                ErrorPIX0163:
                  $ref: '#/components/examples/ErrorPIX0163'
                ErrorPIX0164:
                  $ref: '#/components/examples/ErrorPIX0164'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFormat'
              examples:
                ErrorPIX0000:
                  $ref: '#/components/examples/ErrorPIX0000'
        '502':
          description: Bad Gateway
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFormat'
              examples:
                ErrorPIX1000:
                  $ref: '#/components/examples/ErrorPIX1000'
                ErrorPIX1007:
                  $ref: '#/components/examples/ErrorPIX1007'
                ErrorPIX1099:
                  $ref: '#/components/examples/ErrorPIX1099'
      deprecated: false
      security:
        - bearerAuth: []
components:
  parameters:
    ClaimId:
      name: claim_id
      in: path
      description: Identificador único da reivindicação (formato UUID).
      required: true
      example: 019c96a0-0bc7-7958-9d05-82bef1f200f1
      schema:
        type: string
    XAccountId:
      name: X-Account-Id
      in: header
      description: Identificador único da Conta do Ledger Midaz (formato UUID).
      required: true
      example: 019c96a0-0a98-7287-9a31-786e0809c769
      schema:
        type: string
    XRequestId:
      name: X-Request-Id
      in: header
      description: ID da requisição para idempotência (formato UUID).
      required: false
      example: 019c96a0-0be2-790e-ac41-8d2ad09c1c7f
      schema:
        type: string
  schemas:
    ClaimObject:
      type: object
      properties:
        id:
          type: string
          description: UUID interno da reivindicação.
          example: 019c96a0-0c3e-77b5-8321-4807058a67bb
        bacenClaimId:
          type: string
          description: Identificador DICT do BACEN para esta reivindicação.
          example: 019c96a0-0d16-7184-ad7f-38545eeb671c
        key:
          type: string
          description: O valor da chave Pix que está sendo reivindicada.
          example: '+5561988887777'
        keyType:
          type: string
          description: Tipo de chave Pix.
          example: PHONE
        type:
          type: string
          description: Tipo de reivindicação.
          enum:
            - OWNERSHIP
            - PORTABILITY
          example: OWNERSHIP
        status:
          type: string
          description: Status atual da reivindicação.
          enum:
            - OPEN
            - WAITING_RESOLUTION
            - CONFIRMED
            - CANCELLED
            - COMPLETED
          example: OPEN
        donorParticipant:
          type: string
          description: ISPB do PSP doador.
          example: '30306294'
        resolutionPeriodEnd:
          type: string
          format: date-time
          description: Prazo para resposta do doador (D+7 a partir da criação).
          example: '2024-01-22T10:30:00Z'
        completionPeriodEnd:
          type: string
          format: date-time
          description: Prazo para conclusão da reivindicação (D+14 a partir da criação).
          example: '2024-01-29T10:30:00Z'
        createdAt:
          type: string
          format: date-time
          description: Timestamp de quando a reivindicação foi criada.
          example: '2024-01-15T10:30:00Z'
        updatedAt:
          type: string
          format: date-time
          description: Timestamp da última atualização da reivindicação.
          example: '2024-01-15T10:30:00Z'
    ErrorFormat:
      type: object
      description: A mensagem de erro da resposta.
      required:
        - code
        - title
        - message
      properties:
        code:
          type: string
          description: Um identificador único e estável para o erro.
        title:
          type: string
          description: Um breve resumo do problema.
        message:
          type: string
          description: Orientação detalhada para resolver o erro.
  examples:
    ErrorPIX0001:
      summary: Missing Headers in Request
      value:
        code: PIX-0001
        title: Missing Headers in Request
        message: >-
          Your request is missing one or more required header params. Please
          refer to the documentation to ensure all necessary header params are
          included in your request.
    ErrorPIX0147:
      summary: Must Be Claimer Participant
      value:
        code: PIX-0147
        title: Must Be Claimer Participant
        message: Only the claimer participant can complete a claim.
    ErrorPIX0113:
      summary: Claim Not Found
      value:
        code: PIX-0113
        title: Claim Not Found
        message: The claim was not found.
    ErrorPIX0160:
      summary: Claim Already Completed
      value:
        code: PIX-0160
        title: Claim Already Completed
        message: The claim has already been completed.
    ErrorPIX0161:
      summary: Claim Is Cancelled
      value:
        code: PIX-0161
        title: Claim Is Cancelled
        message: The claim has been cancelled and cannot be completed.
    ErrorPIX0146:
      summary: Claim Not Confirmed
      value:
        code: PIX-0146
        title: Claim Not Confirmed
        message: The claim must be in CONFIRMED status.
    ErrorPIX0148:
      summary: Ownership Completion Period Not Ended
      value:
        code: PIX-0148
        title: Ownership Completion Period Not Ended
        message: >-
          Ownership claims can only be completed after the completion period has
          ended.
    ErrorPIX0149:
      summary: Claim Not Acknowledgeable
      value:
        code: PIX-0149
        title: Claim Not Acknowledgeable
        message: >-
          The claim does not meet acknowledgement preconditions (must be OPEN
          status and caller must be the donor participant).
    ErrorPIX0162:
      summary: Claim Cannot Be Completed
      value:
        code: PIX-0162
        title: Claim Cannot Be Completed
        message: The claim cannot be completed in its current status.
    ErrorPIX0163:
      summary: Completion Period Not Set
      value:
        code: PIX-0163
        title: Completion Period Not Set
        message: The completion period is not set for this claim.
    ErrorPIX0164:
      summary: Completion Period Expired
      value:
        code: PIX-0164
        title: Completion Period Expired
        message: The completion period has expired for this claim.
    ErrorPIX0000:
      summary: Internal Server Error
      value:
        code: PIX-0000
        title: Internal Server Error
        message: The server encountered an unexpected error. Please try again later.
    ErrorPIX1000:
      summary: Provider Connection Error
      value:
        code: PIX-1000
        title: Provider Connection Error
        message: Failed to connect to provider.
    ErrorPIX1007:
      summary: Provider Internal Error
      value:
        code: PIX-1007
        title: Provider Internal Error
        message: Provider returned an internal error.
    ErrorPIX1099:
      summary: Provider Unmapped Error
      value:
        code: PIX-1099
        title: Provider Unmapped Error
        message: Provider returned an unmapped error.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````