Create Travel Rule Message

post

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

Creates a new travel rule message with IVMS101-compliant PII data. Encrypts sensitive originator and beneficiary information before sending to partner.

Path Params

customerIntegrationId

uuid

required

Customer integration unique identifier

Body Params

Request to create a Travel Rule Message with IVMS101 PII data

assetId

string | null

Asset identifier (required when txId not provided)

amount

string | null

Transaction amount (required when txId not provided)

amountUSD

string | null

Amount in USD (optional)

source

object

Source peer path for transaction

srcAddress

string | null

Source address (optional)

destination

object

Destination peer path for transaction

destAddress

string | null

Destination address (optional)

destTag

string | null

Destination tag (optional)

txId

uuid | null

Fireblocks transaction ID (optional) - RECOMMENDED for inbound transactions

txHash

string | null

Transaction hash (optional)

direction

string

enum

Transaction direction from workspace perspective

Allowed:

originatorVaspId

string | null

Originator VASP identifier - required for inbound transactions

beneficiaryVaspId

string | null

Beneficiary VASP identifier - required for outbound transactions

ivms101

object

required

IVMS101 data structure containing encrypted PII

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.

Responses

201TRM created successfully

defaultError Response