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

# Resolve a stuck return-file transmission

> Applies one human remedy to a submission no automatic path can finish. probe_now asks Lerian STA whether a transfer for this file already exists and binds it if so; attach_transfer binds a transfer you located, but ONLY after Lerian STA confirms it belongs to this file; force_fail gives up on a stuck submission so the file becomes reconsolidable, but only once its last submission attempt is 5 minutes old and only after Lerian STA shows no transfer for the file that can still reach BACEN (none, or one that ended Rejected, Inconsistent, Canceled or NotAuthorized); otherwise it is refused with 422; cancel_now retries cancelling a size-mismatched transfer that is still live at Lerian STA. Any action answers 503 when Lerian STA cannot be reached. reason is required and MUST NOT contain personal data or monetary values — it is written verbatim into the audit trail. 422 names the door that IS open when the action does not apply to the file's state.



## OpenAPI

````yaml /es/openapi/v3-current/sisbajud-mensageria.yaml post /v1/institutions/{institutionId}/return-file/{id}/resolve-transmission
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/{id}/resolve-transmission:
    post:
      tags:
        - Return File
      summary: Resolve a stuck return-file transmission
      description: >-
        Applies one human remedy to a submission no automatic path can finish.
        probe_now asks Lerian STA whether a transfer for this file already
        exists and binds it if so; attach_transfer binds a transfer you located,
        but ONLY after Lerian STA confirms it belongs to this file; force_fail
        gives up on a stuck submission so the file becomes reconsolidable, but
        only once its last submission attempt is 5 minutes old and only after
        Lerian STA shows no transfer for the file that can still reach BACEN
        (none, or one that ended Rejected, Inconsistent, Canceled or
        NotAuthorized); otherwise it is refused with 422; cancel_now retries
        cancelling a size-mismatched transfer that is still live at Lerian STA.
        Any action answers 503 when Lerian STA cannot be reached. reason is
        required and MUST NOT contain personal data or monetary values — it is
        written verbatim into the audit trail. 422 names the door that IS open
        when the action does not apply to the file's state.
      operationId: resolve-return-file-transmission
      parameters:
        - description: >-
            The institution the return file belongs to (UUID). Authorized by the
            caller's RBAC role.
          in: path
          name: institutionId
          required: true
          schema:
            description: >-
              The institution the return file belongs to (UUID). Authorized by
              the caller's RBAC role.
            examples:
              - 44444444-4444-4444-4444-444444444444
            type: string
        - description: The return file id (UUID).
          in: path
          name: id
          required: true
          schema:
            description: The return file id (UUID).
            examples:
              - dddddddd-dddd-dddd-dddd-dddddddddddd
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReturnFileResolveTransmissionRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReturnFileResolveTransmissionResponse'
          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:
    ReturnFileResolveTransmissionRequest:
      additionalProperties: false
      properties:
        action:
          description: >-
            probe_now asks Lerian STA whether a transfer for this file already
            exists; attach_transfer binds one you located, after Lerian STA
            confirms it is this file's; force_fail gives up on a stuck
            submission so the file becomes reconsolidable; cancel_now retries
            cancelling a size-mismatched transfer that is still live.
          enum:
            - probe_now
            - attach_transfer
            - force_fail
            - cancel_now
          examples:
            - probe_now
          type: string
        reason:
          description: >-
            Why this remedy is being applied, in your own words. MUST NOT
            contain personal data (CPF/CNPJ, names, process numbers) or monetary
            values: it is written verbatim into a permanent, append-only audit
            record. Text carrying a run of more than 10 digits is refused with
            422 — that is a floor against pasting an identifier, not a check
            that recognises a name.
          examples:
            - Lerian STA unavailable since 14:00; response deadline at 19:00
          type: string
        transferId:
          description: >-
            Required by attach_transfer; ignored otherwise. Lerian STA is asked
            to confirm it belongs to this file before anything is bound.
          examples:
            - eeeeeeee-eeee-eeee-eeee-eeeeeeeeeeee
          type: string
      required:
        - action
        - reason
      type: object
    ReturnFileResolveTransmissionResponse:
      additionalProperties: false
      properties:
        outcome:
          description: >-
            A token from the closed set: reconciled_by_list, still_absent,
            attached, forced_failed, cancelled. A failed cancel_now answers with
            an error, not an outcome.
          examples:
            - reconciled_by_list
          type: string
        transferId:
          description: >-
            The transfer the file ended up bound to, when the action produced
            one.
          examples:
            - eeeeeeee-eeee-eeee-eeee-eeeeeeeeeeee
          type: string
      required:
        - outcome
      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.