Sign in

v1

latestOpenAPI 3.1.02026-07-26165182724.7 KB
Counterparty

Set travel rule options for a user

Sets per-account Travel Rule options that skip per-address declarations. Intended to be called at account-setup time for integrators who can attest that a user transacts exclusively with their own wallets, but may be called at any time to toggle individual flags.

Provide exactly one of userId / businessId. At least one flag must be present. Omitting a flag leaves its current value unchanged.

Wallet ownership verification still applies at or above the EUR threshold — the flags only remove the obligation to declare an address before each transaction.

post/travel-rule-options

Request body

userIdstring uuid

Owner user id. Provide exactly one of userId / businessId.

businessIdstring uuid

Owner business id. Provide exactly one of userId / businessId.

onChainDepositsFromOwnWalletsOnlyboolean

When true, on-chain deposits for this account are treated as coming from a wallet the user owns — no per-deposit address declaration required. Wallet ownership verification still applies at or above the EUR threshold.

lightningDepositsFromOwnWalletsOnlyboolean

When true, Lightning deposits for this account are treated as coming from a wallet the user owns — no per-payment declaration required.

onChainWithdrawalsToOwnWalletsOnlyboolean

When true, on-chain withdrawals for this account are treated as going to a wallet the user owns — no per-withdrawal address declaration required. Wallet ownership verification still applies at or above the EUR threshold.

lightningWithdrawalsToOwnWalletsOnlyboolean

When true, Lightning withdrawals for this account are treated as going to a wallet the user owns — no per-payment declaration required.

Response

Options updated. Returns only the flags that were set in this request.

Example response

{
  "tfrOptions": {
    "onChainDepositsFromOwnWalletsOnly": true,
    "lightningDepositsFromOwnWalletsOnly": true
  }
}