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

# STR participant list (COMPE ↔ ISPB resolution)

> STR participant list. Use it to resolve the COMPE code (3 digits, the "bank number" that the customer knows) to the ISPB (8 digits) that identifies the institution in the SPB, and the reverse.

Use `compe=` or `ispb=` for an exact search, and `name=` for a search by name prefix (not case-sensitive). When you send a TED, you can give `bankCode` (COMPE) directly. The service does the same resolution, and a bank that is not in this list returns 422 `TED-0006`. The list is sorted by ISPB, with cursor pagination; this list only moves forward.



## OpenAPI

````yaml /pt/openapi/v3-current/ted-lerian.yaml get /v1/participants
openapi: 3.1.0
info:
  description: >-
    API of **TED Lerian**, the interface over Lerian SPB. Your institution uses
    it to send TEDs, make internal transfers, track incoming TEDs, and operate
    returns, queues, and policy on its Midaz ledger. The [API
    overview](/pt/reference/interfaces/ted-lerian/ted-lerian-api-overview) gives
    the concepts, the roles, and the conventions.
  title: TED Lerian API
  version: v1.0.0
servers:
  - url: https://api.example.com
    description: >-
      Replace the example host with the URL provided during environment
      onboarding.
security:
  - BearerAuth: []
tags:
  - description: >-
      Outgoing TEDs and internal transfers: fee quote, creation, query,
      timeline, and cancellation. Every integration starts here.
    name: Transfers
  - description: >-
      Incoming TEDs from other institutions: query, timeline, and operator
      actions (full return and manual review resolution).
    name: Incoming Transfers
  - description: >-
      STR participant list, to resolve COMPE code ↔ ISPB and validate the
      destination bank before you create a transfer.
    name: Participants
  - description: >-
      Back office: operations queue, inconsistency findings between the ledger
      and the STR, reviews of rail facts, held returns, and manual unblock with
      evidence.
    name: Reconciliation
  - description: >-
      Operations dashboard: daily aggregates, regulatory deadlines (30/60/60
      min), and the closing balance that the STR reported.
    name: Operations
  - description: >-
      Institution configuration (editor): operating window and cut-off, usage
      limits, holiday calendar, and ISPB → organization bindings.
    name: Policy
paths:
  /v1/participants:
    get:
      tags:
        - Participants
      summary: STR participant list (COMPE ↔ ISPB resolution)
      description: >-
        STR participant list. Use it to resolve the COMPE code (3 digits, the
        "bank number" that the customer knows) to the ISPB (8 digits) that
        identifies the institution in the SPB, and the reverse.


        Use `compe=` or `ispb=` for an exact search, and `name=` for a search by
        name prefix (not case-sensitive). When you send a TED, you can give
        `bankCode` (COMPE) directly. The service does the same resolution, and a
        bank that is not in this list returns 422 `TED-0006`. The list is sorted
        by ISPB, with cursor pagination; this list only moves forward.
      operationId: listStrParticipants
      parameters:
        - description: Maximum items per page
          explode: false
          in: query
          name: limit
          schema:
            default: 20
            description: Maximum items per page
            format: int64
            maximum: 100
            minimum: 1
            type: integer
        - description: Opaque cursor returned in next_cursor
          explode: false
          in: query
          name: cursor
          schema:
            description: Opaque cursor returned in next_cursor
            maxLength: 512
            type: string
        - description: COMPE code (3 digits)
          explode: false
          in: query
          name: compe
          schema:
            description: COMPE code (3 digits)
            pattern: ^[0-9]{3}$
            type: string
        - description: ISPB (8 digits)
          explode: false
          in: query
          name: ispb
          schema:
            description: ISPB (8 digits)
            pattern: ^[0-9]{8}$
            type: string
        - description: Search by name (prefix, case-insensitive)
          explode: false
          in: query
          name: name
          schema:
            description: Search by name (prefix, case-insensitive)
            maxLength: 100
            type: string
        - $ref: '#/components/parameters/XRequestId'
      responses:
        '200':
          content:
            application/json:
              example:
                items:
                  - accessType: RSFN
                    compe: '001'
                    ispb: '00000000'
                    name: BANCO DO BRASIL S.A.
                    updatedAt: '2026-10-01T03:00:00Z'
                limit: 20
                next_cursor: null
                prev_cursor: null
              schema:
                $ref: '#/components/schemas/ParticipantPage'
          description: Page of STR participants.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/XRequestId'
        '400':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: >-
            Invalid query parameter: cursor, date range, status, or filter in
            the wrong format (`TED-0001`).
          headers:
            X-Request-Id:
              $ref: '#/components/headers/XRequestId'
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: 'Not authenticated: token missing, invalid, or expired (`TED-0070`).'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/XRequestId'
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: >-
            No permission: the token's role does not authorize this action, or
            the product license is not valid for the organization (`TED-0071`).
          headers:
            X-Request-Id:
              $ref: '#/components/headers/XRequestId'
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: >-
            Parameter outside the declared format (for example, a `date` that is
            not YYYY-MM-DD): framework validation, with no TED code.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/XRequestId'
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: >-
            Unexpected failure (`TED-9000`). If it continues, contact support
            and give the `X-Request-Id` of the response.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/XRequestId'
