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

TypeScript

TypeScript

const response: Promise<FireblocksResponse<TRLinkAssessTravelRuleResponse>> = fireblocks.tRLink.assessTRLinkTravelRuleRequirement(tRLinkApiAssessTRLinkTravelRuleRequirementRequest);

200

{
  "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"
  }
}

Headers

Idempotency-Key · string

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.

Path Parameters

customerIntegrationId · string<uuid> · required

Customer integration unique identifier

Body

application/json

Request to assess whether Travel Rule compliance is required for a transaction

txId · string<uuid> | null

Fireblocks transaction ID (optional) - RECOMMENDED for inbound transactions

Example:

"550e8400-e29b-41d4-a716-446655440000"

amount · string | null

Transaction amount (required when txId not provided)

Example:

"1000"

amountUSD · string | null

Transaction amount in USD (optional)

Example:

"1000.50"

destination · object

Destination peer path for transaction

Show child attributes

destAddress · string | null

Destination address (optional)

Example:

"0x8d12A197cB00D4747a1fe03395095ce2A5CC6819"

destTag · string | null

Destination tag (optional)

Example:

"1234567890"

source · object

Source peer path for transaction

Show child attributes

srcAddress · string | null

Source address (optional)

Example:

"0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb"

assetId · string | null

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

Example:

"USDT_ERC20"

direction · enum<string>

Transaction direction from workspace perspective

Available options: INBOUND, OUTBOUND

Example:

"OUTBOUND"

txHash · string | null

Transaction hash (optional)

Example:

"0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef"

originatorVaspId · string | null

Originator VASP identifier - required for inbound transactions

Example:

"did:ethr:0x1234567890abcdef"

beneficiaryVaspId · string | null

Beneficiary VASP identifier - required for outbound transactions

Example:

"did:ethr:0xfedcba0987654321"

Response

200

application/json

Travel rule assessment completed

Response indicating whether Travel Rule compliance is required

decision · enum<string> · required

Decision about Travel Rule applicability

Available options: REQUIRED, NOT_REQUIRED, NEED_MORE_INFO

Example:

"REQUIRED"

reason · string · required

Explanation of the decision

Example:

"Transaction amount exceeds Travel Rule threshold for this jurisdiction"

requiredFields · string[] | null

List of required fields if Travel Rule is required

Example:

[
  "originator.name",
  "originator.address",
  "beneficiary.name",
  "beneficiary.address"
]

missingInfo · string[] | null

List of missing fields if more information is needed

Example:

[
  "beneficiary.nationalIdentification",
  "beneficiary.dateOfBirth"
]

thresholds · object

Show child attributes