> ## 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. # Update institution config by id > Applies a partial update (connectorType/institutionCode/retryPolicyConfig/connectorMetadata/enabled/credentials) to an existing institution configuration addressed by the path id. connectorMetadata, when present, replaces the entire bag wholesale. credentials, when present, rotates the institution's connector credentials. Returns 404 when the institution has no configuration. ## OpenAPI ````yaml en/openapi/v3-current/sisbajud.yaml patch /institutions/{institutionId} openapi: 3.1.0 info: description: >- API for Lerian SISBAJUD — the participant-side rail that integrates the institution with Banco Central do Brasil's SISBAJUD (Sistema de Busca de Ativos do Poder Judiciário) system for judicial asset blocking and unblocking. It covers judicial-order administration, remittance and return file management, reconciliation, SLA monitoring, LGPD data-subject requests, and per-institution configuration and connector credentials. title: Lerian SISBAJUD API version: 1.0.0 servers: - url: https://sisbajud.sandbox.lerian.net security: - BearerAuth: [] tags: - description: >- Institution configuration lifecycle: create (with key provisioning), read, and partial update of a connector configuration addressed by institution id. name: Institution - description: >- LGPD data-subject access, portability, resolution, and cryptographic erasure operations, addressed by institution id. name: LGPD - description: >- Manual cryptographic key administration: KEK and tokenization-keyset rotation for an institution, addressed by institution id. name: Security - description: >- Judicial-order operational resilience write operations, such as reprocessing a FAILED order, addressed by institution id. name: Order Operations - description: >- Non-compliance-log administration, such as registering an SLA-breach justification, addressed by institution id. name: Non-Compliance - description: >- Manual reconciliation administration, such as triggering an on-demand reconciliation run. name: Reconciliation - description: >- Authenticated remittance-file reception: a caller notifies the service of a file already present in the inbound bucket and the service runs the receive and parse pipeline. name: Remittance File - description: >- Return (response) file administration, such as forcing an on-demand return-file generation outside the scheduled cron. name: Return File - description: >- Local/development-only admin routes (return-file content, monitoring close, unblock execute). Mounted only in local and development environments; never present in staging or production. name: Dev-Only - description: >- Admin read API: institution-scoped order, file, reconciliation, SLA, and processing-stats queries, plus audit-trail integrity verification. PII fields are masked unless the caller proves a cleartext grant. name: Admin - description: >- Connector credential registration and rotation: provisions an institution's per-connector outbound credential into the SecretStore and persists only its reference. name: Connector - description: >- Cross-organization subject summary: consolidates a subject's active blocks across the caller institution's Midaz organizations. Reading a subject by document is a privileged, audited PII access. name: Cross-Org paths: /institutions/{institutionId}: patch: tags: - Institution summary: Update institution config by id description: >- Applies a partial update (connectorType/institutionCode/retryPolicyConfig/connectorMetadata/enabled/credentials) to an existing institution configuration addressed by the path id. connectorMetadata, when present, replaces the entire bag wholesale. credentials, when present, rotates the institution's connector credentials. Returns 404 when the institution has no configuration. operationId: patch-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 requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchInstitutionConfigRequest' required: true 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: PatchInstitutionConfigRequest: additionalProperties: false properties: connectorMetadata: description: >- Connector-specific configuration bag. When present, replaces the entire bag wholesale. examples: - ledgerTargetId: ledger-2 connectorType: description: The outbound connector type. Omitted fields are left unchanged. examples: - midaz type: string credentials: $ref: '#/components/schemas/InstitutionConnectorCredentialsRequest' description: >- Optional connector credentials to rotate for this institution. Plaintext fields are encrypted at rest and never echoed. enabled: description: >- Whether the connector configuration is active. Omitted leaves the flag unchanged; explicitly false disables it. examples: - false type: boolean institutionCode: description: >- The institution's BACEN CNPJ (8 digits). When present, replaces the stored value. examples: - '12345678' type: string retryPolicyConfig: description: >- Operational retry policy as arbitrary JSON. When present, replaces the stored value. examples: - maxAttempts: 5 type: object 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: -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 InstitutionConnectorCredentialsRequest: additionalProperties: false properties: authMode: description: The connector auth mode for these credentials. examples: - access_manager type: string credentialsRef: description: >- The non-secret locator recorded in connector_metadata; identifies the stored secret. examples: - midaz/prod/inst-1 type: string fields: additionalProperties: type: string description: >- Plaintext credential fields (e.g. clientId/clientSecret). Encrypted at rest; never persisted in plaintext, logged, or echoed. type: object required: - authMode - credentialsRef 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 ````