> ## 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 a credential

> Returns the credential metadata for the supplied id.
The encrypted password is never returned. Emits
credential.accessed via audit_outbox on every successful
read.



## OpenAPI

````yaml en/openapi/v3-current/sta.yaml get /v1/credentials/{id}
openapi: 3.0.3
info:
  title: Lerian STA API
  description: >-
    API for Lerian STA — the participant-side rail that connects the institution
    to Banco Central do Brasil's STA (Sistema de Transferencia de Arquivos)
    file-exchange system. It covers outbound and inbound file transfers, BACEN
    credential management, inbound source polling configuration, and the tenant
    trust-store for message-signing certificates.
  version: v1.0.0
servers:
  - url: https://sta.sandbox.lerian.net
security:
  - BearerAuth: []
tags:
  - name: transfers
    description: >-
      Outbound and inbound STA file transfers — creation, listing, read,
      cancellation, retry, and urgent-processing marking.
  - name: trust-store
    description: >-
      Tenant trust-store X.509 certificate lifecycle: listing, upload, deletion,
      and status summary.
  - name: credentials
    description: >-
      BACEN STA credential management: creation, read, update, rotation,
      revocation, and connectivity testing.
  - name: inbound-source-configs
    description: >-
      Inbound source polling configuration: creation, read, update, deletion,
      manual poll triggering, and discovery reserve usage.
  - name: health
    description: Service health and readiness reporting.
paths:
  /v1/credentials/{id}:
    get:
      tags:
        - credentials
      summary: Read a credential
      description: |-
        Returns the credential metadata for the supplied id.
        The encrypted password is never returned. Emits
        credential.accessed via audit_outbox on every successful
        read.
      parameters:
        - description: Credential UUID
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/http.CredentialView'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
components:
  schemas:
    http.CredentialView:
      properties:
        asOf:
          type: string
        createdAt:
          type: string
        daysRemaining:
          type: integer
        description:
          type: string
        expiryStatus:
          type: string
        id:
          type: string
        institutionCode:
          type: string
        lastExpiryCheckedAt:
          type: string
        lastRotatedAt:
          type: string
        lastTestResult:
          type: string
        lastTestedAt:
          type: string
        operatorId:
          type: string
        passwordExpiresAt:
          type: string
        status:
          type: string
        updatedAt:
          type: string
      type: object
  securitySchemes:
    BearerAuth:
      description: 'Bearer token authentication (format: "Bearer {token}")'
      in: header
      name: Authorization
      type: apiKey

````