> ## 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; cancel_now retries cancelling a size-mismatched transfer that is still live at Lerian STA. 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 /pt/openapi/v3-current/sisbajud.yaml post /admin/return-file/{id}/resolve-transmission
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: >-
      Administrative operations: return-file content retrieval, monitoring
      close, and unblock execution. A deployment serves them only when it is
      configured for local or development use.
    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: >-
      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:
  /admin/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;
        cancel_now retries cancelling a size-mismatched transfer that is still
        live at Lerian STA. 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 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
        institutionId:
          description: The institution the return file belongs to (UUID).
          examples:
            - 44444444-4444-4444-4444-444444444444
          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:
        - institutionId
        - 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, cancel_refused.
          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

````