Crypto Deposits and Withdrawals
SummaryExpanded support for crypto funding flows, enabling seamless deposits and withdrawals in crypto.Details
- New Capabilities: Introduced
bank-depositsandcrypto-deposits. The existingdepositscapability remains available for other deposit types. - Networks: Added
network.typetoList Networksas a validation hint for frontend integrations. - Quotes / Transactions: The
crypto-addressnode now includes anexecutionobject supporting three modes —onchain,offchain, andsimulated. Learn more about it here. - CDD for US Users: All users (including US users) will require to Update customer due diligence before making a crypto deposit or crypto withdrawal.
- Crypto Deposit Flow
- Crypto Withdrawal Flow
- Create Quote with node type
crypto-addressas destination - Transaction Schema with node
executionobject
- ⚠️ Update your integrations to read
destination.node.execution.transactionHashinstead ofdestination.node.transactionHash. - ❌ The old property will no longer return a value.
- 🔔 Ensure your app handles Customer Due Diligence for all users (including US users) before enabling crypto deposits or withdrawals.
Assets Cooldown Ended Webhook
SummaryIntroduced a new webhook that notifies platforms when a user’s asset cooldown period ends. This enables partners to update asset availability, unlock trading actions, and notify users in real-time, without relying on polling.DocumentationAction Required
- ✅ No changes needed if cooldown tracking is not required for your use case.
- 🔔 Subscribe to this webhook to refresh asset states and proactively notify users when cooldowns end.
Topper API
SummaryIntroduced the Topper API to enable KYC sharing between partners and the Topper Widget, allowing partners to complete the KYC of a Topper user directly via the Core API.Documentation
Portfolio Endpoints
SummaryIntroduced a group of endpoints to provide aggregated insights into a user’s financial position across all accounts.Documentation
FPS Deposits and Withdrawals
SummaryIntroduced support for deposits and withdrawals via the Faster Payments System (FPS).Documentation
- Added
Bankto the Network types. - Added
Bank (FPS)to the Account deposit methods. - Added
Bankto the external account types. - Added
unique-account-number-vibanto the list of Capabilities.
Asset Ordering
SummaryIntroduced support for sorting assets by various criteria, including market cap, price, and price variance. This enhancement enables partners to retrieve ordered asset lists from the API, eliminating the need for custom sorting logic.Documentation
Widgets API
SummaryIntroduced the Widgets API, enabling partners to create secure sessions for embedding Uphold widgets in their applications.Documentation
- Create session for the Payment Widget.
Core API
SummaryIntroduced the Core API, providing the foundational infrastructure for building financial applications on Uphold.Included Features
This initial release introduced all foundational components of the Core API, including:
- Authentication Endpoint to request access tokens using the OAuth2 protocol.
- Countries Endpoints to retrieve information about the supported countries.
- Users Endpoints to manage users, providing full CRUD capabilities and real-time webhooks to stay informed about user changes.
- KYC Endpoints to manage KYC processes, ensuring that users are compliant with regulatory requirements. It also includes webhooks to notify about KYC status changes in real time.
- Capabilities Endpoints to retrieve capabilities, the actions and features that users can perform on the platform.
- Terms of Service Endpoints to retrieve applicable Terms of Service and record user acceptance, ensuring compliance with legal requirements.
- Files Endpoints to generate upload and download links that support file-based KYC processes.
- Assets Endpoints to retrieve information about the assets available on the platform, as well as the networks and rails used to transfer them.
- Accounts Endpoints to manage users’ accounts, along with webhooks to asynchronously notify about account changes and balance updates.
- External Accounts Endpoints to link and manage financial accounts that users own outside the platform, such as debit or credit cards, enabling both pull deposits (moving funds into Uphold) and withdrawals (sending funds out of Uphold).
- Transactions Endpoints to initiate and retrieve transactions through a unified RFQ (Request for Quote) model, supporting deposits, withdrawals, trades, and transfers across multiple asset types, along with webhooks to notify about transaction changes.