Skip to main content
POST
Resolve a stuck return-file transmission

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Path Parameters

institutionId
string
required

The institution the return file belongs to (UUID). Authorized by the caller's RBAC role.

Example:

"44444444-4444-4444-4444-444444444444"

id
string
required

The return file id (UUID).

Example:

"dddddddd-dddd-dddd-dddd-dddddddddddd"

Body

application/json
action
enum<string>
required

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.

Available options:
probe_now,
attach_transfer,
force_fail,
cancel_now
Example:

"probe_now"

reason
string
required

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.

Example:

"Lerian STA unavailable since 14:00; response deadline at 19:00"

transferId
string

Required by attach_transfer; ignored otherwise. Lerian STA is asked to confirm it belongs to this file before anything is bound.

Example:

"eeeeeeee-eeee-eeee-eeee-eeeeeeeeeeee"

Response

OK

outcome
string
required

A token from the closed set: reconciled_by_list, still_absent, attached, forced_failed, cancelled, cancel_refused.

Example:

"reconciled_by_list"

transferId
string

The transfer the file ended up bound to, when the action produced one.

Example:

"eeeeeeee-eeee-eeee-eeee-eeeeeeeeeeee"