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

# Provision participant ISPB

> Provisions (idempotent upsert) the participant ISPB used as the authoritative inventory for FULL DICT reconciliation.



## OpenAPI

````yaml en/openapi/v3-current/spi-dict.yaml put /api/v1/dict/internal/participant-settings
openapi: 3.1.0
info:
  contact:
    email: contact@lerian.studio
    name: Lerian Studio
    url: https://lerian.studio
  description: >-
    OpenAPI 3.1 surface for the DICT (Diretório de Identificadores de Contas
    Transacionais) capability of Lerian SPI, the direct integration between the
    institution and the Brazilian Instant Payment System (SPI/Pix). It covers
    the PIX key lifecycle, portability and ownership claims, infraction reports,
    refunds, fraud markers, synchronous DICT reports, and the internal
    reconciliation and provisioning operations that keep the key directory
    consistent.
  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: 'PIX key lifecycle: register, list, search, lookup, delete, and statistics.'
    name: Keys
  - description: >-
      PIX key portability and ownership claims through their full lifecycle
      (initiate, confirm, reject, cancel, acknowledge, complete).
    name: Claims
  - description: 'DICT infraction reports: create, list, and retrieve.'
    name: Infractions
  - description: 'DICT refund requests: create, list, and retrieve.'
    name: Refunds
  - description: 'PIX fraud markers: create, list, and statistics.'
    name: Fraud Markers
  - description: >-
      Synchronous reports over Lerian SPI's own DICT record: COUNT(*) summaries
      of keys (by type/status) and claims (by type/status + open-past-deadline).
      COUNT-only — DICT holds no money.
    name: Reports
  - description: >-
      Internal DICT operations: reconciliation runs, participant ISPB
      provisioning, claim deadline processing, and orphaned-key cleanup.
    name: Internal
paths:
  /api/v1/dict/internal/participant-settings:
    put:
      tags:
        - Internal
      summary: Provision participant ISPB
      description: >-
        Provisions (idempotent upsert) the participant ISPB used as the
        authoritative inventory for FULL DICT reconciliation.
      operationId: upsertParticipantSettings
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpsertParticipantSettingsRequest'
              description: >-
                Participant ISPB to provision as the authoritative inventory for
                FULL DICT reconciliation (idempotent upsert)
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ParticipantSettingsResponse'
                description: >-
                  Provisioned participant settings, including the ISPB and
                  last-updated timestamp (RFC 3339)
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
      security:
        - BearerAuth: []
components:
  schemas:
    UpsertParticipantSettingsRequest:
      additionalProperties: false
      properties:
        participantIspb:
          description: >-
            FI participant ISPB to provision, the 8-digit BACEN institution
            identifier (exactly 8 digits).
          examples:
            - '12345678'
          type: string
      required:
        - participantIspb
      type: object
    ParticipantSettingsResponse:
      additionalProperties: false
      properties:
        participantIspb:
          description: >-
            Provisioned FI participant ISPB, the 8-digit BACEN institution
            identifier.
          examples:
            - '12345678'
          type: string
        updatedAt:
          description: >-
            Timestamp the participant settings were last provisioned, RFC 3339
            (UTC).
          examples:
            - '2026-06-14T12:00:00Z'
          type: string
      required:
        - participantIspb
        - updatedAt
      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

````