Compliance

Creates a TravelRule message for a transfer

post/v1/domains/{domainId}/compliance/travel-rule/providers/{provider}/messages

Request

Base URL
https://docs.ripple.com (the document declares no server; this is the origin it was published from)
Auth
HTTP bearer
TypeScript
https://skmtc.dev/ripple/apis/ripple-custody-api/docs/v1/domains/:domainId/compliance/travel-rule/providers/:provider/messages/post.ts
A function with typed inputs. Its response is checked against the schema.

domainIdstring uuid required

provider'NOTABENE' required

assetstring required

Asset identifier (e.g., bip122:000000000019d6689c085ae165831e93/slip44:0)

amountstring required

Transfer amount

refstring required

Reference identifier for the transfer

settlementIdstring

Settlement identifier for the transfer

blockchainAnalyticsAliasstring

Optional analytics alias

{
  "transactionValue": {
    "amount": "150.75",
    "currency": "USD"
  },
  "blockchainAnalyticsAlias": "My Wallet"
}

suggestedIntentIdstring uuid

The intentId the client needs to initiate the intent with

complianceTravelRuleIdstring uuid

The id associated with this travel rule record on Compliance side

No recorded changes to this operation across all 3 revisions of this API.