Skip to main content
GET
/
screening
/
trlink
/
policy
TypeScript
const response: Promise<FireblocksResponse<TRLinkPolicyResponse>> = fireblocks.tRLink.getTRLinkPolicy();
{
  "preScreeningRules": [
    {
      "customerId": "cust_123abc",
      "direction": "OUTBOUND",
      "sourceType": "VAULT_ACCOUNT",
      "sourceSubType": "<string>",
      "sourceAddress": "0x1234567890abcdef1234567890abcdef12345678",
      "destType": "EXTERNAL_WALLET",
      "destSubType": "<string>",
      "destAddress": "0xabcdefabcdefabcdefabcdefabcdefabcdefabcd",
      "sourceId": "<string>",
      "destId": "<string>",
      "asset": "BTC",
      "baseAsset": "<string>",
      "amount": {
        "range": {
          "min": "1000",
          "max": "100000"
        },
        "currency": "USD"
      },
      "networkProtocol": "BITCOIN",
      "operation": "TRANSFER",
      "description": "Screen large BTC outbound transactions to external wallets",
      "isDefault": false
    }
  ],
  "postScreeningRules": [
    {
      "customerId": "cust_123abc",
      "direction": "OUTBOUND",
      "sourceType": "EXTERNAL_WALLET",
      "sourceSubType": "<string>",
      "sourceAddress": "0x9876543210fedcba9876543210fedcba98765432",
      "destType": "VAULT_ACCOUNT",
      "destSubType": "<string>",
      "destAddress": "0x1234567890abcdef1234567890abcdef12345678",
      "sourceId": "<string>",
      "destId": "<string>",
      "asset": "ETH",
      "baseAsset": "<string>",
      "amount": {
        "range": {
          "min": "1000",
          "max": "100000"
        },
        "currency": "USD"
      },
      "networkProtocol": "ETHEREUM",
      "operation": "TRANSFER",
      "description": "Accept transactions with TRM approval after January 2024",
      "isDefault": false,
      "providerIdent": "trm-provider-1",
      "trmStatus": "ACCEPTED",
      "validBefore": 1735689600000,
      "validAfter": 1704067200000
    }
  ],
  "missingTrmRules": [
    {
      "customerId": "cust_123abc",
      "direction": "OUTBOUND",
      "sourceType": "EXTERNAL_WALLET",
      "sourceSubType": "<string>",
      "sourceAddress": "0xabcdef1234567890abcdef1234567890abcdef12",
      "destType": "VAULT_ACCOUNT",
      "destSubType": "<string>",
      "destAddress": "0x567890abcdef1234567890abcdef1234567890ab",
      "sourceId": "<string>",
      "destId": "<string>",
      "asset": "BTC",
      "baseAsset": "<string>",
      "amount": {
        "range": {
          "min": "1000",
          "max": "100000"
        },
        "currency": "USD"
      },
      "networkProtocol": "BITCOIN",
      "operation": "TRANSFER",
      "description": "Wait for TRM screening on inbound transactions",
      "isDefault": false,
      "validBefore": 1735689600000,
      "validAfter": 1704067200000
    }
  ]
}

Response

Policy retrieved successfully

TRLink policy response containing pre-screening, post-screening, and missing TRM rules

​
preScreeningRules
object[]
required

Pre-screening rules that determine whether transactions should be screened

​
postScreeningRules
object[]
required

Post-screening rules that determine actions based on screening results

​
missingTrmRules
object[]
required

Rules for handling transactions when TRM screening data is unavailable