Jump to Content
Home
Guides
API References
Changelog
Coins and Tokens
Log In
API References
Log In
Moon (Dark Mode)
Sun (Light Mode)
Home
Guides
API References
Changelog
Coins and Tokens
Get SCIM User
Search
All
Pages
Start typing to search…
JUMP TO
BitGo API
Overview
BitGo Products
Get BitGo Products Configuration
get
List BitGo Products
get
Counterparties
Add Block List Entry
post
Add Go Account connection
post
Create enterprise listing
post
Create enterprise listing entry
post
Delete Block List Entry
del
Get Block Lists
get
Get enterprise listing
get
List counterparties
get
List entries available for connection
get
List entry contacts
get
List Go Account connections
get
Update connection status
put
Update enterprise listing
put
Update Go Account entry
put
Enterprise
Audit log
List audit logs
get
Enterprise
Freeze the enterprise
post
Get enterprise
get
Get enterprise MPC config
get
Get enterprise regional features
get
Get enterprise user signing key
get
Get enterprise's wallet limits
get
Get gas tank balance
get
List available assets
get
List enterprise users
get
List enterprises
get
Opt out of points system
put
Remove user from enterprise
del
Update enterprise
put
Update enterprise ECDSA MPC challenge
put
Enterprise Webhooks
Create enterprise webhook
post
Delete enterprise webhook
del
List enterprise webhooks
get
Simulate bank account webhook
get
Simulate enterprise webhook
get
Organization
Admin List webhook notification for an organization
get
Admin List webhook notification for an organization
get
Reports
Download report
get
Generate org-level report
post
Generate report
post
Get report
get
List org-level reports
get
List reports
get
User
Add user to enterprise
post
Create access token
post
Freeze User
post
Get another users public key for wallet sharing
post
Get Recovery Codes
get
Get session
get
Get user
get
List access tokens
get
Lock session
post
Login
post
Login Request
post
Logout
get
Unlock session
post
Validate Password Reset Token
get
Express
Accelerate Transaction
post
Accept wallet share
post
Calculate mining fee
post
Canonicalize address
post
Consolidate account (simple)
post
Consolidate unspents (simple)
post
Create key
post
Decrypt messages
post
Encrypt messages
post
Fan out unspents
post
Generate wallet
post
Lightning - Create signer macaroon
post
Lightning - Get node state
get
Lightning - Initialize node
post
Lightning - Pay a Lightning Invoice
post
Lightning - Unlock node
post
Lightning - Withdraw to an onchain address
post
Ping BitGo Express
get
Recover ETH token
post
Resolve pending approval
put
Send to many
post
Send transaction
post
Share wallet
post
Sign MPC transaction
post
Sign transaction
post
Sign wallet transaction
post
Sweep funds
post
Update Wallet
put
Verify address
post
Fiat
Add bank account
post
Delete bank account
del
Get ACH agreement
get
Get address format information
get
Get bank account
get
Get deposit info
get
Get deposit information [DEPRECATED]
get
Initiate ACH deposit
post
List bank accounts
get
List enterprise transfer limits
get
Update bank account
put
Identity
Know Your Business (KYB)
Add KYB Documents
post
Add KYB Documents
post
Create KYB Identity
post
Delete KYB Document
del
Get KYB Document
get
Get KYB Identity
get
List KYB Documents
get
List KYB Identities
get
Update KYB Document
put
Update KYB Document Status
patch
Update KYB Identity
patch
Verify KYB Document Status
post
Know Your Customer (KYC)
Add KYC Documents
post
Create KYC Identity
post
Get KYC Document
get
Get KYC Identity
get
Submit KYC Signatures
post
Update KYC Document
put
Update KYC Identity
patch
Organization
Enterprise Management
Add a user to an enterprise within an organization
post
Create an enterprise for an organization
post
Get child enterprise
get
List asset balances
get
List enterprises for an organization
get
List enterprises for an organization
get
Sign a contract for an enterprise within an organization
post
Organization Management
List org activity timeline
get
Organization Search History
Create search history item
post
Delete a search history item
del
Global search across the organization
get
List org search history
get
Organization Trades
Get org trade order
get
List org trade order fills
get
List org trade orders
get
List org trade products
get
Organization Transfers
Get org transfer
get
List org transfer timeline
get
List org transfers
get
Organization Webhooks
Create organization webhook
post
Delete organization webhook
del
Get organization webhook
get
List organization webhooks
get
Simulate organization webhook
post
User Management
Add a user to an organization
post
Get user by id
get
List users across the organization
get
Remove a user from an organization
del
Update users role in an enterprise
put
Update users role in organization
put
Policy
Policy Builder
Create policy rule
post
Deactivate policy rule
del
Get policy rule
get
List actions
get
List conditions for scope
get
List conditions for touchpoint
get
List organization policy rules
get
List policy rules
get
List policy-rule versions
get
List scopes
get
List touchpoints
get
Update policy rule
put
Wallet Policy
Add wallet-policy rule
post
Delete wallet-policy rule
del
Update wallet-policy rule
put
SCIM
Creates a new user via SCIM 2.0 provisioning.
post
Lists all SCIM-provisioned users in the requesting enterprise with support for pagination and filtering.
get
Retrieves a SCIM-provisioned user by their BitGo user ID.
get
Updates an existing SCIM-provisioned user using the PUT method (full replacement).
put
Settle (DVP)
Approval Requests
Update settlement approval request
put
Settlement Onboarding
Create settlement trading partner
post
Get settlement Go Account settings
get
List settlement trading partners
get
Settlement Signing
Get settlement signing
get
Sign settlement
post
Settlements
Create settlement
post
Get settlement by ID.
get
List settlements by account
get
List settlements by enterprise
get
Settle (Off Exchange)
Client Activation
Connect to partner
post
Create client
post
Get Client Connection
get
Get Signing Payload for Client Connections
get
List client connections
get
List Partners
Update Client Connection
put
Client Allocations & Deallocations
Allocate funds to partner connection
post
Deallocate Funds from Connection
post
Get client allocation or deallocation
get
Get Signing Payload for Client Allocations
get
Get Signing Payload for Client Deallocations
get
List client allocations and deallocations
get
List Partner-Supported Currencies
get
Client Balances
List client balances
get
Client Settlements & Transfers
Get Client Settlement
get
List client settlement transfers
get
List Client Settlements
get
Onboarding
Create Partner
post
Partner Activation
Get Partner Connection
get
List Partner Connections
get
Partner Allocations & Deallocations
Get partner allocation or deallocation
get
List partner allocations and deallocations
get
Update Partner Allocations
put
Update Partner Deallocations
put
Partner Balances
List partner balances
get
Partner Settlements & Transfers
v1partnersettlementsnonreconciledpostroute
Get Partner Settlement
get
Get Signing Payload for Partner External Deposits
get
Get Signing Payload for Partner Settlement
get
Initiate On-Chain Settlement
post
Initiate partner settlement
post
List Partner Settlements
get
Perform Partner Settlement
post
Post deposit info for an on-chain settlement
post
Partner Trades
Get Signing Payload for Partner Trades
get
Settlement Disputes
Close a dispute
post
Dispute a Settlement
post
List Settlement Disputes for a Client
get
List Settlement Disputes for a Partner
get
Update a Settlement Dispute
put
Stablecoin
Create stablecoin order
post
Get cross-chain total supply for a token
get
Get orders summary for enterprise
get
Get stablecoin order by ID
get
Get Token Constants
get
List stablecoin orders by enterprise
get
List supported assets
get
Stake
Go Account Staking
Finalize staking request for Go Account
post
Generate staking request for Go Account
post
Get staking request for Go Account
get
Get staking wallet attributes for Go Account
get
List staking requests by asset for Go Account
get
List staking requests for Go Account
get
List staking rewards by asset for Go Account
get
List staking rewards for Go Account
get
List staking wallets for Go Account
get
Staking History
Get staking accrual history
get
Get staking reward history
get
Staking Request
Cancel staking request
del
Create staking request
post
Get a staking transaction
get
List staking requests by asset
get
List staking requests by enterprise
get
List staking requests by ID
get
List Staking Requests for a Wallet
get
Sign staking transaction
post
Staking State Information
Get list of stake-able coins
get
Get staking license
get
Get staking requirements
get
Get staking totals at the enterprise level
get
List coins available for staking
get
List coins available to enterprise for staking
get
List staking delegations
get
List staking details by enterprise
get
List staking details by enterprise tokens
get
List staking details by wallet
get
List staking partnered validators
get
List staking rewards
get
List staking validators for a wallet
get
List staking wallet tokens
get
Trade
Accounts
Get Account Balance
get
Get Current User
get
List Accounts
get
Margin
Cancel collateral withdrawal request
patch
Close all margin positions
post
Cover all short margin positions
post
Create collateral withdrawal request
post
Get close position request details
get
Get collateral withdrawal request
get
Get margin risk profile
get
Get margin risk settings
get
Get net open margin position limits
get
Get net open margin positions
get
List available currencies for collateral
get
List close position requests
get
List collateral withdrawal requests
get
List orders for close position request
get
List transferred collateral
get
Transfer collateral for margin
post
Transfer margin position
post
Market Data
Get historical prices
get
Get spot prices
get
Order Book
Get Level1 Order Book
get
Get Level2 Order Book
get
Orders
Cancel Order
put
Get Order
get
Get Trade
get
List Orders
get
List Trades
get
Place Order
post
Products
List Currencies
get
List Products
get
Trade WebSocket
Get WebSocket connection
get
User Management Notification
Add device token for user
post
Get notification categories
get
Get notification mute settings
get
Get user subscriptions
get
Mute enterprise notifications
put
Mute wallet notifications
put
Remove device token for user
del
Set user subscriptions
put
Unmute enterprise notifications
del
Unmute wallet notifications
del
Wallet & Transact
Address
Create address
post
Deploy address
post
Forward tokens from address
post
Get address
get
Get cross-chain address balances
get
Get proof of address ownership
get
List addresses
get
List addresses sorted by balance
get
Update address
put
Federation
Look up user accounts by their Stellar address or id
get
Key
Create key
post
v2tsspubkeygetbycoin
Get key
get
Get keys
get
List keys
get
Lightning
Create a lightning invoice
post
Fetch lightning invoice for a payment hash
get
Fetch lightning invoices
get
Fetch lightning onchain transaction for a txid
get
Fetch lightning onchain transactions
get
Fetch lightning payment for a payment id
get
Fetch lightning payments
get
Lightning - Get Channel Backup
get
Lightning - List Invoices
get
Pending approval
Bulk update non-withdrawal pending approvals
put
Get pending approval
get
Get Transfer By Approval Id
get
List counts of pending approvals
get
List pending approvals
get
Update pending approval
put
Send label
Create send label
post
Delete send label
del
Get send label by id
get
List send labels
get
Update send label
put
Transfer
Change Fee
post
Get fee estimate
get
Get transfer
get
Get transfer by sequence id
get
List account wire withdrawals
get
List all transfers on all wallets in an enterprise
get
List transfers
get
List transfers on all wallets in an enterprise for a given coin and block height
get
Update comment
post
Update wire withdrawal
put
Transaction request
Create a signature share for a transaction on a transaction request
post
Create a signature share for the transaction request
post
Create ECDSA MPC challenge for message
post
Create ECDSA MPC challenge for transaction
post
Create transaction request
Create transfer for transaction request
post
Delete ECDSA MPC configurations
del
Delete signature shares on a transaction request.
del
Exchange commitments for EdDSA transactions (full)
post
Exchange commitments for EdDSA transactions (lite)
post
Get MPC settings.
get
Get transaction requests by enterprise
get
Get transaction requests by enterprise filtering by wallet permissions
get
Get transaction requests by wallet
get
Get transaction requests ready for signature
get
List ECDSA MPC configurations per enterprise
get
Rebuild transaction requests
post
Send a transaction request.
post
Sign transaction request
post
Update CoinSpecific field for Transaction Request For Wallet
put
Update Transaction Request For Wallet
put
Wallet
\[DEPRECATED\] Add wallet (advanced only)
Add wallet (advanced only)
Build a transaction
Build an approval transaction for ERC20 token
post
Cancel a wallet share
del
Check if a GG18 Wallet is ready to update to DKLS.
get
Consolidate account (advanced)
post
Consolidate unspents (advanced)
post
Create message-based transaction request
post
Delete wallet
del
Freeze the wallet for the given coin and wallet id.
post
Get average fee
post
Get balance reserve data
get
Get list of potentially stuck transactions and their nonces for eth-like coins
get
Get maximum spendable
get
Get pinned wallet count
get
Get the token allowance for a specific token contract address
get
Get wallet by address
get
Get wallet by coin and ID
get
Get wallet by ID
get
Get Wallet Cross Chain Unspents
get
Get wallet fee address balances
get
Get wallets count
get
Initiate a transaction
post
Initiate a trustline transaction
post
List derived wallets for an EVM keyring
get
List forwarder addresses and balances
get
List last 10 contract sequenceIds of a wallet
get
List total balances
get
List total balances by coin
get
List unspent reservation
get
List unspents on a wallet
get
List wallet share requests
get
List wallets
get
List wallets by coin
get
Look up material
get
Make unspent reservation
post
Modifying unspent reservation
put
Pin or unpin a wallet
put
Release unspent reservation
del
Remove user from wallet
del
Request wallet access
post
Send a half-signed transaction
Send funds to forwarder
post
Update wallet
put
Wallet share
Create a wallet share
post
Get wallet share
get
Get wallet share V1
get
List counts of wallet shares
get
List wallet shares
get
Reject a wallet reshare request
post
Request wallet reshare
post
Resend a wallet share invitation email
post
Update a wallet share
post
Webhook
Add block webhook
post
Add wallet webhook
post
Create webhook secret
post
List block webhooks
get
List wallet webhooks
get
Remove block webhook
del
Remove wallet webhook
del
Simulate block webhook
post
Simulate wallet webhook
post
Verify Webhook Notification
post
Get SCIM User
Retrieves a user by ID via SCIM provisioning
