FIfireblocks
Compliance

Get BYORK Light configuration

Retrieves BYORK Light configuration for the authenticated tenant (timeouts, active flag, allowed timeout ranges). Returns default config when none exists. Requires BYORK Light to be enabled for the tenant.

get/screening/byork/config

Request

Response

BYORK configuration (or default).

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.