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

# Create institution config and provision keys

> Creates a new institution configuration (create-only; 409 if one already exists for the id) and provisions its tokenization PRF + audit MAC keysets in the same flow. The institution id is supplied in the request body.



## OpenAPI

````yaml /en/openapi/v3-current/sisbajud-mensageria.yaml post /v1/institutions
openapi: 3.1.0
info:
  description: >-
    API for the Lerian SISBAJUD Mensageria, the regulatory side of Lerian
    SISBAJUD. It covers institution configuration, order and file queries,
    return files, LGPD requests, key rotation, non-compliance justifications and
    the Lerian STA dead-letter queue.
  title: Lerian SISBAJUD Mensageria 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: >-
      Institution configuration lifecycle: create (with key provisioning), read,
      and partial update of an institution configuration addressed by
      institution id.
    name: Institution
  - description: >-
      LGPD data-subject access, portability and resolution 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: >-
      Non-compliance-log administration, such as registering an SLA-breach
      justification, addressed by institution id.
    name: Non-Compliance
  - description: >-
      Return (response) file administration, such as forcing an on-demand
      return-file generation outside the scheduled cron.
    name: Return File
  - description: >-
      Admin read API: institution-scoped order, file, SLA, and processing-stats
      queries, plus audit-trail integrity verification. PII fields are masked
      unless the caller proves a cleartext grant.
    name: Admin
paths:
  /v1/institutions:
    post:
      tags:
        - Institution
      summary: Create institution config and provision keys
      description: >-
        Creates a new institution configuration (create-only; 409 if one already
        exists for the id) and provisions its tokenization PRF + audit MAC
        keysets in the same flow. The institution id is supplied in the request
        body.
      operationId: create-institution-config
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateInstitutionConfigRequest'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InstitutionConfigResponse'
          description: Created
        '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
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
components:
  schemas:
    CreateInstitutionConfigRequest:
      additionalProperties: false
      properties:
        enabled:
          description: Whether the institution 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) that addresses the new
            configuration.
          examples:
            - 550e8400-e29b-41d4-a716-446655440000
          type: string
        retryPolicyConfig:
          description: Operational retry policy (backoff/attempts) as arbitrary JSON.
          examples:
            - initialBackoffMs: 100
              maxAttempts: 3
      required:
        - institutionId
        - institutionCode
        - enabled
      type: object
    InstitutionConfigResponse:
      additionalProperties: false
      properties:
        createdAt:
          description: RFC 3339 creation timestamp (UTC).
          examples:
            - '2024-01-15T10:30:00Z'
          type: string
        enabled:
          description: Whether the institution 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
        - institutionCode
        - enabled
        - createdAt
        - updatedAt
      type: object
    Detail:
      additionalProperties: true
      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
    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.