Deactivate BYORK Light

Deactivates BYORK Light for the authenticated tenant (sets config.active to false). Once deactivated, BYORK screening no longer applies until activated again. Requires BYORK Light to be enabled for the tenant (contact your CSM to enable).

POST /screening/byork/config/deactivate

TypeScript

TypeScript

const response: Promise<FireblocksResponse<ByorkConfigResponse>> = fireblocks.compliance.deactivateByorkConfig(complianceApiDeactivateByorkConfigRequest);

200

{
  "incomingTimeoutSeconds": 86400,
  "outgoingTimeoutSeconds": 3600,
  "active": true,
  "provider": "BYORK_LITE",
  "lastUpdate": "2026-01-29T12:00:00.000Z",
  "timeoutRangeIncoming": {
    "minSeconds": 10,
    "maxSeconds": 604800
  },
  "timeoutRangeOutgoing": {
    "minSeconds": 10,
    "maxSeconds": 604800
  }
}

Headers

Idempotency-Key · string

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.

Response

200

application/json

BYORK configuration deactivated.

BYORK Light configuration for the tenant: wait-for-response timeouts, active flag, provider, last update time, and allowed timeout ranges for validation.

incomingTimeoutSeconds · integer

Timeout in seconds for incoming BYORK wait-for-response

Example:

86400

outgoingTimeoutSeconds · integer

Timeout in seconds for outgoing BYORK wait-for-response

Example:

3600

active · boolean

Whether BYORK Light is active for the tenant

Example:

true

provider · string

Provider identifier

Example:

"BYORK_LITE"

lastUpdate · string<date-time>

Last update timestamp of the configuration

Example:

"2026-01-29T12:00:00.000Z"

timeoutRangeIncoming · object

Allowed range for timeout values (seconds). Use when calling PUT config/timeouts.

Show child attributes

timeoutRangeOutgoing · object

Allowed range for timeout values (seconds). Use when calling PUT config/timeouts.

Show child attributes