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

# Get a PIX key claim

> Reads one claim live from DICT (§8.2.15 Consultar Reivindicação). Nothing local is consulted: account_id exists only to validate the caller and to produce the ISPB §8.2.15 requires, and the plugin's own key row is deliberately ignored because it is absent for a claim this plugin never opened and gone once the row is soft-deleted.

So this route serves the same universe as the default GET /v1/claims: any claim DICT associates with the caller's ISPB, including one opened by another account of the same institution. Note what the response does NOT carry - only claimId, key and ispb are serialized. DICT's situation and which side of the claim you are on are read and then dropped, so this route cannot tell you whether a claim is open, confirmed or cancelled; read state from GET /v1/claims?status=processing or GET /v1/entries instead. A claimId DICT does not know is 404 PIX-0020, and DICT being unavailable is 503 PIX-1050.



## OpenAPI

````yaml /en/openapi/v3-current/pix.yaml get /v1/claims/{claimId}
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}:
    get:
      tags:
        - Claims
      summary: Get a PIX key claim
      description: >-
        Reads one claim live from DICT (§8.2.15 Consultar Reivindicação).
        Nothing local is consulted: account_id exists only to validate the
        caller and to produce the ISPB §8.2.15 requires, and the plugin's own
        key row is deliberately ignored because it is absent for a claim this
        plugin never opened and gone once the row is soft-deleted.


        So this route serves the same universe as the default GET /v1/claims:
        any claim DICT associates with the caller's ISPB, including one opened
        by another account of the same institution. Note what the response does
        NOT carry - only claimId, key and ispb are serialized. DICT's situation
        and which side of the claim you are on are read and then dropped, so
        this route cannot tell you whether a claim is open, confirmed or
        cancelled; read state from GET /v1/claims?status=processing or GET
        /v1/entries instead. A claimId DICT does not know is 404 PIX-0020, and
        DICT being unavailable is 503 PIX-1050.
      operationId: getClaim
      parameters:
        - description: The claim id.
          in: path
          name: claimId
          required: true
          schema:
            description: The claim id.
            examples:
              - claim-123
            type: string
        - description: The CRM account id of the caller.
          explode: false
          in: query
          name: account_id
          required: true
          schema:
            description: The CRM account id of the caller.
            examples:
              - acc-123
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClaimResultResponse'
          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:
    ClaimResultResponse:
      additionalProperties: false
      properties:
        claimId:
          description: The claim id.
          examples:
            - claim-123
          type: string
        ispb:
          description: The claim requester ISPB.
          examples:
            - '12345678'
          type: string
        key:
          description: The claimed PIX key.
          examples:
            - '11122233300'
          type: string
      required:
        - claimId
        - key
        - ispb
      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

````