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

# Obtener la configuración de institución por id

> Devuelve la configuración de la institución como una vista de metadatos segura (se omiten la referencia de credenciales y cualquier otro material secreto). La institución se direcciona por el id de la ruta.



## OpenAPI

````yaml es/openapi/v3-current/sisbajud.yaml get /institutions/{institutionId}
openapi: 3.1.0
info:
  description: >-
    API de Lerian SISBAJUD — el rail del lado del participante que integra la
    institución con el sistema SISBAJUD (Sistema de Busca de Ativos do Poder
    Judiciário) del Banco Central do Brasil para el bloqueo y desbloqueo
    judicial de activos. Cubre la administración de órdenes judiciales, la
    gestión de archivos de remesa y de retorno, la conciliación, el monitoreo de
    SLA, las solicitudes de titulares de datos LGPD y la configuración por
    institución y las credenciales de conector.
  title: Lerian SISBAJUD API
  version: 1.0.0
servers:
  - url: https://sisbajud.sandbox.lerian.net
security:
  - BearerAuth: []
tags:
  - description: >-
      Ciclo de vida de la configuración de institución: creación (con
      aprovisionamiento de claves), lectura y actualización parcial de una
      configuración de conector direccionada por id de institución.
    name: Institution
  - description: >-
      Operaciones LGPD de acceso, portabilidad, resolución y borrado
      criptográfico de titulares de datos, direccionadas por id de institución.
    name: LGPD
  - description: >-
      Administración manual de claves criptográficas: rotación de KEK y del
      conjunto de claves de tokenización para una institución, direccionada por
      id de institución.
    name: Security
  - description: >-
      Operaciones de escritura para la resiliencia operativa de órdenes
      judiciales, como reprocesar una orden FAILED, direccionadas por id de
      institución.
    name: Order Operations
  - description: >-
      Administración de registros de incumplimiento, como registrar una
      justificación por infracción de SLA, direccionada por id de institución.
    name: Non-Compliance
  - description: >-
      Administración manual de la conciliación, como disparar una ejecución de
      conciliación bajo demanda.
    name: Reconciliation
  - description: >-
      Recepción autenticada de archivos de remesa: quien llama notifica al
      servicio de un archivo ya presente en el bucket de entrada y el servicio
      ejecuta la canalización de recepción y análisis.
    name: Remittance File
  - description: >-
      Administración de archivos de retorno (respuesta), como forzar una
      generación de archivo de retorno bajo demanda fuera del cron programado.
    name: Return File
  - description: >-
      Rutas de administración solo para local/desarrollo (contenido de archivo
      de retorno, cierre de monitoreo, ejecución de desbloqueo). Montadas solo
      en entornos locales y de desarrollo; nunca presentes en staging ni en
      production.
    name: Dev-Only
  - description: >-
      API de lectura de administración: consultas acotadas a la institución de
      órdenes, archivos, conciliación, SLA y estadísticas de procesamiento, más
      la verificación de integridad del registro de auditoría. Los campos de PII
      se enmascaran salvo que quien llama demuestre una concesión de texto
      claro.
    name: Admin
  - description: >-
      Registro y rotación de credenciales de conector: aprovisiona la credencial
      saliente por conector de una institución en el SecretStore y persiste solo
      su referencia.
    name: Connector
  - description: >-
      Resumen de sujeto entre organizaciones: consolida los bloqueos activos de
      un sujeto en todas las organizaciones Midaz de la institución que llama.
      Leer un sujeto por documento es un acceso privilegiado y auditado a PII.
    name: Cross-Org
paths:
  /institutions/{institutionId}:
    get:
      tags:
        - Institution
      summary: Obtener la configuración de institución por id
      description: >-
        Devuelve la configuración de la institución como una vista de metadatos
        segura (se omiten la referencia de credenciales y cualquier otro
        material secreto). La institución se direcciona por el id de la ruta.
      operationId: get-institution-config
      parameters:
        - description: The institution's unique identifier (UUID).
          in: path
          name: institutionId
          required: true
          schema:
            description: The institution's unique identifier (UUID).
            examples:
              - 550e8400-e29b-41d4-a716-446655440000
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InstitutionConfigResponse'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
components:
  schemas:
    InstitutionConfigResponse:
      additionalProperties: false
      properties:
        connectorMetadata:
          description: >-
            Connector-specific configuration bag, scrubbed of secret-bearing
            keys.
          examples:
            - blockableBalances:
                - available
              ledgerTargetId: ledger-1
        connectorType:
          description: The outbound connector type for this institution.
          examples:
            - midaz
          type: string
        createdAt:
          description: RFC 3339 creation timestamp (UTC).
          examples:
            - '2024-01-15T10:30:00Z'
          type: string
        enabled:
          description: Whether the connector configuration is active.
          examples:
            - true
          type: boolean
        institutionCode:
          description: >-
            The institution's BACEN CNPJ (8 digits) for return-file headers and
            file header validation.
          examples:
            - '12345678'
          type: string
        institutionId:
          description: The institution's unique identifier (UUID).
          examples:
            - 550e8400-e29b-41d4-a716-446655440000
          type: string
        retryPolicyConfig:
          description: Operational retry policy (backoff/attempts) as arbitrary JSON.
          examples:
            - maxAttempts: 3
        updatedAt:
          description: RFC 3339 last-update timestamp (UTC).
          examples:
            - '2024-01-15T12:00:00Z'
          type: string
      required:
        - institutionId
        - connectorType
        - institutionCode
        - enabled
        - createdAt
        - updatedAt
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Stable, machine-readable domain error code scoped to the emitting
            service (format: <SERVICE>-NNNN).
          examples:
            - ERR-0001
          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
      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
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````