Add Travel Rule documentation

[Prado]

Add Travel Rule documentation

This PR introduces documentation for the Travel Rule API, a regulatory requirement that mandates Virtual Asset Service Providers (VASPs) to collect and transmit originator and beneficiary information for cryptocurrency transfers above a defined threshold.

New: Travel Rule section (_travelrule.md)
A new top-level documentation section covers the full Travel Rule flow with three endpoints:

• Get Travel Rule Details for a Transaction (GET /v0/me/travel-rule/transactions/:transactionId/request) — Retrieves the pending travel rule request associated with a deposit transaction. Returns the transaction amount, the applicable regulatory threshold, and a dynamic formSchema describing what information needs to be submitted.

• Get Travel Rule Details (GET /v0/me/travel-rule/requests/:requestForInformationId) — Retrieves the pending travel rule request for a withdrawal, using the requestForInformationId returned as part of the quote response.

• Submit Travel Rule Information (POST /v0/me/travel-rule/requests/:requestForInformationId) — Submits the originator or beneficiary information required to fulfill the request. The body must conform to the formSchema from the corresponding GET endpoint. For withdrawals, this must be done before committing the quote.

The section includes context on when each endpoint applies (deposits vs. withdrawals), required OAuth scopes (transactions:read / transactions:write), and relevant error codes (401, 403, 404, 400).

Updated: Transaction Object (_entities.md)

• Added requirements and requirementsDetails to the Transaction Object property table, describing when and how they appear.

• Added a new Requirements Details subsection documenting the isAddressVerified, isRequired, and requestForInformationId fields that are present when a transaction is subject to the Travel Rule.

Updated: Transactions (_transactions.md)

• Added an example JSON snippet to the create transaction flow showing what the response looks like when the Travel Rule applies (includes requirements and requirementsDetails).

• Added a notice in the Step 1 (Create Transaction) section clarifying that if a withdrawal is subject to the Travel Rule, the requestForInformationId must be used to submit travel rule information before committing.

Internal, remove before merge:
https://uphold.atlassian.net/browse/BKO-6717
https://uphold.atlassian.net/browse/BKO-6718
https://uphold.atlassian.net/browse/BKO-6719

[Copilot]

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Adds documentation for the Travel Rule API so integrators can retrieve pending request details and submit the required information to proceed with withdrawals.

Changes:

• Added a new Travel Rule documentation page with endpoint descriptions.
• Included example curl requests and example JSON response including formSchema.
• Documented request/response expectations and basic authorization/ownership notes.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.