Assess Travel Rule requirement

POST

screening

trlink

customers

integration

{customerIntegrationId}

trm

assess

TypeScript

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

curl --request POST \
  --url https://api.fireblocks.io/v1/screening/trlink/customers/integration/{customerIntegrationId}/trm/assess \
  --header 'Content-Type: application/json' \
  --data '
{
  "txId": "550e8400-e29b-41d4-a716-446655440000",
  "amount": "1000",
  "amountUSD": "1000.50",
  "destAddress": "0x8d12A197cB00D4747a1fe03395095ce2A5CC6819",
  "destTag": "1234567890",
  "srcAddress": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
  "assetId": "USDT_ERC20",
  "direction": "OUTBOUND",
  "txHash": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
  "originatorVaspId": "did:ethr:0x1234567890abcdef",
  "beneficiaryVaspId": "did:ethr:0xfedcba0987654321"
}
'

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    txId: '550e8400-e29b-41d4-a716-446655440000',
    amount: '1000',
    amountUSD: '1000.50',
    destAddress: '0x8d12A197cB00D4747a1fe03395095ce2A5CC6819',
    destTag: '1234567890',
    srcAddress: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb',
    assetId: 'USDT_ERC20',
    direction: 'OUTBOUND',
    txHash: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef',
    originatorVaspId: 'did:ethr:0x1234567890abcdef',
    beneficiaryVaspId: 'did:ethr:0xfedcba0987654321'
  })
};

fetch('https://api.fireblocks.io/v1/screening/trlink/customers/integration/{customerIntegrationId}/trm/assess', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fireblocks.io/v1/screening/trlink/customers/integration/{customerIntegrationId}/trm/assess",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'txId' => '550e8400-e29b-41d4-a716-446655440000',
    'amount' => '1000',
    'amountUSD' => '1000.50',
    'destAddress' => '0x8d12A197cB00D4747a1fe03395095ce2A5CC6819',
    'destTag' => '1234567890',
    'srcAddress' => '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb',
    'assetId' => 'USDT_ERC20',
    'direction' => 'OUTBOUND',
    'txHash' => '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef',
    'originatorVaspId' => 'did:ethr:0x1234567890abcdef',
    'beneficiaryVaspId' => 'did:ethr:0xfedcba0987654321'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fireblocks.io/v1/screening/trlink/customers/integration/{customerIntegrationId}/trm/assess"

	payload := strings.NewReader("{\n  \"txId\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"amount\": \"1000\",\n  \"amountUSD\": \"1000.50\",\n  \"destAddress\": \"0x8d12A197cB00D4747a1fe03395095ce2A5CC6819\",\n  \"destTag\": \"1234567890\",\n  \"srcAddress\": \"0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb\",\n  \"assetId\": \"USDT_ERC20\",\n  \"direction\": \"OUTBOUND\",\n  \"txHash\": \"0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef\",\n  \"originatorVaspId\": \"did:ethr:0x1234567890abcdef\",\n  \"beneficiaryVaspId\": \"did:ethr:0xfedcba0987654321\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.fireblocks.io/v1/screening/trlink/customers/integration/{customerIntegrationId}/trm/assess")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"txId\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"amount\": \"1000\",\n  \"amountUSD\": \"1000.50\",\n  \"destAddress\": \"0x8d12A197cB00D4747a1fe03395095ce2A5CC6819\",\n  \"destTag\": \"1234567890\",\n  \"srcAddress\": \"0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb\",\n  \"assetId\": \"USDT_ERC20\",\n  \"direction\": \"OUTBOUND\",\n  \"txHash\": \"0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef\",\n  \"originatorVaspId\": \"did:ethr:0x1234567890abcdef\",\n  \"beneficiaryVaspId\": \"did:ethr:0xfedcba0987654321\"\n}"

response = http.request(request)
puts response.read_body

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

{
  "message": "<string>",
  "code": 123
}

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

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

⌘I

TypeScript

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

curl --request POST \
  --url https://api.fireblocks.io/v1/screening/trlink/customers/integration/{customerIntegrationId}/trm/assess \
  --header 'Content-Type: application/json' \
  --data '
{
  "txId": "550e8400-e29b-41d4-a716-446655440000",
  "amount": "1000",
  "amountUSD": "1000.50",
  "destAddress": "0x8d12A197cB00D4747a1fe03395095ce2A5CC6819",
  "destTag": "1234567890",
  "srcAddress": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
  "assetId": "USDT_ERC20",
  "direction": "OUTBOUND",
  "txHash": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
  "originatorVaspId": "did:ethr:0x1234567890abcdef",
  "beneficiaryVaspId": "did:ethr:0xfedcba0987654321"
}
'

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    txId: '550e8400-e29b-41d4-a716-446655440000',
    amount: '1000',
    amountUSD: '1000.50',
    destAddress: '0x8d12A197cB00D4747a1fe03395095ce2A5CC6819',
    destTag: '1234567890',
    srcAddress: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb',
    assetId: 'USDT_ERC20',
    direction: 'OUTBOUND',
    txHash: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef',
    originatorVaspId: 'did:ethr:0x1234567890abcdef',
    beneficiaryVaspId: 'did:ethr:0xfedcba0987654321'
  })
};

