> ## 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 participant's operational status

> The current PAG0101 operational status and its history.



## OpenAPI

````yaml /pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/participants/{participantId}/status
openapi: 3.1.0
info:
  description: >-
    OpenAPI 3.1 surface for Lerian SILOC, the participant-side rail connecting
    the institution to Núclea's SILOC deferred-net interbank settlement.
  title: Lerian SILOC API
  version: 1.0.0
servers:
  - url: https://api.example.com
    description: >-
      Replace the example host with the URL provided during environment
      onboarding.
security: []
paths:
  /api/v1/siloc/participants/{participantId}/status:
    get:
      tags:
        - Participants
      summary: Get a participant's operational status
      description: The current PAG0101 operational status and its history.
      operationId: getParticipantStatus
      parameters:
        - description: Participant id.
          in: path
          name: participantId
          required: true
          schema:
            description: Participant id.
            format: uuid
            type: string
        - description: CodProdt to answer for (e.g. OT).
          explode: false
          in: query
          name: product
          required: true
          schema:
            description: CodProdt to answer for (e.g. OT).
            examples:
              - OT
            maxLength: 3
            minLength: 1
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ParticipantStatusResponse'
          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
      security:
        - BearerAuth: []
components:
  schemas:
    ParticipantStatusResponse:
      additionalProperties: false
      properties:
        current:
          $ref: '#/components/schemas/ParticipantStatusEventResponse'
          description: >-
            The current operational status. ABSENT when no PAG0101 has named
            this institution for this product — an institution the câmara has
            not spoken about has no operating situation, and reporting a
            defaulted one would claim a notice said something it did not.
        history:
          description: The status history, newest first (never null).
          items:
            $ref: '#/components/schemas/ParticipantStatusEventResponse'
          type: array
        participantId:
          description: Participant id.
          format: uuid
          type: string
        product:
          description: The product this answer is about.
          examples:
            - OT
          type: string
      required:
        - participantId
        - product
        - history
      type: object
    Detail:
      additionalProperties: true
      properties:
        code:
          description: >-
            Stable, machine-readable domain error code scoped to the emitting
            service (format: <SERVICE>-NNNN).
          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
    ParticipantStatusEventResponse:
      additionalProperties: false
      properties:
        effectiveAt:
          description: When the status took effect.
          format: date-time
          type: string
        product:
          description: CodProdt the notice asserted the situation for.
          examples:
            - OT
          type: string
        source:
          description: Origin of the status change (e.g. PAG0101 message reference).
          type: string
        status:
          description: >-
            PAG0101 operational status (SitOperacIFCamr), verbatim. EMPTY when
            the notice carried an empty status, which the official type admits
            (minimum length 0); an empty entry is history only and is never the
            current status.
          enum:
            - ''
            - '1'
            - '2'
            - '3'
            - '6'
            - '7'
            - '8'
            - '9'
          type: string
      required:
        - product
        - status
        - effectiveAt
      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

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.