> ## 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. # Register the direct participant this rail operates as > Establishes the institution this rail IS at the SPI: the ACTIVE DIRECT participant that anchors the closed set of participants whose arriving Pix settle here (its own accounts, plus every indirect it is BACEN-confirmed liquidante for). Admin-only, and at most one may be ACTIVE. There is no reda flow for a direct participant — the SPI refuses a reda.014/reda.031 naming one (reda.016 error DIR1) — so nothing external confirms this act and it is not client-callable. ## OpenAPI ````yaml /pt/openapi/v3-current/spi-core.yaml post /api/v1/core/participants/direct openapi: 3.1.0 info: contact: email: contact@lerian.studio name: Lerian Studio url: https://lerian.studio description: >- Core service of Lerian SPI: PIX participant lifecycle by ISPB, payment routing resolution, and cross-context Core operation orchestration over the Brazilian Instant Payment System (SPI/Pix). license: name: Lerian Studio General License title: Lerian SPI — Core API version: 1.0.0 servers: - url: https://spi.sandbox.lerian.net security: [] tags: - description: >- PIX participant lifecycle: register, list, retrieve, suspend, activate, and offboard by ISPB. name: Participants - description: Payment routing resolution across participants. name: Routing - description: Core operation orchestration across the rail's bounded contexts. name: Operations paths: /api/v1/core/participants/direct: post: tags: - Participants summary: Register the direct participant this rail operates as description: >- Establishes the institution this rail IS at the SPI: the ACTIVE DIRECT participant that anchors the closed set of participants whose arriving Pix settle here (its own accounts, plus every indirect it is BACEN-confirmed liquidante for). Admin-only, and at most one may be ACTIVE. There is no reda flow for a direct participant — the SPI refuses a reda.014/reda.031 naming one (reda.016 error DIR1) — so nothing external confirms this act and it is not client-callable. operationId: registerDirectParticipant parameters: - description: Idempotency key, max 255 characters in: header name: X-Idempotency required: true schema: description: Idempotency key, max 255 characters type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/RegisterDirectParticipantRequest' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/ParticipantResponse' description: Created '404': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Not Found '409': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Conflict '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 security: - BearerAuth: [] components: schemas: RegisterDirectParticipantRequest: additionalProperties: false properties: contactEmail: description: >- Lower-case e-mail BACEN uses to reach this participant about a funds-recovery case (DICT 2.12.1 Email pattern). The address must be lower-case: an upper-case one is refused, never rewritten. The service checks the format, not the published schema, so a refusal never echoes the submitted value back. examples: - med@bancoexemplo.com.br type: string contactPhone: description: >- E.164 phone BACEN uses to reach this participant about a funds-recovery case (DICT 2.12.1 Phone pattern: +, then 2 to 15 digits). The service checks the format, not the published schema, so a refusal never echoes the submitted value back. examples: - '+5511999998888' type: string ispb: description: >- ISPB of the institution this rail operates as, exactly 8 numeric digits. examples: - '12345678' pattern: ^[0-9]{8}$ type: string name: description: >- Legal name of the institution. The 256-character bound is Lerian's own — it is what participants.name stores — not a BACEN limit. examples: - Banco Exemplo S.A. maxLength: 256 minLength: 1 type: string required: - ispb - name - contactEmail - contactPhone type: object ParticipantResponse: additionalProperties: false properties: config: $ref: '#/components/schemas/ParticipantConfigDTO' description: >- Quota and routing configuration; present only for indirect participants. contactEmail: description: >- Registered regulator-facing e-mail; travels on every MED 2.0 funds recovery opened for this participant. examples: - med@bancoexemplo.com.br type: string contactPhone: description: >- Registered regulator-facing phone; travels on every MED 2.0 funds recovery opened for this participant. examples: - '+5511999998888' type: string createdAt: description: UTC timestamp when the participant was created, RFC 3339 format. examples: - '2025-03-07T14:30:00Z' type: string id: description: Server-assigned UUID of the participant. examples: - 550e8400-e29b-41d4-a716-446655440000 type: string ispb: description: ISPB of the participant, exactly 8 numeric digits. examples: - '12345678' type: string name: description: Legal name of the participant institution. examples: - Banco Exemplo S.A. type: string sponsorISPB: description: >- ISPB of the sponsoring participant (8 numeric digits); present only for INDIRECT participants. examples: - '' type: string status: description: >- Lifecycle state of the participant: ACTIVE, SUSPENDED, OFFBOARDED, PENDING (indirect reda.014 in flight), REGISTRATION_REJECTED (reda.016 REJT), or OFFBOARD_PENDING (reda.031 in flight). examples: - ACTIVE type: string type: description: >- Connection type: DIRECT (connects directly to BACEN) or INDIRECT (routes through a sponsor). examples: - DIRECT type: string updatedAt: description: >- UTC timestamp of the last update to the participant, RFC 3339 format. examples: - '2025-03-07T14:30:00Z' type: string required: - id - ispb - name - type - status - contactEmail - contactPhone - createdAt - updatedAt type: object Detail: additionalProperties: false properties: code: description: >- Stable, machine-readable domain error code scoped to the emitting service (format: -NNNN). type: string correlationId: description: Request-scoped correlation identifier echoing X-Request-ID. examples: - req-7a3f9c2e 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. required: - correlationId type: object ParticipantConfigDTO: additionalProperties: false properties: quotaDailyLimit: description: Maximum total routed amount per day in centavos (BRL minor units). examples: - 1000000 format: int64 type: integer quotaTransactionLimit: description: Maximum amount per single transaction in centavos (BRL minor units). examples: - 50000 format: int64 type: integer routingPolicy: description: >- Payment routing policy for the indirect participant; currently only DEFAULT (route through sponsor with quota enforcement) is accepted. examples: - DEFAULT type: string required: - quotaDailyLimit - quotaTransactionLimit - routingPolicy 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 ````