> ## Documentation Index
> Fetch the complete documentation index at: https://developers.fireblocks.com/llms.txt
> Use this file to discover all available pages before exploring further.

<AgentInstructions>

## Submitting Feedback

If you encounter incorrect, outdated, or confusing documentation on this page, submit feedback:

POST https://developers.fireblocks.com/feedback

```json
{
  "path": "/api-reference/compliance/get-byork-light-configuration",
  "feedback": "Description of the issue"
}
```

Only submit feedback when you have something specific and actionable to report.

</AgentInstructions>

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



## OpenAPI

````yaml https://docs.fireblocks.com/api/v1/swagger.yaml get /screening/byork/config
openapi: 3.0.0
info:
  title: Fireblocks API
  description: >
    Fireblocks provides a suite of applications to manage digital asset
    operations and a complete development platform to build your business on the
    blockchain.


    - Visit our website for more information: [Fireblocks
    Website](https://fireblocks.com)

    - Visit our developer docs: [Fireblocks
    DevPortal](https://developers.fireblocks.com)
  version: 1.6.2
  contact:
    email: developers@fireblocks.com
servers:
  - url: https://api.fireblocks.io/v1
    description: Fireblocks Production Environment Base URL
  - url: https://sandbox-api.fireblocks.io/v1
    description: Fireblocks Sandbox Environment Base URL
security: []
paths:
  /screening/byork/config:
    get:
      tags:
        - Compliance
      summary: Get BYORK Light configuration
      description: >-
        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.
      operationId: getByorkConfig
      responses:
        '200':
          description: BYORK configuration (or default).
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ByorkConfigResponse'
        '400':
          description: BYORK Light not enabled for tenant.
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
        default:
          $ref: '#/components/responses/Error'
      x-codeSamples:
        - lang: TypeScript
          source: >-
            const response: Promise<FireblocksResponse<ByorkConfigResponse>> =
            fireblocks.compliance.getByorkConfig();
        - lang: Java
          source: >-
            CompletableFuture<ApiResponse<ByorkConfigResponse>> response =
            fireblocks.compliance().getByorkConfig();
        - lang: Python
          source: response = fireblocks.compliance.get_byork_config();
components:
  headers:
    X-Request-ID:
      schema:
        type: string
      description: >-
        Unique ID correlated to the API request. Please provide it in any
        support ticket you create or on Github issues related to Fireblocks SDKs
  schemas:
    ByorkConfigResponse:
      type: object
      description: >-
        BYORK Light configuration for the tenant: wait-for-response timeouts,
        active flag, provider, last update time, and allowed timeout ranges for
        validation.
      properties:
        incomingTimeoutSeconds:
          type: integer
          description: Timeout in seconds for incoming BYORK wait-for-response
          example: 86400
        outgoingTimeoutSeconds:
          type: integer
          description: Timeout in seconds for outgoing BYORK wait-for-response
          example: 3600
        active:
          type: boolean
          description: Whether BYORK Light is active for the tenant
          example: true
        provider:
          type: string
          description: Provider identifier
          example: BYORK_LITE
        lastUpdate:
          type: string
          format: date-time
          description: Last update timestamp of the configuration
          example: '2026-01-29T12:00:00.000Z'
        timeoutRangeIncoming:
          $ref: '#/components/schemas/ByorkTimeoutRange'
        timeoutRangeOutgoing:
          $ref: '#/components/schemas/ByorkTimeoutRange'
    ErrorSchema:
      type: object
      properties:
        message:
          type: string
        code:
          type: number
    ByorkTimeoutRange:
      type: object
      description: >-
        Allowed range for timeout values (seconds). Use when calling PUT
        config/timeouts.
      properties:
        minSeconds:
          type: integer
          example: 10
        maxSeconds:
          type: integer
          example: 604800
  responses:
    Error:
      description: Error Response
      headers:
        X-Request-ID:
          $ref: '#/components/headers/X-Request-ID'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorSchema'

````