Compliance
Provides all the compliance details for the given screened transaction.

get/screening/transaction/{txId}
Request

Base URL
https://api.fireblocks.io/v1
Auth
none declared
TypeScript
https://skmtc.dev/fireblocks/apis/fireblocks-api/docs/screening/transaction/:txId/get.ts
A function with typed inputs. Its response is checked against the schema.
Path parameters

txIdstring required
Fireblocks transaction ID of the screened transaction
Response

A compliance object
Status of compliance result screening
Example response

{
  "aml": {
    "provider": "NOTABENE",
    "timestamp": 1753459111824,
    "screeningStatus": "COMPLETED",
    "bypassReason": "UNSUPPORTED_ASSET",
    "status": "COMPLETED",
    "prevStatus": "COMPLETED",
    "prevBypassReason": "BELOW_THRESHOLD",
    "verdict": "PASS",
    "risk": "lowRisk",
    "extendedRisk": "lowRisk",
    "externalId": "aml_screening_12345",
    "customerRefId": "customer_ref_789",
    "refId": "ref_12345",
    "category": "EXCHANGE",
    "categoryId": 5,
    "destAddress": "0xA2dC2490ED1DcA2D21613508fdb0c82daEAb0715",
    "destTag": "memo_12345",
    "destRecordId": "record_001",
    "addressResolutionSignature": "0x1234567890abcdef",
    "amlResult": {
      "alerts": [
        {
          "alertLevel": "HIGH",
          "alertName": "Sanctions Match",
          "category": "SANCTIONED_ENTITY",
          "service": "CHAINALYSIS",
          "externalId": "alert_12345",
          "alertAmount": 1000.5,
          "exposureType": "DIRECT",
          "policyAction": "BLOCK",
          "categoryId": 101
        }
      ],
      "matchedRule": {
        "ruleId": "rule_001",
        "ruleName": "High Risk Sanctions Check",
        "action": "ALLOW"
      },
      "matchedAlert": {
        "alertLevel": "HIGH",
        "alertName": "Sanctions Match",
        "category": "SANCTIONED_ENTITY",
        "service": "CHAINALYSIS",
        "externalId": "alert_12345",
        "alertAmount": 1000.5,
        "exposureType": "DIRECT",
        "policyAction": "BLOCK",
        "categoryId": 101
      }
    },
    "result": {
      "direction": "OUTBOUND",
      "isVerified": true,
      "action": "ACCEPT",
      "matchedRule": {
        "direction": "OUTBOUND",
        "status": "COMPLETED",
        "amountUSD": 1000.5,
        "amount": 0.025,
        "asset": "BTC",
        "action": "ACCEPT"
      }
    },
    "detailsMessage": "Travel rule screening completed successfully",
    "matchedPrescreeningRule": {
      "bypassReason": "MANUAL",
      "sourceType": "VAULT_ACCOUNT",
      "sourceSubType": "INTERNAL",
      "destType": "VAULT_ACCOUNT",
      "destSubType": "INTERNAL",
      "transferPeerType": "VAULT_ACCOUNT",
      "transferPeerSubType": "INTERNAL",
      "destAddress": "0xA2dC2490ED1DcA2D21613508fdb0c82daEAb0715",
      "sourceId": "0",
      "destId": "2",
      "asset": "ETH",
      "baseAsset": "ETH",
      "amount": 0.5,
      "amountUSD": 1000,
      "networkProtocol": "ETH",
      "operation": "TRANSFER",
      "action": "SCREEN"
    },
    "customerIntegrationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "customerShortName": "ACME Corp",
    "travelRuleMessageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "tr": {
    "provider": "NOTABENE",
    "timestamp": 1753459111824,
    "screeningStatus": "COMPLETED",
    "bypassReason": "UNSUPPORTED_ASSET",
    "status": "COMPLETED",
    "prevStatus": "COMPLETED",
    "prevBypassReason": "BELOW_THRESHOLD",
    "verdict": "PASS",
    "risk": "lowRisk",
    "extendedRisk": "lowRisk",
    "externalId": "aml_screening_12345",
    "customerRefId": "customer_ref_789",
    "refId": "ref_12345",
    "category": "EXCHANGE",
    "categoryId": 5,
    "destAddress": "0xA2dC2490ED1DcA2D21613508fdb0c82daEAb0715",
    "destTag": "memo_12345",
    "destRecordId": "record_001",
    "addressResolutionSignature": "0x1234567890abcdef",
    "amlResult": {
      "alerts": [
        {
          "alertLevel": "HIGH",
          "alertName": "Sanctions Match",
          "category": "SANCTIONED_ENTITY",
          "service": "CHAINALYSIS",
          "externalId": "alert_12345",
          "alertAmount": 1000.5,
          "exposureType": "DIRECT",
          "policyAction": "BLOCK",
          "categoryId": 101
        }
      ],
      "matchedRule": {
        "ruleId": "rule_001",
        "ruleName": "High Risk Sanctions Check",
        "action": "ALLOW"
      },
      "matchedAlert": {
        "alertLevel": "HIGH",
        "alertName": "Sanctions Match",
        "category": "SANCTIONED_ENTITY",
        "service": "CHAINALYSIS",
        "externalId": "alert_12345",
        "alertAmount": 1000.5,
        "exposureType": "DIRECT",
        "policyAction": "BLOCK",
        "categoryId": 101
      }
    },
    "result": {
      "direction": "OUTBOUND",
      "isVerified": true,
      "action": "ACCEPT",
      "matchedRule": {
        "direction": "OUTBOUND",
        "status": "COMPLETED",
        "amountUSD": 1000.5,
        "amount": 0.025,
        "asset": "BTC",
        "action": "ACCEPT"
      }
    },
    "detailsMessage": "Travel rule screening completed successfully",
    "matchedPrescreeningRule": {
      "bypassReason": "MANUAL",
      "sourceType": "VAULT_ACCOUNT",
      "sourceSubType": "INTERNAL",
      "destType": "VAULT_ACCOUNT",
      "destSubType": "INTERNAL",
      "transferPeerType": "VAULT_ACCOUNT",
      "transferPeerSubType": "INTERNAL",
      "destAddress": "0xA2dC2490ED1DcA2D21613508fdb0c82daEAb0715",
      "sourceId": "0",
      "destId": "2",
      "asset": "ETH",
      "baseAsset": "ETH",
      "amount": 0.5,
      "amountUSD": 1000,
      "networkProtocol": "ETH",
      "operation": "TRANSFER",
      "action": "SCREEN"
    },
    "customerIntegrationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "customerShortName": "ACME Corp",
    "travelRuleMessageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "amlList": [
    {
      "provider": "NOTABENE",
      "timestamp": 1753459111824,
      "screeningStatus": "COMPLETED",
      "bypassReason": "UNSUPPORTED_ASSET",
      "status": "COMPLETED",
      "prevStatus": "COMPLETED",
      "prevBypassReason": "BELOW_THRESHOLD",
      "verdict": "PASS",
      "risk": "lowRisk",
      "extendedRisk": "lowRisk",
      "externalId": "aml_screening_12345",
      "customerRefId": "customer_ref_789",
      "refId": "ref_12345",
      "category": "EXCHANGE",
      "categoryId": 5,
      "destAddress": "0xA2dC2490ED1DcA2D21613508fdb0c82daEAb0715",
      "destTag": "memo_12345",
      "destRecordId": "record_001",
      "addressResolutionSignature": "0x1234567890abcdef",
      "amlResult": {
        "alerts": [
          {
            "alertLevel": "HIGH",
            "alertName": "Sanctions Match",
            "category": "SANCTIONED_ENTITY",
            "service": "CHAINALYSIS",
            "externalId": "alert_12345",
            "alertAmount": 1000.5,
            "exposureType": "DIRECT",
            "policyAction": "BLOCK",
            "categoryId": 101
          }
        ],
        "matchedRule": {
          "ruleId": "rule_001",
          "ruleName": "High Risk Sanctions Check",
          "action": "ALLOW"
        },
        "matchedAlert": {
          "alertLevel": "HIGH",
          "alertName": "Sanctions Match",
          "category": "SANCTIONED_ENTITY",
          "service": "CHAINALYSIS",
          "externalId": "alert_12345",
          "alertAmount": 1000.5,
          "exposureType": "DIRECT",
          "policyAction": "BLOCK",
          "categoryId": 101
        }
      },
      "result": {
        "direction": "OUTBOUND",
        "isVerified": true,
        "action": "ACCEPT",
        "matchedRule": {
          "direction": "OUTBOUND",
          "status": "COMPLETED",
          "amountUSD": 1000.5,
          "amount": 0.025,
          "asset": "BTC",
          "action": "ACCEPT"
        }
      },
      "detailsMessage": "Travel rule screening completed successfully",
      "matchedPrescreeningRule": {
        "bypassReason": "MANUAL",
        "sourceType": "VAULT_ACCOUNT",
        "sourceSubType": "INTERNAL",
        "destType": "VAULT_ACCOUNT",
        "destSubType": "INTERNAL",
        "transferPeerType": "VAULT_ACCOUNT",
        "transferPeerSubType": "INTERNAL",
        "destAddress": "0xA2dC2490ED1DcA2D21613508fdb0c82daEAb0715",
        "sourceId": "0",
        "destId": "2",
        "asset": "ETH",
        "baseAsset": "ETH",
        "amount": 0.5,
        "amountUSD": 1000,
        "networkProtocol": "ETH",
        "operation": "TRANSFER",
        "action": "SCREEN"
      },
      "customerIntegrationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "customerShortName": "ACME Corp",
      "travelRuleMessageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ],
  "status": "Completed",
  "trlinkRegistration": {
    "status": "COMPLETED",
    "provider": "SUMSUB",
    "success": true,
    "timestamp": 1640995200000,
    "destRecordId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "travelRuleMessageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "customerIntegrationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "customerShortName": "ACME Corp",
    "matchedPrescreeningRule": {
      "customerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "direction": "OUTBOUND",
      "sourceType": "VAULT_ACCOUNT",
      "sourceSubType": "INTERNAL",
      "sourceAddress": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
      "destType": "VAULT_ACCOUNT",
      "destSubType": "INTERNAL",
      "destAddress": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
      "sourceId": "1",
      "destId": "1",
      "asset": "BTC",
      "baseAsset": "USD",
      "amount": {
        "range": {
          "min": "100",
          "max": "10000"
        },
        "currency": "USD"
      },
      "networkProtocol": "BITCOIN",
      "operation": "TRANSFER",
      "description": "Rule for high-value BTC transfers",
      "action": "SCREEN"
    }
  },
  "trlinkDestinations": [
    {
      "provider": "SUMSUB",
      "timestamp": 1640995200000,
      "verdict": "ACCEPT",
      "destAddress": "0xA2dC2490ED1DcA2D21613508fdb0c82daEAb0715",
      "destTag": "memo_12345",
      "bypassReason": "MANUAL",
      "detailsMessage": "Screening completed successfully",
      "customerIntegrationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "customerShortName": "ACME Corp",
      "travelRuleMessageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "result": {
        "matchedRule": {
          "customerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "direction": "OUTBOUND",
          "sourceType": "VAULT_ACCOUNT",
          "sourceSubType": "INTERNAL",
          "sourceAddress": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
          "destType": "VAULT_ACCOUNT",
          "destSubType": "INTERNAL",
          "destAddress": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
          "sourceId": "1",
          "destId": "1",
          "asset": "BTC",
          "baseAsset": "USD",
          "amount": {
            "range": {
              "min": "100",
              "max": "10000"
            },
            "currency": "USD"
          },
          "networkProtocol": "BITCOIN",
          "operation": "TRANSFER",
          "description": "Rule for high-value BTC transfers",
          "providerIdent": "sumsub",
          "trmStatus": "ACCEPTED",
          "validBefore": 1800,
          "validAfter": 1800,
          "action": "ACCEPT"
        }
      },
      "matchedPrescreeningRule": {
        "customerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "direction": "OUTBOUND",
        "sourceType": "VAULT_ACCOUNT",
        "sourceSubType": "INTERNAL",
        "sourceAddress": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
        "destType": "VAULT_ACCOUNT",
        "destSubType": "INTERNAL",
        "destAddress": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
        "sourceId": "1",
        "destId": "1",
        "asset": "BTC",
        "baseAsset": "USD",
        "amount": {
          "range": {
            "min": "100",
            "max": "10000"
          },
          "currency": "USD"
        },
        "networkProtocol": "BITCOIN",
        "operation": "TRANSFER",
        "description": "Rule for high-value BTC transfers",
        "action": "SCREEN"
      },
      "matchedNoTrmScreeningRule": {
        "customerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "direction": "OUTBOUND",
        "sourceType": "VAULT_ACCOUNT",
        "sourceSubType": "INTERNAL",
        "sourceAddress": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
        "destType": "VAULT_ACCOUNT",
        "destSubType": "INTERNAL",
        "destAddress": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
        "sourceId": "1",
        "destId": "1",
        "asset": "BTC",
        "baseAsset": "USD",
        "amount": {
          "range": {
            "min": "100",
            "max": "10000"
          },
          "currency": "USD"
        },
        "networkProtocol": "BITCOIN",
        "operation": "TRANSFER",
        "description": "Rule for high-value BTC transfers",
        "validBefore": 1800,
        "validAfter": 1800,
        "action": "WAIT",
        "source": "policy",
        "timestamp": "2023-10-05T14:48:00.000Z",
        "reason": "Missing travel rule message"
      }
    }
  ]
}
Changes

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