Skip to main content
POST
Clear a VSync escalation block

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

X-Idempotency
string
required

REQUIRED. Client-supplied replay key, at most 64 bytes. A request without it is refused with PIX-0030 @ 400 before the handler runs. Replaying the same key with a divergent request is PIX-0031 @ 412 -- at the edge for one hour, and permanently thereafter from the administrative audit record.

Example:

"a1b2c3d4-0000-0000-0000-000000000002"

Path Parameters

key_type
string
required

PIX key type of the reconciliation scope to unblock. The other half of the scope, the ISPB, is authoritative from your token.

Example:

"CPF"

Body

application/json
expectedStatus
string
required

Status the caller believes the scope currently carries. ESCALATION_BLOCKED is the only accepted value -- it is the only status this action clears from -- and the request is refused with 409 PIX-0159 if the stored row disagrees, which is what makes the operation safe against a scope that moved since it was read.

Example:

"ESCALATION_BLOCKED"

reason
string
required

Operator justification for the intervention. Recorded permanently in the administrative audit log and read by humans during an audit; no code branches on it.

Example:

"Escalation breaker tripped during the BACEN DICT outage on 2026-09-01; drift triaged and the scope is safe to reconcile again"

triggerVerification
boolean

Enqueue a Flow A sync verification for the scope in the same transaction as the clear, so the scope is re-measured immediately instead of at the next cadence tick. When true and another job is already active for the scope, the WHOLE request is refused with 409 PIX-0156 and the block is NOT cleared. Defaults to false.

Example:

true

Response

The escalation block was cleared, or an identical X-Idempotency replay returned the outcome of the first request. verificationJobId is present only when triggerVerification was true.

keyType
string
required

PIX key type of the reconciliation scope that was cleared.

Example:

"CPF"

previousStatus
string
required

Sync status the scope carried immediately before this action. Always ESCALATION_BLOCKED on success -- it is the only status the action clears from.

Example:

"ESCALATION_BLOCKED"

status
string
required

Sync status the clear left behind. Always OUT_OF_SYNC: the scope re-enters the reconciliation flow as known-drifted, not as known-clean.

Example:

"OUT_OF_SYNC"

verificationJobId
string

The Flow A VSYNC job this request enqueued. Absent when triggerVerification was false.

Example:

"019606a1-3b4c-7d8e-9f01-234567890abc"