---
title: "Activate BYORK Light"
method: POST
path: "/screening/byork/config/activate"
tags: ["Compliance"]
---

# Activate BYORK Light

`POST /screening/byork/config/activate`

## Request

- Base URL: `https://api.fireblocks.io/v1`
- URL: `https://api.fireblocks.io/v1/screening/byork/config/activate`
- 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)

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).

## Headers

- `Idempotency-Key` string

## Response `200`

BYORK configuration activated.

- ByorkConfigResponse: 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
  - `outgoingTimeoutSeconds` integer: Timeout in seconds for outgoing BYORK wait-for-response
  - `active` boolean: Whether BYORK Light is active for the tenant
  - `provider` string: Provider identifier
  - `lastUpdate` string, date-time: Last update timestamp of the configuration
  - `timeoutRangeIncoming` ByorkTimeoutRange: Allowed range for timeout values (seconds). Use when calling PUT config/timeouts.
    - `minSeconds` integer
    - `maxSeconds` integer
  - `timeoutRangeOutgoing` ByorkTimeoutRange: Allowed range for timeout values (seconds). Use when calling PUT config/timeouts.
    - `minSeconds` integer
    - `maxSeconds` integer

## Other responses

- `400`: BYORK Light not enabled for tenant.
- `default`: Error Response

---

[API](https://skmtc.dev/fireblocks/apis/fireblocks-api.md) - [All operations](https://skmtc.dev/fireblocks/apis/fireblocks-api/llms.txt) - [OpenAPI document](https://skmtc.dev/fireblocks/apis/fireblocks-api/revisions/4eba9965659a?raw)
