Compliance

Activate BYORK Light

Activates BYORK Light for the authenticated tenant (sets config.active to true). Once activated, BYORK screening applies to matching transactions. Requires BYORK Light to be enabled for the tenant (contact your CSM to enable).

post/screening/byork/config/activate

Request

Base URL
https://api.fireblocks.io/v1
Auth
none declared
TypeScript
https://skmtc.dev/fireblocks/apis/fireblocks-api/docs/screening/byork/config/activate/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.

Response

BYORK configuration activated.

incomingTimeoutSecondsinteger

Timeout in seconds for incoming BYORK wait-for-response

outgoingTimeoutSecondsinteger

Timeout in seconds for outgoing BYORK wait-for-response

activeboolean

Whether BYORK Light is active for the tenant

providerstring

Provider identifier

lastUpdatestring date-time

Last update timestamp of the configuration

Example response

{
  "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
  }
}

Changes

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