fetch('https://api.fireblocks.io/v1/screening/trlink/customers/integration/{customerIntegrationId}/trm/assess', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fireblocks.io/v1/screening/trlink/customers/integration/{customerIntegrationId}/trm/assess",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'txId' => '550e8400-e29b-41d4-a716-446655440000',
    'amount' => '1000',
    'amountUSD' => '1000.50',
    'destAddress' => '0x8d12A197cB00D4747a1fe03395095ce2A5CC6819',
    'destTag' => '1234567890',
    'srcAddress' => '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb',
    'assetId' => 'USDT_ERC20',
    'direction' => 'OUTBOUND',
    'txHash' => '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef',
    'originatorVaspId' => 'did:ethr:0x1234567890abcdef',
    'beneficiaryVaspId' => 'did:ethr:0xfedcba0987654321'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fireblocks.io/v1/screening/trlink/customers/integration/{customerIntegrationId}/trm/assess"

	payload := strings.NewReader("{\n  \"txId\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"amount\": \"1000\",\n  \"amountUSD\": \"1000.50\",\n  \"destAddress\": \"0x8d12A197cB00D4747a1fe03395095ce2A5CC6819\",\n  \"destTag\": \"1234567890\",\n  \"srcAddress\": \"0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb\",\n  \"assetId\": \"USDT_ERC20\",\n  \"direction\": \"OUTBOUND\",\n  \"txHash\": \"0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef\",\n  \"originatorVaspId\": \"did:ethr:0x1234567890abcdef\",\n  \"beneficiaryVaspId\": \"did:ethr:0xfedcba0987654321\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.fireblocks.io/v1/screening/trlink/customers/integration/{customerIntegrationId}/trm/assess")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"txId\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"amount\": \"1000\",\n  \"amountUSD\": \"1000.50\",\n  \"destAddress\": \"0x8d12A197cB00D4747a1fe03395095ce2A5CC6819\",\n  \"destTag\": \"1234567890\",\n  \"srcAddress\": \"0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb\",\n  \"assetId\": \"USDT_ERC20\",\n  \"direction\": \"OUTBOUND\",\n  \"txHash\": \"0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef\",\n  \"originatorVaspId\": \"did:ethr:0x1234567890abcdef\",\n  \"beneficiaryVaspId\": \"did:ethr:0xfedcba0987654321\"\n}"

response = http.request(request)
puts response.read_body

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

{
  "message": "<string>",
  "code": 123
}

Introduction

Errors & Statuses

API Endpoints

Data Objects

Headers

Path Parameters

Body

Response