Jump to Content
Documentation
Recipes
API Reference
Release Notes
Legal
Log In
Portal
API Reference
Log In
Portal
Documentation
Recipes
API Reference
Release Notes
Legal
Kotlin
JUMP TO
zerohash API
API Authentication
Public
Get server time
get
Deposits
Submit Travel Rule information for a crypto deposit
post
CORE RESOURCES
Participants
Individual Participants
Create customer
post
Update customer
patch
Submit documents
post
Lock customer
post
Beneficiary Participants
Create beneficiary
post
Update beneficiary
patch
Entity Participants
Create entity customer
post
Update entity customer
patch
Submit entity documents
post
Entity User Managment
Update entity user
patch
Get participant user basic info
get
Entity User Details
Get participant user full info
get
Get participant user sanction screening info
get
Query Participants
Get participant
get
List participants
get
Get participant basic info
get
Participant Limits
Update participant limits
patch
Get participant limits
get
Participant Jurisdictions
List countries
get
List subdivisions
get
Evaluate participant onboarding
post
Participant Details
Get participant sanction screening info
get
Get participant full info
get
Get participant KYC status
get
Get participant document metadata
get
Download participant document
get
Accounts
Get account
get
List accounts
get
Account Movements
List movements
get
List account movements
get
List account run history
get
List NDOs
get
Customer Accounts (MTA)
Account Opening
Create customer account
post
Get account details
get
Update customer account
patch
Tenant Management
Add tenant to customer account
post
Remove tenant from customer account
del
Advisor Management
Add advisor to customer account
post
Remove advisor from customer account
del
Account Administration
Withdraw lock customer account
post
Withdraw unlock customer account
post
Lock customer account
post
Unlock customer account
post
Divest customer account
post
Close customer account
post
Deposits
Blockchain Addresses
Create deposit address
post
Update address owner
patch
List deposit addresses
get
Blockchain Deposits
Get crypto deposit by ID
get
List crypto deposits
get
Universal Money Addresses (UMA)
Create UMA address
post
List UMA addresses
get
Update UMA address
patch
BOLT11
Create a BOLT11 invoice for deposit
post
Create a test payment for a BOLT11 deposit invoice
post
Management
List deposits
get
List fiat accounts
get
CERT Only
Fund account
post
Withdrawals
Request
Create withdrawal request
post
Get withdrawal request
get
Delete withdrawal request
del
Get withdrawal requests
get
Locked Network Fee
Get withdrawal quote
get
Execute withdrawal
post
Get network fee estimate
get
Universal Money Address (UMA)
Request UMA Withdrawal
post
Performs an UMA lookup prior to initiating a withdrawal
get
Blockchain
Get withdrawal addresses
get
Get withdrawal address
get
Validate address
get
Fiat
Get fiat accounts
get
Get fiat account
get
Assets
List assets
get
Get asset staking information
get
Transfers
Create transfer
post
List transfers
get
Get transfer
get
TRADING
External Market Data
News
List news articles
get
List news feeds
get
List categories
get
Symbol Data
List symbol data
get
List OHLCV data
get
Index
List index prices
get
Staking
Stake Management
Create a new stake
post
Cancel a stake
post
Get stake status
get
Get staking summary
get
List staking rewards
get
List participant stakes
get
Unstake Management
Cancel an unstake
post
Unstake assets
post
Get unstake status
get
Positions
List positions
get
List platform positions
get
List participant positions
get
Trades
Query Trades
Get trade
get
Get trades
get
Post Trade Settlement
Submit trade
post
Submit batch of trades
post
Request For Quote
Get quote
post
Update quote
patch
Execute quote
post
Portfolio Strategies
Strategy Management
Create a Strategy
post
Update a Strategy's metadata
patch
List Strategies
get
Get a Strategy
get
Traders
Update a Trader's settings
patch
List Traders
get
Get a Trader
get
Operations
Rebalance
post
Enroll participants
post
Top up participants
post
Partial sell
post
Liquidate participants
post
List Operations
get
Get an Operation
get
Executions
List Executions
get
Get an Execution
get
Central Limit Order Book
Account Management
Create account (CLOB)
post
List accounts (CLOB)
get
Update CLOB account
patch
Get account balance
post
List account balances
post
Order Management
Submit order
post
Create order subscription
post
List open orders
post
List orders
post
Get order executions
post
Cancel order
post
Market Data
Market data subscription
post
List instruments
post
Get trade stats
post
Rewards
Disperse rewards
post
Awards
Fund awards account
post
Distribute awards
post
TRANSACT
Convert and Withdraw
Get quote
post
Execute quote
post
Payments
Manage Payments
Create payment
post
Retry a fiat payment
post
List pending ACH settlements
get
List fiat transaction statuses
get
List fiat transaction history
get
Manage External Accounts
Create external account
post
List external accounts
get
Close external account
post
ACH powered RFQ
Request payment quote
post
Execute payment quote
post
Query Payments
Get payment by id
get
List payments
get
Account Funding
Account Funding Deposits
Get quote
post
List transactions
get
Create deposit
post
Payins
Get payin authorization limits
get
Request a payin quote
post
Refresh a payin quote
post
List payin transactions
get
Cancel a pending manual approval
del
Payouts
Retrieve payout state
get
Submit or validate a payout
post
SDK
Changelog
Overview
Installation
Getting Started
Modules
User Onboarding
Acquire an onboarding access token
Verification results
Iframe integration - Permissions
Crypto Buy
Profile
Crypto Sell
Crypto Withdrawals
Fiat Deposits
Fiat Withdrawals
Fund
Fiat Account Link
Crypto Account Link
Pay
Integration with Mobile Apps
Flutter
Kotlin
React Native
Swift
SDK Mappers
SDK Authorization
Generate a client access token
post
Revoke a client access token
post
Webhooks
Overview
Webhook Security
Participants
Participant status updates
Participant onboarding status update
Payments
Payments status updates
External account status updates
Account Funding
Account Funding Transaction Updates
Payins
Payin Transaction Updates
Assets
Asset price change updates
Accounts
Account Balance update
Customer Account status update
Trades
Trade Status update
Portfolio Strategies
Portfolio Strategy Operations
Portfolio Strategy Executions
Portfolio Strategy Traders
Deposits
Deposit status updates
Connect
(BETA) Streamlined Payouts Webhooks
websockets
Private Websocket API
Authentication
Balance Subscription
Initial Subscription
Balance Updates
Subscription Filters
Price Subscription
List Symbols
Subscribing to a Symbol
Price Updates
Maintaining Subscription
FIX API
Central Limit Order Book
Session Level Messages
Standard Headers
Standard Trailers
Login (35=A)
Logout (35=5)
Heartbeat (35=0)
Reject (35=3)
FIX Order Entry
New Order Single (35=D)
Order Cancel Request (35=F)
Cancel Replace (35=G)
Order Cancel Reject (35=9)
Execution Report (35=8)
Business Message Reject (35=j)
FIX Market Data
Securities Request List (35=x)
Security List (35 = y)
Market Data Request (35=V)
Market Data Snapshot (W)
Market Data Incremental Refresh (35=X)
Drop Copy Message
Execution Report (35=8)
Appendix
Instrument
Order Quantity
Parties
MDFullGrp
FIX 5.0 XML Files - Order Gateway
FIX 5.0 XML Files - Market Data Gateway
FIX Rejects Reasons
Session Management (CLOB)
Straight Through Processing
Connect
Organization Token
Generate access token
post
User Token
Initialize session
post
Kotlin
Copy Page
Updated 4 months ago
Flutter
React Native
Did this page help you?
Yes
No
Updated 4 months ago
Flutter
React Native
Did this page help you?
Yes
No
Overview
Prerequisites
WebView Configuration
Handling SDK Messages
Loading the SDK-Mobile URL
Onboarding SDK Permissions
Additional Considerations
