ComplianceScreeningConfigurationApi.md

ComplianceScreeningConfigurationApi

All URIs are relative to https://developers.fireblocks.com/reference/

Method	HTTP request	Description
getAmlScreeningConfiguration	GET /screening/aml/policy_configuration	Get AML Screening Policy Configuration
getScreeningConfiguration	GET /screening/travel_rule/policy_configuration	Get Travel Rule Screening Policy Configuration

getAmlScreeningConfiguration

ScreeningConfigurationsRequest getAmlScreeningConfiguration()

Retrieves the configuration for Travel Rule screening policy.

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, 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:any = {};

fireblocks.complianceScreeningConfiguration.getAmlScreeningConfiguration(body).then((res: FireblocksResponse<ScreeningConfigurationsRequest>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

This endpoint does not need any parameter.

Return type

ScreeningConfigurationsRequest

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Screening policy configuration retrieved successfully.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getScreeningConfiguration

ScreeningConfigurationsRequest getScreeningConfiguration()

Retrieves the configuration for Travel Rule screening policy.

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, 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:any = {};

fireblocks.complianceScreeningConfiguration.getScreeningConfiguration(body).then((res: FireblocksResponse<ScreeningConfigurationsRequest>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

This endpoint does not need any parameter.

Return type

ScreeningConfigurationsRequest

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Screening policy configuration retrieved successfully.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]