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

# Listar reclamos

> Devuelve una lista paginada de reclamos.



## OpenAPI

````yaml es/openapi/v3-current/spi-dict.yaml get /api/v1/dict/claims
openapi: 3.1.0
info:
  contact:
    email: contact@lerian.studio
    name: Lerian Studio
    url: https://lerian.studio
  description: >-
    Interfaz OpenAPI 3.1 de la capacidad DICT (Diretório de Identificadores de
    Contas Transacionais) de Lerian SPI, la integración directa entre la
    institución y el Sistema de Pagos Instantáneos Brasileño (SPI/Pix). Cubre el
    ciclo de vida de las claves PIX, los reclamos de portabilidad y titularidad,
    los reportes de infracción, las devoluciones, los marcadores de fraude, los
    reportes DICT síncronos y las operaciones internas de conciliación y
    aprovisionamiento que mantienen consistente el directorio de claves.
  license:
    name: Lerian Studio General License
  title: Lerian SPI — DICT API
  version: 1.0.0
servers:
  - url: https://spi.sandbox.lerian.net
security: []
tags:
  - description: >-
      Ciclo de vida de las claves PIX: registro, listado, búsqueda, consulta,
      eliminación y estadísticas.
    name: Keys
  - description: >-
      Reclamos de portabilidad y titularidad de claves PIX a lo largo de todo su
      ciclo de vida (iniciar, confirmar, rechazar, cancelar, reconocer,
      completar).
    name: Claims
  - description: 'Reportes de infracción DICT: crear, listar y recuperar.'
    name: Infractions
  - description: 'Solicitudes de devolución DICT: crear, listar y recuperar.'
    name: Refunds
  - description: 'Marcadores de fraude PIX: crear, listar y estadísticas.'
    name: Fraud Markers
  - description: >-
      Reportes síncronos sobre el propio registro DICT de Lerian SPI: resúmenes
      COUNT(*) de claves (por tipo/estado) y reclamos (por tipo/estado +
      vencidos sin resolver). Solo COUNT — DICT no retiene dinero.
    name: Reports
  - description: >-
      Operaciones internas de DICT: ejecuciones de conciliación,
      aprovisionamiento del ISPB del participante, procesamiento de plazos de
      reclamos y limpieza de claves huérfanas.
    name: Internal
paths:
  /api/v1/dict/claims:
    get:
      tags:
        - Claims
      summary: Listar reclamos
      description: Devuelve una lista paginada de reclamos.
      operationId: listClaims
      parameters:
        - description: Page size (default 25, max 100)
          explode: false
          in: query
          name: limit
          schema:
            default: 25
            description: Page size (default 25, max 100)
            format: int64
            maximum: 100
            minimum: 1
            type: integer
        - description: Page offset (default 0)
          explode: false
          in: query
          name: offset
          schema:
            default: 0
            description: Page offset (default 0)
            format: int64
            minimum: 0
            type: integer
        - description: >-
            Optional facet: restrict to claims whose claimer participant matches
            this ISPB (8 numeric digits).
          explode: false
          in: query
          name: claimerISPB
          schema:
            description: >-
              Optional facet: restrict to claims whose claimer participant
              matches this ISPB (8 numeric digits).
            type: string
        - description: >-
            Optional facet: restrict to claims whose donor participant matches
            this ISPB (8 numeric digits).
          explode: false
          in: query
          name: donorISPB
          schema:
            description: >-
              Optional facet: restrict to claims whose donor participant matches
              this ISPB (8 numeric digits).
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClaimListResponse'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
      security:
        - BearerAuth: []
components:
  schemas:
    ClaimListResponse:
      additionalProperties: false
      properties:
        correlationId:
          description: >-
            Request-scoped correlation identifier echoing X-Request-ID, for
            pivoting from response to trace.
          type: string
        items:
          description: Claim records for the requested limit/offset window.
          items:
            $ref: '#/components/schemas/ClaimResponse'
          type:
            - array
            - 'null'
        limit:
          description: Effective page size applied to this response.
          format: int64
          type: integer
        offset:
          description: Zero-based offset of the first item in this page.
          format: int64
          type: integer
      required:
        - items
        - limit
        - offset
      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
      type: object
    ClaimResponse:
      additionalProperties: false
      properties:
        claimType:
          description: 'Claim kind: OWNERSHIP or PORTABILITY'
          examples:
            - OWNERSHIP
          type: string
        claimerISPB:
          description: ISPB (8 numeric digits) of the participant initiating the claim
          examples:
            - '12345678'
          type: string
        deadline:
          description: Donor-response deadline, seven days after initiation (RFC 3339, UTC)
          examples:
            - '2025-03-14T14:30:00Z'
          type: string
        donorISPB:
          description: >-
            ISPB (8 numeric digits) of the current key owner (donor), resolved
            during initiation
          examples:
            - '87654321'
          type: string
        id:
          description: Server-assigned claim UUID
          examples:
            - 550e8400-e29b-41d4-a716-446655440000
          type: string
        keyType:
          description: 'PIX key type: CPF, CNPJ, EMAIL, PHONE, or EVP'
          examples:
            - CPF
          type: string
        keyValue:
          description: PIX key value under claim
          examples:
            - '12345678901'
          type: string
        requestedAt:
          description: Claim initiation timestamp (RFC 3339, UTC)
          examples:
            - '2025-03-07T14:30:00Z'
          type: string
        resolution:
          description: >-
            Terminal resolution reason (e.g. DONOR_CONFIRMED,
            CANCELLED_BY_CLAIMER, CANCELLED_BY_CLAIMER_FRAUD,
            CANCELLED_BY_DONOR, CANCELLED_BY_DONOR_FRAUD, DEADLINE_EXPIRED);
            empty until the claim resolves
          examples:
            - ''
          type: string
        resolvedAt:
          description: >-
            Resolution timestamp (RFC 3339, UTC); omitted while the claim is
            unresolved
          examples:
            - ''
          type: string
        status:
          description: >-
            Claim lifecycle state: OPEN, WAITING_RESOLUTION, CONFIRMED,
            CANCELLED, or COMPLETED
          examples:
            - OPEN
          type: string
      required:
        - id
        - claimType
        - keyValue
        - keyType
        - claimerISPB
        - donorISPB
        - status
        - requestedAt
        - deadline
      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
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````