Compliance

Get BYORK Light verdict

Returns the current BYORK verdict and status for a transaction. Status can be PRE_ACCEPTED, PENDING, RECEIVED (verdict is final but processing not yet complete), or COMPLETED. Requires BYORK Light to be enabled for the tenant. Returns 404 if no BYORK verdict is found for the transaction.

get/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/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

txIdstring required

Example:550e8400-e29b-41d4-a716-446655440000

Transaction ID

Response

Current verdict and status.

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.

verdict'ACCEPT' | 'REJECT' | 'WAIT' required

ACCEPT/REJECT - Final or pre-accepted verdict. WAIT - When status is PENDING (transaction awaiting decision).

Example response

{
  "status": "COMPLETED",
  "verdict": "ACCEPT"
}

Changes

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