Skip to main content
POST
Close an indeterminate send by hand

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

X-Idempotency
string
required

Idempotency key; a retry with the same key and body replays the first answer.

Path Parameters

controlId
string
required
Maximum string length: 256

Body

application/json
evidenceReference
string
required

Where the finding can be checked: the engine's settle or revert, a JD support ticket. Non-blank, at most 512 characters after trimming, or 422 JDC-0002.

note
string
required

What the operator established. 10 to 500 characters after trimming, or 422 JDC-0002.

Response

OK

channelId
enum<string>
required
Available options:
spb
closedByHand
object | null
required

An operator's by-hand close; null unless one was recorded. A record only: the outcome is unchanged.

controlId
string
required
engineId
string
required

Originating engine; this field routes the SPB return leg.

outcome
enum<string>
required
Available options:
DETERMINED,
INDETERMINATE,
RESOLVED,
NOT_SENT
queries
object | null
required

The engine's ConsultaNumCtrlIF trail for this send; null until the first.

resolution
object | null
required

How the vendor's own answer settled an indeterminate send; null until it did.

sentAt
string<date-time>
required
vendorCode
string | null
required
vendorSequence
string | null
required
ageSeconds
integer<int64>

Present while the outcome is INDETERMINATE: seconds since the send left, growing, for an open send; frozen at closedAt minus sentAt once an operator closed it by hand, because a closed send no longer ages for the alert.