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

# Confirm a PIX key claim

> Accepts a claim someone opened on YOUR key: you are the DONOR - the Cliente Doador - agreeing to hand it over (§8.2.10). claimId is in the path; the body carries key and accountId.

Every check is local and runs BEFORE DICT, because the DICT confirmation has no undo and a refusal afterwards would leave the claim confirmed at Bacen while the caller was told the call failed. A claim row with that id must exist; your account must OWN the key named in the body, else 404 PIX-0069; and that key must be the one the claim targets, else 404 PIX-0020. The row must also stand at status 6 - I hold this key and must decide - and any other status, including a CLAIMER's own row at status 5, is 422 PIX-0073 before DICT is called.

DICT is sent motivo 0 (Solicitação do Usuário), the only value §8.2.10 accepts in both donor columns. On success your key row becomes DONATED (3), which is terminal on your side: the state machine has no edge out of it, the key stops being yours, and only the claimer can finish the transfer with POST /v1/claims/{claimId}/conclusion.



## OpenAPI

````yaml /en/openapi/v3-current/pix.yaml post /v1/claims/{claimId}/confirmation
openapi: 3.1.0
info:
  description: Brazilian PIX Direct (DICT + SPI) plugin API.
  title: plugin-br-pix-jd
  version: 1.0.0
servers: []
security:
  - BearerAuth: []
paths:
  /v1/claims/{claimId}/confirmation:
    post:
      tags:
        - Claims
      summary: Confirm a PIX key claim
      description: >-
        Accepts a claim someone opened on YOUR key: you are the DONOR - the
        Cliente Doador - agreeing to hand it over (§8.2.10). claimId is in the
        path; the body carries key and accountId.


        Every check is local and runs BEFORE DICT, because the DICT confirmation
        has no undo and a refusal afterwards would leave the claim confirmed at
        Bacen while the caller was told the call failed. A claim row with that
        id must exist; your account must OWN the key named in the body, else 404
        PIX-0069; and that key must be the one the claim targets, else 404
        PIX-0020. The row must also stand at status 6 - I hold this key and must
        decide - and any other status, including a CLAIMER's own row at status
        5, is 422 PIX-0073 before DICT is called.


        DICT is sent motivo 0 (Solicitação do Usuário), the only value §8.2.10
        accepts in both donor columns. On success your key row becomes DONATED
        (3), which is terminal on your side: the state machine has no edge out
        of it, the key stops being yours, and only the claimer can finish the
        transfer with POST /v1/claims/{claimId}/conclusion.
      operationId: confirmClaim
      parameters:
        - description: The claim id.
          in: path
          name: claimId
          required: true
          schema:
            description: The claim id.
            examples:
              - claim-123
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClaimActionBody'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClaimStatusResponse'
          description: OK
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Unprocessable Entity
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Internal Server Error
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
components:
  schemas:
    ClaimActionBody:
      additionalProperties: false
      properties:
        accountId:
          description: The CRM account id of the caller.
          examples:
            - acc-123
          type: string
        key:
          description: The PIX key the claim targets.
          examples:
            - '11122233300'
          type: string
      required:
        - key
        - accountId
      type: object
    ClaimStatusResponse:
      additionalProperties: false
      properties:
        claimId:
          description: The claim id.
          examples:
            - claim-123
          type: string
        status:
          description: Human-readable eKeyStatus label.
          examples:
            - DONATED
          type: string
      required:
        - claimId
        - status
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Stable, machine-readable domain error code scoped to the emitting
            service (format: <SERVICE>-NNNN).
          examples:
            - ERR-0001
          type: string
        detail:
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
          examples:
            - Property foo is required but is missing.
          type: string
        errors:
          description: Optional list of individual error details
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type:
            - array
            - 'null'
        instance:
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem.
          examples:
            - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: HTTP status code
          examples:
            - 400
          format: int64
          type: integer
        title:
          description: >-
            A short, human-readable summary of the problem type. This value
            should not change between occurrences of the error.
          examples:
            - Bad Request
          type: string
        type:
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          examples:
            - https://example.com/errors/example
          format: uri
          type: string
        upstream:
          $ref: '#/components/schemas/Upstream'
          description: >-
            RFC 9457 extension member: the error a proxied third-party provider
            reported. Absent unless the emitting service explicitly surfaced
            one.
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: >-
            Where the error occurred, e.g. 'body.items[3].tags' or
            'path.thing-id'
          type: string
        message:
          description: Error message text
          type: string
        value:
          description: The value at the given location
      type: object
    Upstream:
      additionalProperties: false
      properties:
        code:
          description: The upstream provider's own error code, verbatim.
          examples:
            - E4001
          type: string
        message:
          description: >-
            The upstream provider's own error message, verbatim (bounded, never
            its raw response body).
          examples:
            - account not found at provider
          type: string
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````