Skip to main content
Stablecoin Account API Publisher Disclaimer Some incoming deposits require the sender’s (originator’s) Travel Rule information before they can proceed. The Deposit webhook tells you when: the event’s data includes "need_travel_rule": true. You can also use List Deposits or Retrieve Deposit to check the current requirement. The query responses always include need_travel_rule. A value of true means you must submit the deposit sender’s information; false means no submission is required. Unlike the webhook flag, which records the requirement when the event is created, the query value reflects the current order state and becomes false after the required information is submitted. Query responses also include travel_rule_status, with REJECTED, PENDING, APPROVED, or ON_HOLD when a Travel Rule status exists and null otherwise. Use need_travel_rule, not the status alone, to decide whether to prompt the user for information.

​
When you receive need_travel_rule: true

​
How deposit-sender entries are stored

Deposit-sender records are kept separately from your withdrawal address book. To review them, call List Address Book with address_kind=deposit_sender. Submitting again with the same source_address and network updates the existing entry rather than creating a duplicate.