Skip to main content
The Travel Rule widget is a fully Uphold-managed, embeddable solution that enables compliant collection and exchange of originator and beneficiary information for crypto transactions — ensuring adherence to FATF Recommendation 16 and global Travel Rule regulations.

​
Features

FATF Travel Rule Compliance

Automates collection and exchange of originator and beneficiary information.

Multi-Platform Embedding

Embeds seamlessly into web and native apps.

Real-Time Event Handling

Emits lifecycle events to integrate with your application flow.

Rapid SDK Integration

Lightweight SDK to instantiate and control the widget.

​
Using the widget

The Travel Rule widget is designed to be embedded into your application to collect required information from users during crypto transactions.

​
Installation

The widget is available as an npm package for web applications. For detailed installation and setup instructions, see Installation and Setup.

​
Integration

To integrate the widget into your application:
  1. Create a widget session using the Create Session endpoint
  2. Initialize the widget with the session data
  3. Handle lifecycle events (complete, cancel, error)
  4. Submit the collected data
For a complete API reference, see SDK Reference.
The widget supports both web applications (via iframe) and native applications (via WebView). See Native App Integration for platform-specific guidance.

​
When to use the widget

The widget was specifically designed to address Travel Rule compliance requirements during crypto transactions.

​
Quote requirements

When creating a quote for a crypto withdrawal, the response may include a travel-rule requirement indicating that Travel Rule information must be collected before the transaction can be executed. For a complete example, see the Quote Requirements flow.

​
Transaction RFIs

When a crypto deposit transaction is placed on hold with a travel-rule request for information (RFI), the widget must be used to collect the required information to allow the transaction to proceed. For a complete example, see the Transaction RFIs flow.