Tenant - Screening Configuration - Fireblocks Developer Docs

PUT

screening

configurations

TypeScript

const response: Promise<FireblocksResponse<ScreeningUpdateConfigurations>> = fireblocks.compliance.updateScreeningConfiguration(complianceApiUpdateScreeningConfigurationRequest);

{
  "disableBypass": true,
  "disableUnfreeze": true
}

Headers

Idempotency-Key

string

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.

Body

application/json

disableBypass

boolean

Flag to enable or disable bypass screening on tenant configuration.

disableUnfreeze

boolean

Flag to enable or disable unfreeze of transaction frozen by policy rule on tenant configuration.

Response

200 - application/json

Tenant Screening configuration updated successfully.

disableBypass

boolean

Flag to enable or disable bypass screening on tenant configuration.

disableUnfreeze

boolean

Flag to enable or disable unfreeze of transaction frozen by policy rule on tenant configuration.

Bypass Screening PolicyTriggers a new transaction, with the API user as the initiator, bypassing the screening policy checks. This endpoint is restricted to Admin API users and is only applicable to outgoing transactions.

⌘I

TypeScript

const response: Promise<FireblocksResponse<ScreeningUpdateConfigurations>> = fireblocks.compliance.updateScreeningConfiguration(complianceApiUpdateScreeningConfigurationRequest);

{
  "disableBypass": true,
  "disableUnfreeze": true
}