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

# Force a return-file generation

> Forces one return-file generation for the institution in the path and returns the generated file's summary. A malformed institutionId is 400; a caller without the role is 403; an institution not configured with an institution_code is 422; a missing reception flow fails closed with 503.



## OpenAPI

````yaml /pt/openapi/v3-current/sisbajud-mensageria.yaml post /v1/institutions/{institutionId}/return-file/generate
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/{institutionId}/return-file/generate:
    post:
      tags:
        - Return File
      summary: Force a return-file generation
      description: >-
        Forces one return-file generation for the institution in the path and
        returns the generated file's summary. A malformed institutionId is 400;
        a caller without the role is 403; an institution not configured with an
        institution_code is 422; a missing reception flow fails closed with 503.
      operationId: generate-return-file
      parameters:
        - description: >-
            The institution the return file is generated for (UUID). Authorized
            by the caller's RBAC role.
          in: path
          name: institutionId
          required: true
          schema:
            description: >-
              The institution the return file is generated for (UUID).
              Authorized by the caller's RBAC role.
            examples:
              - 44444444-4444-4444-4444-444444444444
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReturnFileGenerateResponse'
          description: OK
        '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:
    ReturnFileGenerateResponse:
      additionalProperties: false
      properties:
        environment:
          description: The resolved SISBAJUD environment.
          examples:
            - production
          type: string
        failedGroups:
          description: >-
            The number of response groups whose answer failed in this run.
            Non-zero with generated=true is a partial failure: the generated
            files stand and the failed groups are retried by the next run.
          examples:
            - 0
          format: int64
          type: integer
        fileHash:
          description: The file content hash.
          examples:
            - sha256:abc123...
          type: string
        fileName:
          description: The generated file name.
          examples:
            - retorno-2026-07-14.txt
          type: string
        fileType:
          description: The SISBAJUD file-type code.
          examples:
            - RETORNO
          type: string
        generated:
          description: Whether this run created a new return file.
          examples:
            - true
          type: boolean
        generatedCount:
          description: >-
            The number of return files created by this run. A remittance whose
            answer matches an existing file is stamped onto that file and
            creates none. The fields above describe the newest one.
          examples:
            - 3
          format: int64
          type: integer
        generationDate:
          description: The RFC3339 generation timestamp.
          examples:
            - '2026-07-14T12:00:00Z'
          type: string
        id:
          description: The generated file id.
          examples:
            - dddddddd-dddd-dddd-dddd-dddddddddddd
          type: string
        recordCount:
          description: The number of records in the generated file.
          examples:
            - 42
          format: int64
          type: integer
        status:
          description: The file status.
          examples:
            - GENERATED
          type: string
      required:
        - generated
        - recordCount
        - generatedCount
        - failedGroups
      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.