View Menu
Dark Mode
Ctrl+K
Overview
BitGo Products
Get BitGo Products Configuration
List BitGo Products
Counterparties
Add Block List Entry
Add Go Account connection
Bulk add Go Account connections
Create enterprise listing
Create enterprise listing entry
Delete Block List Entry
Get Block Lists
Get enterprise listing
List Go Account connections
List counterparties
List entries available for connection
List entry contacts
Update Go Account entry
Update connection status
Update enterprise listing
Enterprise
Audit log
List audit logs
Enterprise
Freeze the enterprise
Get enterprise
Get enterprise MPC config
Get enterprise regional features
Get enterprise user signing key
Get enterprise's wallet limits
Get gas tank balance
List available assets
List enterprise users
List enterprises
Opt out of points system
Remove user from enterprise
Update enterprise
Update enterprise ECDSA MPC challenge
Enterprise Webhooks
Create enterprise webhook
Delete enterprise webhook
List enterprise webhooks
Simulate bank account webhook
Simulate enterprise webhook
Reports
Download report
Generate org-level report
Generate report
Get report
List org-level reports
List reports
User
Add user to enterprise
Create access token
Create access token template
Delete access token
Delete access token template
Freeze User
Get Recovery Codes
Get access token template
Get another users public key for wallet sharing
Get session
Get user
List access token templates
List access tokens
Lock session
Login
Login Request
Logout
Unlock session
Update access token template
Validate Password Reset Token
Fiat
ACH Debits
Create a bank transfer
Get ACH agreement
Get ACH authorization language
Get a bank transfer
Initiate ACH deposit
List enterprise transfer limits
Bank Accounts
Add bank account
Delete bank account
Get address format information
Get bank account
Get deposit info
List bank accounts
Update bank account
Verify routing number by bank type
Fiat
Get deposit information [DEPRECATED]
Plaid
Create Plaid Link token
Exchange Plaid Public Token
Identity
Identity Verification (IDV)
Get Sumsub IDV status
Initiate Sumsub IDV for a user
Know Your Business (KYB)
Add KYB Documents
Add KYB Documents
Create KYB Identity
Delete KYB Document
Get KYB Document
Get KYB Identity
List KYB Documents
List KYB Identities
Update KYB Document
Update KYB Document Status
Update KYB Identity
Verify KYB Document Status
Know Your Customer (KYC)
Add KYC Documents
Create KYC Identity
Get KYC Document
Get KYC Identity
Submit KYC Signatures
Update KYC Document
Update KYC Identity
Organization
Enterprise Management
Add a user to an enterprise within an organization
Create an enterprise for an organization
List enterprises for an organization
List enterprises for an organization
Sign a contract for an enterprise within an organization
Organization Management
Create search history item
Delete a search history item
Get child enterprise
Get org trade order
Get org transfer
Get user by id
Global search across the organization
List asset balances
List org activity timeline
List org search history
List org trade order fills
List org trade orders
List org trade products
List org transfer timeline
List org transfers
List users across the organization
Organization Webhooks
Create organization webhook
Delete organization webhook
Get organization webhook
List organization webhooks
List webhook notification for an organization
Simulate organization webhook
User Management
Add a user to an organization
List User Organizations
Remove a user from an organization
Update users role in an enterprise
Update users role in organization
Webhook Keys
List webhook signing keys
Register a webhook signing key
Revoke a webhook signing key
Policy
Policy Builder
Create policy rule
Deactivate policy rule
Get policy rule
List actions
List conditions for scope
List conditions for touchpoint
List organization policy rules
List policy rules
List policy-rule versions
List scopes
List touchpoints
Update organization policy rule
Update policy rule
Wallet Policy
Add wallet-policy rule
Bulk update wallet policy rules
Delete wallet-policy rule
Update wallet-policy rule
Settle (DVP)
Settlement Approvals
List pending approval requests for settlements
Update settlement approval request
Settlement Onboarding
Get settlement settings
List settlement trading partners (counterparties)
Update settlement settings
Settlement Signing
Get settlement payload
Sign settlement
Settlements
Bulk terminate settlements
Create settlement
Get Go Account balance for settlements
Get batch settlement payload
Get settlement by ID
List settlements by Go Account
List settlements by enterprise
Settle (Off Exchange)
Client Activation
Connect to partner
Create client
Get Client Connection
Get Signing Payload for Client Connections
Get Signing Payload for Client Connections (Post variant)
List Partners
List client connections
Update Client Connection
Client Allocations & Deallocations
Allocate funds to partner connection
Deallocate Funds from Connection
Get Signing Payload for Client Allocations
Get Signing Payload for Client Allocations (Post variant)
Get Signing Payload for Client Deallocations
Get Signing Payload for Client Deallocations (Post variant)
Get client allocation or deallocation
List Partner-Supported Currencies
List client allocations and deallocations
Client Balances
List client balances
Client Settlements & Transfers
Get Client Settlement
List Client Settlements
List client settlement transfers
Onboarding
Create Partner
Partner Activation
Get Partner Connection
List Partner Connections
Partner Allocations & Deallocations
Get partner allocation or deallocation
List partner allocations and deallocations
Update Partner Allocations
Update Partner Deallocations
Partner Balances
List partner balances
Partner Settlements & Transfers
Get Partner Settlement
Get Signing Payload for Partner External Deposits
Get Signing Payload for Partner Settlement
Get Signing Payload for Partner Settlement (Post variant)
Initiate On-Chain Settlement
Initiate partner settlement
List Partner Settlements
Perform Partner Settlement
Post deposit info for an on-chain settlement
[DEPRECATED] Perform Partner Settlement
Partner Trades
Get Signing Payload for Partner Trades
Settlement Disputes
Close a dispute
Dispute a Settlement
List Settlement Disputes for a Client
List Settlement Disputes for a Partner
Update a Settlement Dispute
Stablecoin
Accept Minting Terms
Create stablecoin order
Get Token Constants
Get cross-chain total supply for a token
Get orders summary for enterprise
Get stablecoin order by ID
List stablecoin orders by enterprise
List supported assets
Stake
Go Account Staking (beta)
Finalize staking request for Go Account
Generate staking request for Go Account
Get staking request for Go Account
Get staking wallet attributes for Go Account
List staking requests by asset for Go Account
List staking requests for Go Account
List staking rewards by asset for Go Account
List staking rewards for Go Account
List staking wallets for Go Account
List supported coins
Staking History
Get staking accrual history
Get staking reward history
Staking Request
Cancel staking request
Create staking request
Get a staking transaction
List Staking Requests for a Wallet
List staking requests by ID
List staking requests by asset
List staking requests by enterprise
Retry staking request
Sign staking transaction
Upload KYC document and get IPFS hash
Staking State Information
Get list of stake-able coins
Get staking license
Get staking requirements
Get staking totals at the enterprise level
List coins available for staking
List coins available to enterprise for staking
List staking delegations
List staking details by enterprise
List staking details by enterprise tokens
List staking details by wallet
List staking partnered validators
List staking rewards
List staking validators for a wallet
List staking wallet tokens
Trade
Accounts
Get Account Balance
Get Current User
List Accounts
Margin
Cancel collateral withdrawal request
Close all margin positions
Cover all short margin positions
Create collateral withdrawal request
Get close position request details
Get collateral withdrawal request
Get margin risk profile
Get margin risk settings
Get net open margin position limits
Get net open margin positions
Get net open positions snapshot
Get positions activity
List available currencies for collateral
List close position requests
List collateral withdrawal requests
List orders for close position request
List transferred collateral
Transfer collateral for margin
Transfer margin position
Market Data
Get historical prices
Get spot prices
Order Book
Get Level1 Order Book
Get Level2 Order Book
Orders
Cancel Order
Get Order
Get Trade
List Orders
List Trades
Place Order
Products
List Currencies
List Products
User Management Notification
Add device token for user
Get notification categories
Get notification mute settings
Get notification thresholds
Get user categories with subscription status
Get user subscriptions
Mute enterprise notifications
Mute wallet notifications
Remove device token for user
Set user subscriptions
Unmute enterprise notifications
Unmute wallet notifications
Update mute settings
Update muted enterprises list
Update muted wallets list
Update notification thresholds
Wallet & Transact
Address
Create address
Deploy address
Forward tokens from address
Get address
Get cross-chain address balances
Get proof of address ownership
List addresses
List addresses sorted by balance
Update address
Federation
Look up user accounts by their Stellar address or id
Key
Create key
Get Bitgo MPC GPG public key
Get key
Get keys
List keys
Lightning
Create a lightning invoice
Fetch lightning invoice for a payment hash
Fetch lightning invoices
Fetch lightning onchain transaction for a txid
Fetch lightning onchain transactions
Fetch lightning payment for a payment id
Fetch lightning payments
Lightning - Get Channel Backup
Lightning - List Invoices
Pending approval
Bulk update non-withdrawal pending approvals
Get Transfer By Approval Id
Get pending approval
List counts of pending approvals
List pending approvals
Update pending approval
Send label
Create send label
Delete send label
Get send label by id
List send labels
Update send label
Transfer
Change Fee
Get fee estimate
Get transfer
Get transfer by sequence id
List account wire withdrawals
List all transfers on all wallets in an enterprise
List transfers
List transfers on all wallets in an enterprise for a given coin and block height
Update comment
Update wire withdrawal
Transaction request
Cancel transaction request
Create ECDSA MPC challenge for message
Create ECDSA MPC challenge for transaction
Create a signature share for a transaction on a transaction request
Create a signature share for the transaction request
Create transaction request
Create transfer for transaction request
Delete ECDSA MPC configurations
Delete signature shares on a transaction request.
Exchange commitments for EdDSA transactions (full)
Exchange commitments for EdDSA transactions (lite)
Get MPC settings.
Get transaction requests by enterprise
Get transaction requests by enterprise filtering by wallet permissions
Get transaction requests ready for signature
List ECDSA MPC configurations per enterprise
List transaction requests by wallet
Rebuild multiple transaction requests
Send a transaction request.
Sign transaction request
Update coin-specific data for transaction request
Wallet
Add wallet (advanced only)
Build a transaction
Build an approval transaction for ERC20 token
Cancel a wallet share
Check if a GG18 Wallet is ready to update to DKLS.
Consolidate account (advanced)
Consolidate unspents (advanced)
Delete wallet
Freeze the wallet for the given coin and wallet id.
Get Wallet Cross Chain Unspents
Get account resources
Get average fee
Get balance reserve data
Get maximum spendable
Get pinned wallet count
Get resource delegations
Get the token allowance for a specific token contract address
Get wallet bridgable balance for the root address
Get wallet by ID
Get wallet by address
Get wallet by coin and ID
Get wallet fee address balances
Get wallets count
Initiate a transaction
Initiate a trustline transaction
List derived wallets for an EVM keyring
List forwarder addresses and balances
List last 10 contract sequenceIds of a wallet
List stuck transactions
List stuck transactions for EVM keyring
List total balances
List total balances by coin
List unspent reservation
List unspents on a wallet
List wallet share requests
List wallets
List wallets by coin
Look up material
Make unspent reservation
Modifying unspent reservation
Pin or unpin a wallet
Release unspent reservation
Remove user from wallet
Request wallet access
Send a half-signed transaction
Send funds to forwarder
Sign off-chain message
Update wallet
\[DEPRECATED\] Add wallet (advanced only)
Wallet share
Create a wallet share
Get wallet share
Get wallet share V1
List counts of wallet shares
List wallet shares
Reject a wallet reshare request
Request wallet reshare
Resend a wallet share invitation email
Update a wallet share
Webhook
Add block webhook
Add wallet webhook
Create webhook secret
List block webhooks
List wallet webhook notifications
List wallet webhooks
Remove block webhook
Remove wallet webhook
Simulate block webhook
Simulate wallet webhook
Verify Webhook Notification
Express
Advanced Wallets
Advanced Wallets - Accelerate Transaction
Advanced Wallets - Check Version
Advanced Wallets - Consolidate Account
Advanced Wallets - Consolidate Unspents
Advanced Wallets - Consolidate and Recover Assets
Advanced Wallets - Generate Wallet
Advanced Wallets - Ping
Advanced Wallets - Ping Advanced Wallet Manager
Advanced Wallets - Recover Assets
Advanced Wallets - Send to Many
Advanced Wallets - Sign and Send MPC Transaction
Express
Accelerate Transaction
Accept a Wallet Share
Accept wallet share
Calculate mining fee
Canonicalize address
Consolidate account (simple)
Consolidate unspents (simple)
Create Wallet with Keychains
Create key
Decrypt messages
Encrypt messages
Fan out unspents
Generate wallet
Lightning - Create signer macaroon
Lightning - Get node state
Lightning - Initialize node
Lightning - Pay a Lightning Invoice
Lightning - Unlock node
Lightning - Withdraw to an onchain address
Ping
Ping BitGo Express
Recover ETH token
Resolve pending approval
Send to many
Send transaction
Share wallet
Sign MPC transaction
Sign transaction
Sign wallet transaction
Sweep funds
Update Wallet
Verify address
Verify address for a given coin
Verify if an address belongs to a wallet
WebSocket
Trade WebSocket
Get WebSocket connection
Internal
Webhook
List v1 wallet webhooks
Authorize Webhook Access
Bulk Authorize Webhook Access
Get webhook secret
Admin
Add a wallet webhook
Get user notification subscriptions (admin)
Set user notification subscriptions (admin)
Update muted wallets list (admin)
Mute wallet notifications (admin)
Update muted enterprises list (admin)
Mute enterprise notifications (admin)
Get consumer pause status (admin)
Set consumer pause state (admin)
Admin retrigger webhook notifications
Block or unblock a webhook URL (admin)
Admin resend notification
Unblock user email (admin)
Admin get webhook notification history
Get notification mute settings (admin)
Get NCC user details (admin)
Get notification status
Admin example endpoint
Find blocked email (admin)
Get audit logs (admin)
Unmute wallet notifications (admin)
Unmute enterprise notifications (admin)
List Transfers
Find transaction
Admin backing wallet webhook setup
Clone custodial wallet
Get wallet
Update wallet
Associate wallet with custom nodes for transaction broadcasting
Disassociate wallet with custom node for transaction broadcasting
List policies
Update policy mutability
Consolidate whitelist policy rules
Restore wallet
Delete wallet
List mongo queries
Create mongo query
Run mongo query
Update mongo query
Initiate a token support transaction
Delete signature shares on a transaction request.
Merge Addresses
Admin List Migration In Progress Enterprises
Admin Create Enterprise
List users
set the featureFlags on a user
List enterprises
Get enterprises balances
Remove video link on a pending approval
Generic get wallets route
Migrate v1 wallet metadata to v2
Revert v2 migrate metadata
Unstake for the EOS Master wallet
Refund for the EOS Master wallet
Get all custom nodes for a coin
Setup custom nodes for transaction broadcasting
Deletes a custom node
Add a Wallet Flag
Update a Wallet Flag
Delete a Wallet Flag
List billing tasks
Create billing task
Get billing task by ID
Get billing report by ID
Generate billable events for a time range or specific transfers
Fetch billable events given query parameters, defaults to all in the last 24 hours
List addresses
Get balance details for an address
Add address to blacklisted addresses
Add address to malware addresses list
List audit logs
Update a sendq state which may lead to an update to the accompanied transfer item
Get salesforce opportunity
Get salesforce account
Get all or some of the existing BitGo Products
Create Product
Validate reorged blocks
Flush native coins
Flush tokens
Create a Wallet Recovery Half Signed Transaction with HSMv3 for V2 Wallets
Admin Patch Base Asset
Admin Get Issuer Details
Admin Patch Issuer Details
Admin Get Enterprise Stablecoin Assets
Admin Update Enterprise Stablecoin Asset
Admin Get Organization Stablecoin Assets
Admin Update Organization Stablecoin Asset
Create a Wallet Recovery Unsigned Transaction with HSMv3 for V1 Wallets
Create a Wallet Recovery Half Signed Transaction with HSMv3 for V1 Wallets
Admin Update Enterprise
Admin Get Access Token
Get User Email
Make User Access Token
Get User Local
Get Wallet List
v2.admin.address.get
Post the sequenceId of an address
Set the nonce lock expire time
Add Nonce to Missing Nonce List
Manage Expiry-Based Nonce Handler
Remove Nonce from Missing Nonce List
Update Address Consolidation Flags
Sign and submit a crosschain recovery transaction
Create an unsigned crosschain recovery transaction
Deploy an address to the crosschain recovery contract
Get a fee estimate for a crosschain recovery transaction
Create a crosschain recovery transaction
Admin ERC-3643 Add Claim
Admin ERC-3643 Register Identity
Admin ERC-3643 Remove Claim
Reconcile fee address unspents (ParaUTXO coins)
Get wallet addresses (admin impersonate)
Admin Fetch lightning invoices
Admin List lightning payments
Admin Get Payment by Payment Id
Rebroadcast the most recent IndexerNotification
Create a key.
List pending approvals for a coin.
Helps to move funds from hop address
Admin Tokenization Held SendQueue Update
Get transaction information
Get cross chain unspents for a wallet
Returns the txids of the deployment transactions
Create an unsigned transaction to move funds from fee address
Signs unsigned transaction to move funds from fee address
Get the fees required to perform a crosschain recovery
Flushes native coin or token based on tokenContractAddress
Create an unsigned transaction to recover funds
Returns the txids of the recovery transactions
List forwarder addresses and balances
Enable OFC wallet to use multi-user-key
List stuck transactions
Submit a recovery transaction from fee address
Helps to move funds from fee address
Create an unsigned transaction to recover funds from fee address
Create a Wallet Recovery Unsigned Transaction with HSMv3
Create a Half Signed Wallet Recovery Transaction
List last 10 contract sequenceIds of a wallet
Add internal wallet webhook
Generic DLQ rebroadcast route with dynamic type parameter
Get the status of an async DLQ rebroadcast job
Add asset via AMS
Modify asset via AMS
Flush the authentication cache.
List billing reports
Download billing report
Get list of BitGo org the admin user has access to
Retry signing transactions for custodial hot wallets
Retrofit the EcDSA MPCv1 Custodial wallets of a Bitgo Org to MPCv2
Add a user from all enterprise wallets.
Grant view permissions for users to all wallets in enterprise
Remove a user from all enterprise wallets.
Retrieve the reports for a specific enterprise.
Retrieve the statements for a specific enterprise.
Admin get enterprise
Create Trust Ops Comment
Archive Trust Ops Comment
Get transaction requests by enterprise
Add a enterprise video ID user
Update the video ID user information for an enterprise
Delete an enterprise video ID user
Admin Wallet Creation Jobs List
Admin Wallet Creation Job Create
Backfill gasTankKeys for single enterprise
Retry fee address creation for enterprise
Create reports for an enterprise.
Create an admin statement
List enterprise video ID users
Fetch an EnterpriseDefaultLicenses document specific to an org.
Create a new EnterpriseDefaultLicenses document.
Update an existing EnterpriseDefaultLicenses document.
Get the enterprise template list.
Create an enterprise template.
Get the enterprise template by template ID.
Update an enterprise template.
Create a BitGo key document using the AWS ARN for a particular BitGo Trust.
Update the lightning node for a given wallet.
Bypass the circuit breaker for lightning transactions that are stuck.
Force fail lightning payments that are stuck in the in_flight status.
Retrofit the Custodial Key of a Bitgo Org
Admin Create OAuth Client
Admin Get OAuth Client
Admin Update OAuth Client
Admin Delete OAuth Client
List Admin Organizations
Get Admin Organization
Update Admin Organization
Delete Admin Organization
Retrieve the reports for a specific organization.
Create reports for an organization.
Get the summary of an admin organization.
Add a user to an organization.
Remove a user from an organization.
List all wallet shares for all enterprises in an organization
Bulk Update Pending Approvals
Update Pending Approval Freeze
Update Stuck Pending Approval State
List pending approvals that are awaiting signature
List pending approvals/transactions/transactionRequests that are frozen
List pending approvals with action dates and elapsed time
List pending approvals that require trust operator action
Get a report by its ID.
Download a report document for the admin user.
Admin customer statements
Get a statement document by its ID.
Update transfers
Batch update the state of multiple transfers.
Resubmit transfer to TRM for analysis
Transfer admin report.
Get Trust Ops Comments
Get transaction requests ready for trust signature
Get pending TSS transaction requests for bulk OVC signing
Reset the state of the unverified email worker
Get the state of the unverified email worker
Update Shard Key for Users, Enterprises, or Enterprise Templates.
Admin User Update Request
Admin Update User Access Token Spending Limit
Admin Rotate Access Token
Admin Freeze User
Admin User Internal Tokens
Admin Update User KYC
Remove or set the user to inactive status
Admin User Summary
Set up a wallet for a given coin, currently only backing.
Compute a SHA-256 checksum over addresses in a wallet
Update a Wallet Lock
Add a Wallet Lock
Update the locked asset amount of the given wallet
Adds a locked asset amount to the given wallet.
Delete an asset from locked assets of the given wallet
Retry a MigrationTask by walletId
List Wallet Rebalance Events
Create a Wallet Rebalance Event
Get a Wallet Rebalance Event
Update a Wallet Rebalance Event
Rebuild Custodial Transaction
Get transaction requests by wallet
Admin Update Transaction Request For Wallet
Admin Exchange Eddsa Commitments
Update the locked asset amount of the given wallet
Update a video call for a given Video Call Webhook
Returns the coin and txids of the recovery transactions
Remove an Enterprise.
Create a video call
Update a video call for a given videoCallId
Transaction request
Get transaction requests by wallet (internal)
Create transaction request (internal)
Create a signature share for a transaction on a transaction request
Make Empty Transaction
Bulk upload signature shares for multiple transaction requests
Sign transaction request (internal)
Create a signature share for a message on a transaction request
Rebuild transaction requests(admin)
Get transaction requests by enterprise (internal)
Get transaction requests count (internal)
Internal Update Transaction Request For Wallet
Create a signature share for a message on a transaction request
User
Update session
Register a user with an enterprise and organization
User details
Get settings
Update settings
Reset the user password
Change login password
List users for an enterprise
Verify an OTP code for a user
Update User Email
Admin Signup Request
List access tokens
Create access token
Modify access token
Delete access token
Get WebAuthn auth
Get WebAuthn register
Signup Request
Admin api to get a list of trusted devices for a user
Admin api to delete a trusted device for a user
Sign up
Google OAuth Callback API for SSO Sign In
Google OAuth Verify API for SSO Sign In
Internal Api to fetch the relationships between user, wallet, enterprise, and organization.
Internal get user
Internal API to fetch a single enterprise’s data for a given user.
Internal Api to fetch the list of enterprises and organizations to which user belongs
Get user entity level permissions
Create new user
Internal institutional signup
Internal Login Request
Get new TOTP key data
Provision TOTP device
Get Internal Scoped User Session
Get Internal User Session
Verify Password Internal
Get a list of internal Users based on a list of given Ids
Get a list of internal Users of BitGo Korea who are due for password update
Takes the list of user IDs and sets the password change email sent date for each user to the current date.
OAuth Callback API for SSO Sign In
Generate a cryptographic nonce for SSO id_token verification
OAuth Verify API for Verifying id token
Gets passkey challenge
Modify access token
Get User Assets Withdrawable
Check batching password flow
FTX Signup
Institutional Signup
Get internal access token
Ephemeral keychains update
List wallets linked to a passkey device
Get WebAuthn auth
Get WebAuthn register
Upsert Recovery Codes
Get Active Reset 2FA
Create Reset 2FA
Get 2FA reset request by id
Complete a successful 2FA Reset
Resume Reset 2FA
Verify a reset 2FA request
Internal get users sharing keys
Sign up
Api to get a list of trusted devices for a user
Api to delete a trusted devices for a user
Verify User
Verify Source Fingerprint
Counterparties
Admin list Go Account connections
List event logs
Admin Update Go Account entry
Admin Get enterprise listing
Onboard a Go Account to the address book directory
Sync the name for a given enterprise
Get Go Account connections
List Go Account connections
Internal Default Prices
List default prices
Update a default price window
Create a default price window
Internal Asset Management APIs
Update an existing asset with vendor mappings
Create a new asset with vendor mappings
Admin Default Prices
List default prices
Update a default price window
Create a default price window
Internal Market Data - Historical Prices
Get Historical OHLC Prices (Internal)
Get Batch Historical OHLC Prices (Internal)
Internal Historical Prices Example Endpoint
Internal FX Rates
Refresh FX currency mappings
Trigger FX rate backfill
Get latest FX rate (internal)
Get historical FX rates (internal)
Get latest FX rate for a currency pair
Get historical FX rates
Admin Backfill
Backfill historical price data
Market Data
Get Latest Spot Prices
Internal Latest Prices Example Endpoint
Get Historical OHLC Prices
Market Data Example Endpoint
Internal Market Data - Latest Prices
Get Latest Spot Prices (Internal)
Internal Latest Prices Example Endpoint
Internal Vendor Asset APIs
Get asset metadata for each vendor by contract address
Admin Latest Prices
Get Latest Spot Prices (Admin)
Admin Historical Prices
Get Historical OHLC Prices (Admin)
Delete historical price data for a time range
Admin FX Rates
Get latest FX rate (admin)
Get historical FX rates (admin)
Audit log
List User Audit Logs
List Admin Audit Logs
List Audit Log Filters
List audit logs by coin
BitGo Network Admin
List network allocations and deallocations
Get network allocation or deallocation
List Network Clients
Create network client
Admin GET Client Balances
List Network Connections
Get Network Connection
Admin GET Connection Balances
List Network Partners
Create Network Partner
Update Network Partner
Update Network Partner Address
Partner Kill-Switch
Enable On-Chain Settlement Automation for OES Partner
List Network Settlements
Admin GET Settlement
Put notes info into event for settlement
Post withdrawal info for an on-chain settlement
Admin Reject On Chain Settlement
Admin Settle Gains
Admin Settle Losses
Patch external deposits for an on-chain settlement
List Settlement transfers
Admin List Partner-Supported Currencies
Admin list trades
Admin get trade
Settlement Disputes
List Settlement Disputes for Admins
Close a dispute
Close a dispute
Partner Trades
List partner trades
Create partner trade
Get partner trade
Client Allocations & Deallocations
List Trust-Supported Currencies
Settlements
Count settlements created or updated in a given timeframe (admin)
List settlements created or updated in a given timeframe (admin)
Rebroadcast settlement state-change events (admin)
List settlement batches by Go Account
Batch sign settlements
Bulk initiate settlements
Review bulk initiate settlements
Count settlements created or updated in a given timeframe (internal)
List settlements created or updated in a given timeframe (internal)
Rebroadcast settlement state-change events (internal)
Settlement Queue
Get Queue Settlement
Update settlement queue items priority and/or active status
Get Settlement Queue Metrics
Process settlement queue items
Get Process Queue Payload
Settlement Approvals
Update settlement approval request from policy resolution (internal)
Compliance Transaction Monitoring
Liveness check
Ready check
Ping check
Post Enterprises
Post enterprises to Unit21
Post Transfers
Post transfers to Unit21
Post Wallets
Post wallets to Unit21
Post Users
Post users to Unit21
Post Internal Transfer
Post transfers to Unit21
Admin Credentials
List credentials for BitGo admins
Example
Hello world
Hello world
Example api route definition
Credentials
List internal credentials
Update internal credentials
Create internal credentials
Delete internal credentials
DAS
Ping
Fetch Balances
Fetch Transactions
Get Account Details
Create Account(s)
Get Journal Account Balance
Get Journal Account Balances By Currency
Fully Freeze and Account
Thaw a Fully Frozen Account
Query for Frozen Account
Account Key Update
Bank or On-Chain Booking
Deposit to DAS (matched/unmatched)
Hold Funds for Withdrawal
Release (Cancel) Held Funds
Clear Held Funds
Hold Funds in Backing Wallet for Withdrawal
Withdraw Unmatched Funds
Reconcile Unmatched Funds
Go Account Transfer Send
Lending - Record Accrual Entries
Lending - Record Confirmed Receipt
Lending - Record Unmatched Receipt
Lending - Record Reconciled Unmatched Receipt
Lending - Reserve for Pending Send
Lending - Cancel Pending Send
Lending - Confirm Pending Send
Lending - Record Unmatched Send
Lending - Query Transaction Entries
Retrieve Journal Entries
Post Journal Entries
Fetch Block (fake implementation)
Get Transaction Units
Create Account Closings
Get Account Balances by Prefix
Get aggregated current account balances
MetaMask Institutional
Return MMI transactions
Return MMI transactions by wallet Id
Return MMI messages (not broadcasted to the network) by wallet Id
Transactions and Messages
DevExTest
Echo
Health
Know Your Business (KYB)
Get KYB Document (internal)
List KYB Documents (internal)
Ping endpoint
Ping endpoint
List recommended orgs
Get all BitGo orgs (Admin only)
Create a new BitGo org (Admin only)
Get a BitGo org by ID (Admin only)
Update a BitGo org (Admin only)
Lower Envs Only: Reset database by clearing all entities
Document Service
Get internal documents
Create a parent collection Document in document-service
Persona
List Persona Accounts
List Persona Cases
Get Persona Case
Update Persona Case
Add Case Objects
Add Tag to Persona Case
Remove Tag from Persona Case
Set Persona Case Status
Get Persona Document
Get Persona Event
List Persona Inquiries
Create Persona Inquiry
Get Persona Inquiries by id
Redact Persona Inquiry
Decline Persona Inquiry
Resume Persona Inquiry
Get Persona Report
Create Persona Transaction
Get Persona Transaction
Submit Signatures for Persona Transaction
Get Persona Verification
Print Persona Verification
Trigger Persona Workflow
Persona Case Webhook
Persona Event Webhook
Persona Inquiry Webhook
Persona Report Webhook
Persona Transaction Webhook
Persona Verification Webhook
Salesforce Case Webhook
Know Your Customer (KYC)
Liveliness check
Ping check
Readiness check
Admin Sync Accounts in WP
Admin Update Case
Admin List Cases
Admin Get KYC Identity
Admin Get KYC Identity Documents
Admin List Inquiries
Admin Create Inquiry
Admin List Trust Committee Cases
TC Case Decision
List Cases
Pending document request
List Inquiries
Create Inquiry
Redact Inquiry
Resume Inquiry
Internal Get Case Event
Internal List Cases
Internal Create Inquiry
Internal List Inquiries
Internal List Persona Inquiries
Get KYC Reverification Required Status
Patch Update KYC Reverification
Create KYC Identity V2
Auth Service
Verify a session (verifies the bearer token)
Fiat
Ping
Polls Silvergate for Updates
Fetch Transactions
Fetch Balances
Fetch Balances
Query Transactions
Get Wire Details from Silvergate by txId
Get Payment Details from Silvergate by paymentId
Get Total Balance
Mock a Transaction
List bank accounts (internal)
Get bank account (internal)
Add bank account (internal)
List bank accounts for deposit
Fetch & calculate bank account fee (internal)
Fetch & calculate bank account fee by transaction (internal)
Admin list bank accounts
Admin bulk add bank accounts
Admin verify routing number by bank type
Admin update bank account
Admin get deposit info
Admin get configurable fee
Admin create configurable fee
Admin update configurable fee
Update funds in bank account
Calculate bank account fee
Go Account Staking Internal
Finalize staking request for Go Account (internal)
BitGo Products
Create new BitGo Products (Admin only)
Update a BitGo Product (Admin only)
Lower Envs Only: Delete all products
Create BitGo Products Configuration (Admin only)
Delete BitGo Products Configuration (Admin only)
Update BitGo Products for a Products Configuration (Admin only)
Admin - KYB Identities
List KYB Identities (Admin)
Get KYB Identity (Admin)
Products Requirements
Get product requirements by query parameters (Admin only)
Create new product requirement (Admin only)
Delete product requirement by ID (Admin only)
Update existing product requirement (Admin only)
Generic Requirements
Get all requirements with pagination, sorting, and filtering (Admin only)
Create new requirement (Admin only)
Get requirement by ID (Admin only)
Transfers
List transfers (internal)
Notify Link of an incoming deposit from a BitGo wallet
List transfers
Get transfer by ID
Initiate an internal transfer
Accounts
List Link accounts
Create a Link account
Get a Link account
Delete a Link account
Update a Link account
Get enterprise asset balances — aggregated by asset across all permitted accounts
Get permitted accounts balances for an enterprise
List on-chain destinations for a given asset/network
List Link accounts eligible as withdrawal sources
List destinations reachable from a Link-account source
Addresses
Generate a deposit address
Venues
Get supported venues
Get venues and their configurations
Market data
Get historical prices
Get spot prices
Webhooks
Retrigger webhook notifications
Get webhook notification history
Internal
Internal Get user categories with subscription status
Send notification via internal API
Internal Get notification status
Internal API to send a notification to a user when the user has been assigned
Validate bridge funding request
Get addresses by chain (without token filter)
Rebroadcast the most recent IndexerNotification
Make Empty Transaction (Internal)
Get a fresh PayGo billing address with attestation proof
Internal API for List SendQueue by State
Internal API for List SendQueue by State and Blocks
Internal get send queue transaction
Internal list transfers
Internal get transfer by id
Internal get coinSpecific and transactions for multiple transfers
Get transaction information
Internal create address
Returns the txids of the deployment transactions
Flushes native coin or token based on tokenContractAddress
Internal get wallet transfer
Internal get transaction inputs and outputs for transfers
Internal get wallet transfers cancellable status
Get Access Token Types
Post Audit Log Internal
List enterprises
Update enterprise
Freeze an enterprise
Grant view permissions for users to all wallets in enterprise
Set enterprise logo
Internal get enterprise
List users in an enterprise with pagination support
Delete all wallets associated with an enterprise
Get enterprise by referral code
Internal get enterprise
Internal API to fetch entity details for multiple entities at once
Get Internal Key
Internal move enterprises to organization
Internal Update Org Feature Flags
Internal get organization summary
Internal List Approvals
Internal Post Approval
Internal Get Approval
Update a pending approval
Internal Resolve Pending Approval For Policy
Internal Update Role Approvers
Dispatch a scheduled report on behalf of a user
Map the caller's forwarded auth token to a userId
Get the status of a scheduled report by id
Get Wallets Metadata
Returns the array of tokens along with its support
Create a transfer internally
Internal get transfers
Batch publish transfer screening events to Kafka
Internal get transfer coinSpecific toJSON for multiple transfers
Internal list all transfers
Get Enterprise For Wallet
Update a Wallet Lock
Add a Wallet Lock
Delete a Wallet Lock
Update the locked asset amount of the given wallet
Adds a locked asset amount to the given wallet.
Delete an asset from locked assets of the given wallet
Get wallet info by wallet address without requiring coin parameter
Internal get advanced whitelist addresses for wallets (batch)
Suspend a webhook
List wallet webhooks by wallet IDs
Organization Internal
Liveness check
Readiness check
Log in to org dashboard
Address
List v1 wallet addresses
Get v1 wallet address
Internal get address
Internal get proof of address ownership
Enterprise
Add user to enterprise
Remove user from enterprise
Perform an enterprise/organization mapping operation as admin
Create a starter enterprise
Create an FTX Singapore Enterprise from an existing FTX Trust enterprise
Update enterprise kyc re-verification details
Perform an enterprise/organization mapping operation
Update enterprise pricing types and kits
List Statements
Get Statement By Id
Post Enterprise Video Id User
Get Enterprise Video Id User
Verifies if an enterprise is a retail enterprise
Internal List Enterprise Transfers
Get Enterprise Video Id User (Internal)
List Enterprise Video ID Users (Internal)
Circuit breaker
List circuit breakers
Create circuit breaker
Get circuit breaker
Update circuit breaker
Delete circuit breaker
Pending approval
List pending approvals for a coin
Update pending approval
Remove video link on a pending approval
List v1 pending approvals
Get v1 pending approval
Update v1 pending approval
Get Filterable Approval List
List pending approvals for backing wallet rebalancing transactions
List pending approvals (coin-agnostic) with filtering by state and resourceType.
Get pending approval count for real time monitoring
Get pending approval count for real time monitoring
Get Tx Request By Approval Id
List pending approvals that are awaiting signature
Get Approval By Evaluation Id
Wallet
List total balances across all wallets in an enterprise
Recreate V1 wallet stats
Search bad transfers
Fix bad transfers
List unspent reservation
Make unspent reservation
Admin release unspent reservation
Send a half-signed transaction
Get wallet passphrase recovery information
List all v1 wallets of an enterprise
Get a v1 wallet
Get v1 wallet transactions
Whitelist a trading partner
Add a Wallet Flag
Update a Wallet Flag
Delete a Wallet Flag
Get v1 wallet
List v1 wallets
Create paired FLR C-chain wallet
Build bulk resource delegation transactions
Build bulk resource undelegation transactions
Get inscribed satoshis on unspent
Add a shared BitGo key to an OFC wallet that currently has only a user key
Publish a wallet creation event to Kafka.
Internal get wallet receive address
Internal get wallet
List addresses
Get Internal Wallet Balance
Internal get potential stuck transactions
Internal add custodial wallet
Internal get wallet by address
Validate user's wallet ids by wallet permission.
Internal get wallet lightning metadata
Internal get wallets
Internal get wallet
List key
List users on a wallet
Get Internal Wallet Balances
Internal get wallet coinSpecific toJSON for multiple wallets
Internal get wallet coinSpecific and lightning metadata
Internal list wallets
Create a Go Account for an OFC Wallet if it does not exist.
Sign OFC transaction using BitGo key
Bulk Activate Ofc Wallets
Get Bitgo Tss Ecdsa Challenges
Get Wallet Challenges
Retrofit a MPCv1 Wallet to MPCv2
Create bulk wallet shares
accept bulk wallet shares
update bulk wallet shares
Wallet share
List v1 wallet shares
List wallet shares for coin
Get a wallet share
List bulk pending wallet shares and wallet share requests for UMS admin console
LegacyReports
Generate coin specific report
Generate a wallet report
Fee address report
Retrieve prepared reports
Send label
List v1 send labels
Transfer
Update a transfer by id
Get v1 wallet transfers
List v1 transfers
Update v1 comment
Get v1 wallet transfer
ThomsonReuters
Send PII data to be screened by Refinitiv
Lumina
Create webhook transfer notifications for a list of wallets
Wallet events
Create Wallet Event
Get Wallet Event
Policy Builder
List policy rules for an organization
Get policy evaluation
Admin Get Policy Evaluation
Get Policy Evaluation by Idempotency Key httpRoute definition
Create policy evaluation definition
Health Check
Get Trade Health Status
Route Composition
Get Transaction Routes - Internal
Post Transaction Route Internal
Get Transaction Routes by Id - Internal
Patch Transaction Routes by Id - Internal
Get Routed Transaction - Internal
Post Routed Transaction - Internal
Get Routed Transaction by Id - Internal
Get Transaction Routes
Get Transaction Routes by Id
Patch Transaction Routes by Id
Get Routed Transaction
Get Routed Transaction by Id
Staking Internal
Retry staking request
Add reward adjustments for delegations
Redistribute a SUI reward lump-sum across missing epochs
Upload backfill events in JSON format
Identity Verification (IDV)
Health check
Sumsub webhook receiver
Admin - Identity Verification (IDV)
Get Sumsub IDV records (admin only)
Retrigger Temporal signal for an IDV record (admin only)
Trade Falcon
Gets an order by id
Allows update of certain properties in an order
Gets an order by id
Gets a fill by id
Gets a fill by id
Deletes a fill by id
Lists fills based on passed filters
Create fund transfer for a liquidity source
Create fund transfer for a liquidity source
Create primeview account
Get The Accounts Balances
Get The Accounts Balances
Update The Accounts Balances
Gets a list of all the liquidity sources
Creates a liquidity source
Gets a list of all the liquidity sources
Creates a liquidity source
Gets a liquidity source
Updates a liquidity source
Gets a liquidity source
Gets a list of settlements
Post a trade settlement
Gets a settlement
Updates a customer settlement
Clears a customer settlement
Previews a settlement
Get account summary balances
List settlement requests
List DLQ jobs
Get DLQ job
Mark DLQ job resolved
Reenqueue DLQ job
Prime Trading
List Orders
List Orders
Create Order
Create Fill
Update Fill
Trade REST API
Stage Settlement
Update Settlement
Travel Rule
List VASP address verification statuses
Admin update VASP address registration status
List receiving transfers for travel rule
Get Travel Rule Transfers with PII
Patch Travel Rule Transfers with PII
Diagnose missing PII for a travel rule transfer
Admin list trust vasps
Admin list VASPs
Admin add VASP
Admin update VASP
Admin merge VASPs
Admin update VASP with Trust Vasp
Admin get whitelist address
Get vasp information corresponding to each whitelisted addresses in a vasp.
Admin get whitelist address
Admin patch whitelist address status
List VASP deposits
Update PII
Post small deposit test
Get VASP
List VASPs
Add VASP
Get transfers and PII for a VASP (Virtual Asset Service Provider) transfers and PII.
Claim transfer for VASP
Refresh NCC email notification statuses
Daily Transfer Notification for verified Non Trust VASPs
Get VASP suggestions
Get whitelist address status
Patch whitelist address status
Stablecoin
Get Admin Token Constants
List supported assets
Admin Patch Base Asset Jurisdiction Settings
Get Blacklist Address
Get Blacklist Address List
Admin Update Stablecoin Client
Get Network Partner by Enterprise ID
Create Network Partner
Update Network Partner Details
Update Network Partner Status
Get Admin External Partner Addresses
Add External Partner Address
Update External Partner Address
List Network Partners
Update Order Status
Get Admin Orders
Get Admin Order by ID
Admin Read Contract Method
List reports for a stablecoin (Admin only)
Upload a report for a stablecoin (Admin only)
Delete (archive) a report (Admin only)
Edit a report (Admin only)
Download report file (Admin only)
List aggregated monthly rewards
List issuer stablecoin orders
Create issuer-direct stablecoin order
Get Network Partner
Preview order fee estimate (burn or mint)
Get enterprise issuer privileges
Get GoUSD Details
List assets
Post initiate burn transaction
Patch expire orders
Post Incoming
Post initiate mint transactions
Get Monthly Rewards Payout
Post Monthly Rewards Payout
Internal Create Order
Internal order preview
Internal Order Validation
Get Internal Orders
Get Internal Order by ID
Post initiate reward transaction
Post TMS Resource Update
Get Token Details
Get Stablecoin Transfer
Get Blacklist Address
Get orders summary for issuer (across all enterprises)
Get issuer supply timeseries
List Token Contract Modification Requests
Create token contract modification request
Get stablecoin rewards analytics
Get rewards statement
Get detailed stablecoin rewards statement
Get stablecoin rewards summary
Update Network Partner
Get External Partner Addresses
Accept Network Partner Terms and Conditions
List Featured Network Partners
List reports for a stablecoin
Get report metadata
Download report file
Get Liveness
Get Ping
Get Readiness
User Management Service (Internal)
Get role for organization
Update existing role
Hard delete role
Hard delete invitation
Retry user permission state updates
Get organization users with permission
Invite new users
Create roles
Retry failed emails
Update role users
Get user organizations
Get organization users by permissions
Get comprehensive user details
Admin Console
Get specific role
Update existing role
Delete organization role
Get organization users
Invite new users to organization
Bulk remove users from organization
Get organization roles
Create new role
Update role users
Update invitation status
Get user organizations
Get organization by ID
Get user roles
Update user roles
Get orphaned resources for user removal
Get user permissions
Get comprehensive user details
Get organization user details
Remove user from organization
Get orphaned resources for role and user
Get orphaned resources for role and multiple users
Get orphaned users for role
Get role resources
Get orphaned resources for role
Get resource by ID
Get user permissions for organization
Get permission differences for pending change
Get pending changes
Get pending change by ID
Get organization invitations
Get enterprises for organization
Get enterprise resources
Get enterprise roles
Rescind organization invitation
Resend organization invitation
User Management Service (Admin)
Validate user removal for orphaned policies
Execute permission action
Migrate organization
Get organization user details (admin)
Update organization admin (admin with pending approval)
Invite new users as organization admin (admin with pending approval)
Get user properties
Upsert user properties
Patch guided checklist properties
Admin - Roles
Get user roles across all organizations (Admin)
Get organization roles
Get role resources
AccountInformation
Get account information
DepositAddress
Generate a deposit address
Balances
Get balances for a credential
Withdrawals
Initiate an on-chain withdrawal
OnChainDestinations
Get on-chain destinations across all venues for a given asset
TransferDestinations
Get transfer destinations for a venue account source
Health
Detailed health status for dashboards and humans
Client
Get Client Constants
Lightning
Admin Fetch lightning invoices
Admin Fetch lightning Onchain Transactions
Admin Fetch lightning Onchain Transaction for a txid
Get channel backup of lnd server
Key
Update Key
Admin Generate Key
Delete a WebAuthn device from a key
Generate Key
RPC
Resolve Hedera Address
Transaction qequest
Sign PSBT
Spending
Get Admin Enterprise Spending
Get Admin Wallet Spending
Get Internal Enterprise Spending
Get Internal Wallet Spending
Organization
Admin Get Organization Enterprises
Admin List webhooks for an organization
Internal List User Organizations
Internal get organization
Get Organization Enterprise
Internal Get Organization Enterprises
Internal List Organization Transfers
Get Organization Users
List Organization Video ID Users (Internal)
Internal List Organization Wallet Shares
Organization Webhooks
Admin List webhook notification for an organization
Country
List Supported Countries
Debug
Debug Throw Error
Policy
Get policy rules
Whitelist a staking address, if needed.
Enteprise
Get Statement Document By Id
Whitelists
Get enterprise whitelists
Consolidate whitelist label
Deductibles
Get deductible amounts for account-based coin wallets
Get deductible objects for object-based coin wallets
Coins
Get allowed coins and sub-tokens i.e. if coin and its sub-tokens is accessible by the specified user/enterprise
Get Coin Info for all coins
Internal list coins
Get Normalized Addresses or SendLabelAddress
babylon
Create babylon delegation message
Email
Verify if an email is banned on the BitGo platform
IMS
Get IMS Block
SendQueue
Get wallet IDs with stuck transactions from sendqueue
Unified Events
Get count of unified events for a given entity type & range
Get list of unified event IDs for a given entity type & range
Rebroadcast unified events
Enterprise Management
Get Eligible Ofc Activation Enterprises
SCIM
Returns SCIM service provider configuration including supported features and authentication schemes.
Lists all SCIM-provisioned users in the requesting enterprise with support for pagination and filtering.
Creates a new user via SCIM 2.0 provisioning.
Retrieves a SCIM-provisioned user by their BitGo user ID.
Updates an existing SCIM-provisioned user using the PUT method (full replacement).
Agreement
Accept agreement
Get agreement version number
WD
Reprocess Dead Letter Queue Event
Withdraw Deposit
Post Transaction Route Id
Delete Transaction Route Id
Get Supported Currencies Route
Coins and Tokens
API Reference
Guides & more
developers.bitgo.com ↗
Health check
get
/api/sumsub-service/ping
Simple health check endpoint that returns a 200 OK response.
200 Response
message
string
required
Is this page helpful?
Give feedback.