Skip to main content
GET
/
screening
/
byork
/
config
TypeScript
const response: Promise<FireblocksResponse<ByorkConfigResponse>> = fireblocks.compliance.getByorkConfig();
CompletableFuture<ApiResponse<ByorkConfigResponse>> response = fireblocks.compliance().getByorkConfig();
response = fireblocks.compliance.get_byork_config();
curl --request GET \
  --url https://api.fireblocks.io/v1/screening/byork/config
const options = {method: 'GET'};

fetch('https://api.fireblocks.io/v1/screening/byork/config', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fireblocks.io/v1/screening/byork/config",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fireblocks.io/v1/screening/byork/config"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
require 'uri'
require 'net/http'

url = URI("https://api.fireblocks.io/v1/screening/byork/config")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
{
  "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
  }
}
{
  "message": "<string>",
  "code": 123
}
{
  "message": "<string>",
  "code": 123
}

Response

BYORK configuration (or default).

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.

​
timeoutRangeOutgoing
object

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