FIfireblocks
TRLink

Get TRLink policy

Retrieves the complete TRSupport policy for the authenticated tenant, including pre-screening rules, post-screening rules, and missing TRM rules. Pre-screening rules determine whether transactions should be screened. Post-screening rules determine actions based on screening results. Missing TRM rules handle cases when screening data is unavailable.

get/screening/trlink/policy

Request

Response

Policy retrieved successfully

Example response

{
  "preScreeningRules": [
    {
      "customerId": "cust_123abc",
      "direction": "OUTBOUND",
      "sourceType": "VAULT_ACCOUNT",
      "sourceAddress": "0x1234567890abcdef1234567890abcdef12345678",
      "destType": "EXTERNAL_WALLET",
      "destAddress": "0xabcdefabcdefabcdefabcdefabcdefabcdefabcd",
      "asset": "BTC",
      "amount": {
        "range": {
          "min": "1000",
          "max": "100000"
        },
        "currency": "USD"
      },
      "networkProtocol": "BITCOIN",
      "operation": "TRANSFER",
      "description": "Screen large BTC outbound transactions to external wallets"
    }
  ],
  "postScreeningRules": [
    {
      "customerId": "cust_123abc",
      "direction": "OUTBOUND",
      "sourceType": "EXTERNAL_WALLET",
      "sourceAddress": "0x9876543210fedcba9876543210fedcba98765432",
      "destType": "VAULT_ACCOUNT",
      "destAddress": "0x1234567890abcdef1234567890abcdef12345678",
      "asset": "ETH",
      "amount": {
        "range": {
          "min": "1000",
          "max": "100000"
        },
        "currency": "USD"
      },
      "networkProtocol": "ETHEREUM",
      "operation": "TRANSFER",
      "description": "Accept transactions with TRM approval after January 2024",
      "providerIdent": "trm-provider-1",
      "trmStatus": "ACCEPTED",
      "validBefore": 1800,
      "validAfter": 1800
    }
  ],
  "missingTrmRules": [
    {
      "customerId": "cust_123abc",
      "direction": "OUTBOUND",
      "sourceType": "EXTERNAL_WALLET",
      "sourceAddress": "0xabcdef1234567890abcdef1234567890abcdef12",
      "destType": "VAULT_ACCOUNT",
      "destAddress": "0x567890abcdef1234567890abcdef1234567890ab",
      "asset": "BTC",
      "amount": {
        "range": {
          "min": "1000",
          "max": "100000"
        },
        "currency": "USD"
      },
      "networkProtocol": "BITCOIN",
      "operation": "TRANSFER",
      "description": "Wait for TRM screening on inbound transactions",
      "validBefore": 1800,
      "validAfter": 1800
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.