components:
  parameters:
    XRequestId:
      description: >-
        Correlation identifier of this request (UUID). Optional: when you omit
        it, or when the value is not a well-formed UUID, the platform creates a
        UUID and returns it in the X-Request-Id header of the response. The
        resolved identifier goes to the logs, spans, and audit events of this
        request. Keep it to open a support ticket.
      in: header
      name: X-Request-Id
      schema:
        format: uuid
        type: string
  schemas:
    ParticipantPage:
      additionalProperties: false
      description: Page of STR participants with cursor pagination.
      properties:
        items:
          description: Participants on the page.
          items:
            $ref: '#/components/schemas/Participant'
          type: array
        limit:
          description: Actual page size, already limited to the contract maximum.
          format: int64
          type: integer
        next_cursor:
          description: Token of the next page; null when there is none.
          type:
            - string
            - 'null'
        prev_cursor:
          description: 'Always null: the list only moves forward.'
          type:
            - string
            - 'null'
      required:
        - items
        - limit
      type: object
    Detail:
      additionalProperties: true
      description: >-
        Standard error body (RFC 9457, `application/problem+json`) for every
        `/v1` operation. Use `code` (TED-NNNN) to handle the error in code,
        `detail` for the readable message, and `errors` for the invalid fields
        of a 422. The `X-Request-Id` of the response identifies the occurrence
        for support.
      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
    Participant:
      additionalProperties: false
      description: >-
        Institution that participates in the STR, with its ISPB, COMPE code, and
        access type.
      properties:
        accessType:
          description: Method of access to the STR
          enum:
            - RSFN
            - INTERNET
            - UNKNOWN
          type: string
        compe:
          description: COMPE code of the bank (3 digits)
          examples:
            - '001'
          pattern: ^[0-9]{3}$
          type: string
        ispb:
          description: Identifier of the participant in the SPB (8 digits)
          examples:
            - '00000000'
          pattern: ^[0-9]{8}$
          type: string
        name:
          description: Name of the institution.
          type: string
        updatedAt:
          description: Last update of the record (UTC).
          format: date-time
          type: string
      required:
        - ispb
        - name
      type: object
    ErrorDetail:
      additionalProperties: false
      description: >-
        An invalid field inside a validation error: where it is (`location`),
        what is wrong (`message`), and the value received.
      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
      description: >-
        Error reported by an upstream system (ledger or rail), when the service
        chooses to expose it. Absent in most errors.
      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
  headers:
    XRequestId:
      description: >-
        Echo of the request X-Request-Id: the value that the client sent, or the
        UUID that the platform generated when the client sent none. Present in
        every response, success or error.
      schema:
        format: uuid
        type: string
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: >-
        JWT token that the Lerian Access Manager issues for your institution.
        Send it in `Authorization: Bearer <token>` on every call (except the
        public health probes). The tenant never comes from the body, the query,
        or the path. Each operation requires a role with the matching permission
        (see the API overview). Without it, 403 `TED-0071`. Missing, invalid, or
        expired token: 401 `TED-0070`.
      scheme: bearer
      type: http

````

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