FIfireblocks
TRLink

Assess Travel Rule requirement

Assesses travel rule requirement for a transaction by validating stored credentials and determining whether Travel Rule compliance is required based on amount, jurisdiction, and partner thresholds.

post/screening/trlink/customers/integration/{customerIntegrationId}/trm/assess

Request

Path parameters

customerIntegrationIdstring uuid required

Customer integration unique identifier

Headers

Idempotency-Keystring

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.

Request body

txIdstring uuid nullable

Fireblocks transaction ID (optional) - RECOMMENDED for inbound transactions

amountstring nullable

Transaction amount (required when txId not provided)

amountUSDstring nullable

Transaction amount in USD (optional)

destAddressstring nullable

Destination address (optional)

destTagstring nullable

Destination tag (optional)

srcAddressstring nullable

Source address (optional)

assetIdstring nullable

Asset identifier (e.g., ETH, BTC, USDC)

direction'INBOUND' | 'OUTBOUND'

Transaction direction from workspace perspective

txHashstring nullable

Transaction hash (optional)

originatorVaspIdstring nullable

Originator VASP identifier - required for inbound transactions

beneficiaryVaspIdstring nullable

Beneficiary VASP identifier - required for outbound transactions

Example request

{
  "txId": "550e8400-e29b-41d4-a716-446655440000",
  "amount": "1000",
  "amountUSD": "1000.50",
  "destination": {
    "type": "ONE_TIME_ADDRESS",
    "id": "45",
    "walletId": "0",
    "oneTimeAddress": {
      "address": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
      "tag": "1234567890"
    }
  },
  "destAddress": "0x8d12A197cB00D4747a1fe03395095ce2A5CC6819",
  "destTag": "1234567890",
  "source": {
    "type": "VAULT_ACCOUNT",
    "id": "12",
    "walletId": "0"
  },
  "srcAddress": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
  "assetId": "USDT_ERC20",
  "direction": "OUTBOUND",
  "txHash": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
  "originatorVaspId": "did:ethr:0x1234567890abcdef",
  "beneficiaryVaspId": "did:ethr:0xfedcba0987654321"
}

Response

Travel rule assessment completed

decision'REQUIRED' | 'NOT_REQUIRED' | 'NEED_MORE_INFO' required

Decision about Travel Rule applicability

reasonstring required

Explanation of the decision

requiredFieldsstring[] nullable

List of required fields if Travel Rule is required

missingInfostring[] nullable

List of missing fields if more information is needed

Example response

{
  "decision": "REQUIRED",
  "reason": "Transaction amount exceeds Travel Rule threshold for this jurisdiction",
  "requiredFields": [
    "originator.name",
    "originator.address",
    "beneficiary.name",
    "beneficiary.address"
  ],
  "missingInfo": [
    "beneficiary.nationalIdentification",
    "beneficiary.dateOfBirth"
  ],
  "thresholds": {
    "amount": "1000",
    "currency": "USD"
  }
}

Changes

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