All URIs are relative to https://developers.fireblocks.com/reference/
Method | HTTP request | Description |
---|---|---|
getAmlPostScreeningPolicy | GET /screening/aml/post_screening_policy | AML - View Post-Screening Policy |
getAmlScreeningPolicy | GET /screening/aml/screening_policy | AML - View Screening Policy |
getPostScreeningPolicy | GET /screening/travel_rule/post_screening_policy | Travel Rule - View Post-Screening Policy |
getScreeningPolicy | GET /screening/travel_rule/screening_policy | Travel Rule - View Screening Policy |
updateAmlScreeningConfiguration | PUT /screening/aml/policy_configuration | Update AML Configuration |
updateScreeningConfiguration | PUT /screening/configurations | Tenant - Screening Configuration |
updateTravelRuleConfig | PUT /screening/travel_rule/policy_configuration | Update Travel Rule Configuration |
ScreeningPolicyResponse getAmlPostScreeningPolicy()
Get the post-screening policy for AML.
import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, ScreeningPolicyResponse } from '@fireblocks/ts-sdk';
// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");
const fireblocks = new Fireblocks();
let body:any = {};
fireblocks.compliance.getAmlPostScreeningPolicy(body).then((res: FireblocksResponse<ScreeningPolicyResponse>) => {
console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));
This endpoint does not need any parameter.
No authorization required
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | Post-screening policy retrieved successfully. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ScreeningProviderRulesConfigurationResponse getAmlScreeningPolicy()
Get the screening policy for AML.
import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, ScreeningProviderRulesConfigurationResponse } from '@fireblocks/ts-sdk';
// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");
const fireblocks = new Fireblocks();
let body:any = {};
fireblocks.compliance.getAmlScreeningPolicy(body).then((res: FireblocksResponse<ScreeningProviderRulesConfigurationResponse>) => {
console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));
This endpoint does not need any parameter.
ScreeningProviderRulesConfigurationResponse
No authorization required
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | Screening policy retrieved successfully. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ScreeningPolicyResponse getPostScreeningPolicy()
Get the post-screening policy for Travel Rule.
import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, ScreeningPolicyResponse } from '@fireblocks/ts-sdk';
// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");
const fireblocks = new Fireblocks();
let body:any = {};
fireblocks.compliance.getPostScreeningPolicy(body).then((res: FireblocksResponse<ScreeningPolicyResponse>) => {
console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));
This endpoint does not need any parameter.
No authorization required
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | Post-screening policy retrieved successfully. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ScreeningProviderRulesConfigurationResponse getScreeningPolicy()
Get the screening policy for Travel Rule.
import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, ScreeningProviderRulesConfigurationResponse } from '@fireblocks/ts-sdk';
// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");
const fireblocks = new Fireblocks();
let body:any = {};
fireblocks.compliance.getScreeningPolicy(body).then((res: FireblocksResponse<ScreeningProviderRulesConfigurationResponse>) => {
console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));
This endpoint does not need any parameter.
ScreeningProviderRulesConfigurationResponse
No authorization required
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | Screening policy retrieved successfully. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ScreeningConfigurationsRequest updateAmlScreeningConfiguration()
Updates bypass screening, inbound delay, or outbound delay configurations for AML.
import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, ComplianceApiUpdateAmlScreeningConfigurationRequest, ScreeningConfigurationsRequest } from '@fireblocks/ts-sdk';
// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");
const fireblocks = new Fireblocks();
let body: ComplianceApiUpdateAmlScreeningConfigurationRequest = {
// 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. (optional)
idempotencyKey: idempotencyKey_example,
};
fireblocks.compliance.updateAmlScreeningConfiguration(body).then((res: FireblocksResponse<ScreeningConfigurationsRequest>) => {
console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));
Name | Type | Description | Notes |
---|---|---|---|
idempotencyKey | [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. | (optional) defaults to undefined |
ScreeningConfigurationsRequest
No authorization required
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | Configuration updated successfully. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ScreeningUpdateConfigurationsRequest updateScreeningConfiguration()
Update tenant screening configuration.
import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, ComplianceApiUpdateScreeningConfigurationRequest, ScreeningUpdateConfigurationsRequest } from '@fireblocks/ts-sdk';
// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");
const fireblocks = new Fireblocks();
let body: ComplianceApiUpdateScreeningConfigurationRequest = {
// 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. (optional)
idempotencyKey: idempotencyKey_example,
};
fireblocks.compliance.updateScreeningConfiguration(body).then((res: FireblocksResponse<ScreeningUpdateConfigurationsRequest>) => {
console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));
Name | Type | Description | Notes |
---|---|---|---|
idempotencyKey | [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. | (optional) defaults to undefined |
ScreeningUpdateConfigurationsRequest
No authorization required
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | Tenant Screening configuration updated successfully. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ScreeningConfigurationsRequest updateTravelRuleConfig()
Updates bypass screening, inbound delay, or outbound delay configurations for Travel Rule.
import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, ComplianceApiUpdateTravelRuleConfigRequest, ScreeningConfigurationsRequest } from '@fireblocks/ts-sdk';
// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");
const fireblocks = new Fireblocks();
let body: ComplianceApiUpdateTravelRuleConfigRequest = {
// 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. (optional)
idempotencyKey: idempotencyKey_example,
};
fireblocks.compliance.updateTravelRuleConfig(body).then((res: FireblocksResponse<ScreeningConfigurationsRequest>) => {
console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));
Name | Type | Description | Notes |
---|---|---|---|
idempotencyKey | [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. | (optional) defaults to undefined |
ScreeningConfigurationsRequest
No authorization required
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | Configuration updated successfully. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]