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

# Iniciar reivindicação

> Inicia uma nova reivindicação de titularidade ou portabilidade de chave PIX para o participante identificado na rota. Os prazos da reivindicação são de sete dias corridos e a igualdade de ISPB entre reivindicante e doador é rejeitada pela validação de domínio.



## OpenAPI

````yaml pt/openapi/v3-current/spi-dict.yaml post /api/v1/dict/participants/{participantISPB}/claims
openapi: 3.1.0
info:
  contact:
    email: contact@lerian.studio
    name: Lerian Studio
    url: https://lerian.studio
  description: >-
    Interface OpenAPI 3.1 da capacidade DICT (Diretório de Identificadores de
    Contas Transacionais) do Lerian SPI, a integração direta entre a instituição
    e o Sistema de Pagamentos Instantâneos Brasileiro (SPI/Pix). Abrange o ciclo
    de vida das chaves PIX, as reivindicações de portabilidade e titularidade,
    os relatos de infração, as devoluções, os marcadores de fraude, os
    relatórios DICT síncronos e as operações internas de conciliação e
    provisionamento que mantêm o diretório de chaves consistente.
  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 das chaves PIX: registro, listagem, busca, consulta,
      exclusão e estatísticas.
    name: Keys
  - description: >-
      Reivindicações de portabilidade e titularidade de chaves PIX ao longo de
      todo o seu ciclo de vida (iniciar, confirmar, rejeitar, cancelar,
      reconhecer, concluir).
    name: Claims
  - description: 'Relatos de infração DICT: criar, listar e recuperar.'
    name: Infractions
  - description: 'Solicitações de devolução DICT: criar, listar e recuperar.'
    name: Refunds
  - description: 'Marcadores de fraude PIX: criar, listar e estatísticas.'
    name: Fraud Markers
  - description: >-
      Relatórios síncronos sobre o próprio registro DICT do Lerian SPI: resumos
      COUNT(*) de chaves (por tipo/status) e reivindicações (por tipo/status +
      em aberto após o prazo). Somente COUNT — o DICT não retém dinheiro.
    name: Reports
  - description: >-
      Operações internas do DICT: execuções de conciliação, provisionamento do
      ISPB do participante, processamento de prazos de reivindicações e limpeza
      de chaves órfãs.
    name: Internal
paths:
  /api/v1/dict/participants/{participantISPB}/claims:
    post:
      tags:
        - Claims
      summary: Iniciar reivindicação
      description: >-
        Inicia uma nova reivindicação de titularidade ou portabilidade de chave
        PIX para o participante identificado na rota. Os prazos da reivindicação
        são de sete dias corridos e a igualdade de ISPB entre reivindicante e
        doador é rejeitada pela validação de domínio.
      operationId: initiateClaim
      parameters:
        - description: Idempotency key, max 255 characters
          in: header
          name: Idempotency-Key
          schema:
            description: Idempotency key, max 255 characters
            type: string
        - description: Claiming participant ISPB (8 numeric digits)
          in: path
          name: participantISPB
          required: true
          schema:
            description: Claiming participant ISPB (8 numeric digits)
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InitiateClaimRequest'
              description: >-
                PIX key ownership or portability claim to initiate (seven-day
                deadline; claimer and donor ISPB must differ)
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClaimResponse'
                description: Claim record with its current status and deadlines
          description: Created
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
      security:
        - BearerAuth: []
components:
  schemas:
    InitiateClaimRequest:
      additionalProperties: false
      properties:
        claimType:
          description: >-
            Claim kind: OWNERSHIP (dispute the current owner) or PORTABILITY
            (move an existing key to this participant)
          examples:
            - OWNERSHIP
          type: string
        keyType:
          description: 'PIX key type: CPF, CNPJ, EMAIL, PHONE, or EVP'
          examples:
            - CPF
          type: string
        keyValue:
          description: >-
            PIX key value being claimed (format depends on keyType: CPF, CNPJ,
            EMAIL, PHONE, or EVP)
          examples:
            - '12345678901'
          type: string
      required:
        - claimType
        - keyValue
        - keyType
      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
    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
    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

````