Compliance

Set BYORK Light verdict

Submit verdict (ACCEPT or REJECT) for a transaction in the BYORK Light flow. If the transaction is awaiting your decision, the verdict is applied immediately (response status COMPLETED). If processing has not yet reached that point, the verdict is stored and applied when it does (response status PRE_ACCEPTED). Requires BYORK Light to be enabled for the tenant.

post/screening/byork/verdict

Request

Base URL
https://api.fireblocks.io/v1
Auth
none declared
TypeScript
https://skmtc.dev/fireblocks/apis/fireblocks-api/docs/screening/byork/verdict/post.ts
A function with typed inputs. Its response is checked against the schema.

Headers

Idempotency-Keystring

A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.

Request body

txIdstring required

Transaction ID to set the verdict for

verdict'ACCEPT' | 'REJECT' required

Verdict to apply (ACCEPT or REJECT).

Example request

{
  "txId": "550e8400-e29b-41d4-a716-446655440000",
  "verdict": "ACCEPT"
}

Response

Verdict applied (COMPLETED) or pre-accepted (PRE_ACCEPTED).

status'PRE_ACCEPTED' | 'COMPLETED' | 'PENDING' | 'RECEIVED' required

PRE_ACCEPTED - Verdict stored and will be applied when processing reaches the point where your decision is needed. COMPLETED - Verdict final and processing complete. PENDING - Transaction in BYORK flow; no final verdict yet (awaiting decision or processing). RECEIVED - Verdict final and stored; processing not yet complete.

messagestring required

Human-readable message

Example response

{
  "status": "COMPLETED",
  "message": "Verdict ACCEPT applied"
}

Changes

No recorded changes to this operation across all 1 revision of this API.