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

# Read the outcome of an IF Domicílio connectivity test

> Reads the AGEN001 test the POST accepted: PENDING until Núclea's AGEN001RET (ANSWERED, with the echoed MsgECO and the time it was read) or an ERR (REFUSED, with its CodErro) is read from the file channel, and NO_ANSWER once no answer came within the bound (the file-transfer node's retry window of 9.5 minutes, OP106 v11 §6.3.4, plus one schedule tick; a late answer still turns the test into ANSWERED). 404 for an unknown test id. RBAC: connectivity:test (admin).



## OpenAPI

````yaml /en/openapi/v3-current/slc.yaml get /v1/participants/{participantIspb}/test-connectivity/{testId}
openapi: 3.1.0
info:
  description: >-
    API for Lerian SLC — the participant-side rail that connects the institution
    to Núclea's SLC card settlement.
  title: Lerian SLC API
  version: 1.0.0
servers:
  - url: https://api.example.com
    description: >-
      Replace the example host with the URL provided during environment
      onboarding.
security:
  - BearerAuth: []
tags:
  - description: >-
      Settlement operation lifecycle — create, list, query, and control the
      NUliquid-tracked card operations (NUliquid = the 21-position id Núclea
      assigns each accepted operation) through the state machine.
    name: Operations
  - description: >-
      Participant catalog — the acquirers, sub-acquirers, IF Domicílio (bank
      where the merchant receives its sales), and settlement FIs (financial
      institutions) that take part in card settlement.
    name: Participants
  - description: >-
      Card arrangements (bandeira/scheme configurations, e.g. Visa/Master/Elo)
      attached to a participant.
    name: Arrangements
  - description: >-
      Regulated transport orchestration to Núclea's SLC — dispatch, recovery,
      retransmission, and connectivity testing over managed file-transfer,
      message-broker, and REST.
    name: Connectivity
  - description: >-
      Multilateral netting clearing positions — the net amount each participant
      settles per STR cycle (STR = Banco Central reserves-transfer system).
    name: Clearing
  - description: >-
      SaaS BYOK (Bring Your Own Key) signing-key provisioning — import
      parameters and register the client's ICP-Brasil server-type certificate
      material used to sign ASLC files (RSA, at least 2048 bits, and valid at
      the moment of import — all three are enforced); the SLC never receives the
      private key in cleartext.
    name: SigningKey
  - description: >-
      ASLC file intake and status — passthrough submission and processing status
      of the official Núclea card-settlement XML files (ASLC = Arquivo do
      Sistema de Liquidação de Cartões).
    name: Files
  - description: >-
      Read-only introspection of the embedded Núclea ASLC/RSFN (National
      Financial System Network) XSD schemas used to validate outbound and
      inbound messages.
    name: XSD Schemas
  - description: Read-only regulatory, compliance, and operational settlement reports.
    name: Reports
  - description: >-
      Outbound business-event webhook subscriptions and delivery management for
      consumers (client ledgers — optional).
    name: Webhooks
  - description: Administrative operations — dead-letter-queue inspection/replay.
    name: Admin
  - description: >-
      LBTR (gross real-time settlement) commands and reads — position requests,
      confirmation or divergence of announced settlement results, and
      receivables-anticipation transfers exchanged with the câmara.
    name: LBTR
  - description: >-
      Card settlement funding — the settlement instructions to be funded in STR
      and the declaration of each deposit's confirmation.
    name: Funding
  - description: >-
      IF Domicílio (the bank where the merchant receives its sales) view — the
      settlements Núclea notified it of and its confirmation or refusal of them.
    name: Domicile
  - description: >-
      Read-only introspection of the settlement time grid (the windows in which
      each message type may be sent).
    name: Schedule
paths:
  /v1/participants/{participantIspb}/test-connectivity/{testId}:
    get:
      tags:
        - Connectivity
      summary: Read the outcome of an IF Domicílio connectivity test
      description: >-
        Reads the AGEN001 test the POST accepted: PENDING until Núclea's
        AGEN001RET (ANSWERED, with the echoed MsgECO and the time it was read)
        or an ERR (REFUSED, with its CodErro) is read from the file channel, and
        NO_ANSWER once no answer came within the bound (the file-transfer node's
        retry window of 9.5 minutes, OP106 v11 §6.3.4, plus one schedule tick; a
        late answer still turns the test into ANSWERED). 404 for an unknown test
        id. RBAC: connectivity:test (admin).
      operationId: getConnectivityTest
      parameters:
        - description: Participant ISPB (8 characters, digits or uppercase letters).
          in: path
          name: participantIspb
          required: true
          schema:
            description: Participant ISPB (8 characters, digits or uppercase letters).
            examples:
              - '12345678'
            type: string
        - description: Test id the POST returned.
          in: path
          name: testId
          required: true
          schema:
            description: Test id the POST returned.
            examples:
              - 0f8fad5b-d9cb-469f-a165-70867728950e
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectivityTestResult'
          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
        '501':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: >-
            Not Implemented: this capability is not part of this deployment.
            Operations are registered unconditionally so the published contract
            is identical across deploy shapes; when the capability behind one
            did not compose here (authentication disabled, no database, no
            outbound transport, or the feature switched off) it answers this
            coded SLC-0012 problem. It is definitive for this deployment:
            retrying does not help, and the `detail` is deliberately scrubbed
            (any status >= 500 is).
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
components:
  schemas:
    ConnectivityTestResult:
      additionalProperties: false
      properties:
        answeredAt:
          description: >-
            When the answer was read (RFC3339 UTC); present once answered or
            refused.
          examples:
            - '2026-05-28T10:00:20Z'
          type: string
        echoMatches:
          description: >-
            Whether the answer echoed the token that was sent; present once
            answered.
          examples:
            - true
          type: boolean
        echoedMsgEco:
          description: Echo token the AGEN001RET carried; present once answered.
          examples:
            - SLC-ECO-0f8fad5bd9cb469fa16570867728950e
          type: string
        errorCode:
          description: CodErro of the ERR; present when refused.
          examples:
            - ESLC0118
          type: string
        latencyMs:
          description: >-
            Milliseconds from send to the answer being read; present once
            answered.
          examples:
            - 20000
          format: int64
          type: integer
        msgEco:
          description: Echo token sent in the AGEN001.
          examples:
            - SLC-ECO-0f8fad5bd9cb469fa16570867728950e
          type: string
        participantId:
          description: Participant id (8-character ISPB).
          examples:
            - '12345678'
          type: string
        sentAt:
          description: When the AGEN001 was sent (RFC3339 UTC).
          examples:
            - '2026-05-28T10:00:00Z'
          type: string
        status:
          description: >-
            PENDING: sent, no answer yet. ANSWERED: Núclea returned the
            AGEN001RET. REFUSED: Núclea answered with an ERR. NO_ANSWER: no RET
            or ERR within the answer bound.
          enum:
            - PENDING
            - ANSWERED
            - REFUSED
            - NO_ANSWER
          examples:
            - ANSWERED
          type: string
        testId:
          description: Test id returned by the POST.
          examples:
            - 0f8fad5b-d9cb-469f-a165-70867728950e
          type: string
      required:
        - testId
        - participantId
        - status
        - msgEco
        - sentAt
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Stable, machine-readable domain error code scoped to the emitting
            service (format: <SERVICE>-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
    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.