POST

Advanced Wallets - Consolidate and Recover Assets

Recover assets from an advanced wallet with a balance in multiple receive addresses. Build, sign, and send a consolidation and recovery, all in one call. Sign using your user and backup keys. Works for both multisignature and MPC recoveries.

Retrieves the private keys from KMS using the provided public keys or common keychain, then signs and returns the broadcastable transaction hex.

Note: This endpoint only works when AWM and MBE are running in recovery mode.

To recover assets from an advanced wallet with a balance only in the base address, use Advanced Wallets - Recover Assets.

Use this endpoint only with advanced wallets. For other wallet types, use the Wallet Recovery Wizard.

Path Params

coin string required

Body Params

object

Request type for wallet recovery consolidations endpoint. Used to consolidate and recover funds from multiple addresses in a wallet, via signing with user and backup keys.

userPub string

The user's public key for standard multisig wallets. Required for onchain multisig recovery consolidations.
backupPub string

The backup public key for standard multisig wallets. Required for onchain multisig recovery consolidations.
bitgoPub string

The BitGo public key for standard multisig wallets. Required for onchain UTXO multisig recovery consolidations.
multisigType string enum required

The type of wallet to recover - onchain: Traditional multisig wallets. - tss: Threshold Signature Scheme wallets.

onchaintss
commonKeychain string

The common keychain for TSS wallets. Required when multisigType is 'tss'.
tokenContractAddress string

The token contract address for token recovery (e.g., ERC20 tokens on Ethereum or SPL tokens on Solana). Required when recovering specific tokens instead of the native coin.
startingScanIndex number

The starting index to scan for addresses to consolidate. Useful for limiting the scan range for better performance.
endingScanIndex number

The ending index to scan for addresses to consolidate. Useful for limiting the scan range for better performance.

Defaults to 20
apiKey string

API key for blockchain explorer services. Required for some coins to build recovery transactions.
durableNonces object

Durable nonces configuration for Solana transactions. Provides transaction durability for Solana recovery operations. Refer to https://github.com/BitGo/wallet-recovery-wizard/blob/master/DURABLE_NONCE.md on durable nonce creation.
durableNonces object
- publicKeys array of strings required
- secretKey string required
  
  The secret key of the durable nonce account.

Responses

200

No response body

400

Bad Request

Response Body

object

error string required

The error name
details string required

Error details

404

Not Found

Response Body

object

error string required

The error name
details string required

Error details

409

Conflict

Response Body

object

error string required

The error name
details string required

Error details

422

Unprocessable Entity

Response Body

object

error string required

The error name
details string required

Error details

500

Internal Server Error

Response Body

object

error string required

The error name
details string required

Error details

501

Not Implemented

Response Body

object

error string required

The error name
details string required

Error details

curl --request POST \ --url 'http://localhost:3080/api/v1/coin/advancedwallet/recoveryconsolidations' \ --header 'accept: application/json' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'content-type: application/json' \ --data '{,"userPub":"xpub661MyMwAqRbcGCNnmzqt3u5KhxmXBHiC78cwAyUMaKJXpFDfHpJwNap6qpG1Kz2SPexKXy3akhPQz7GDYWpHNWkLxRLj6bDxQSf74aTAP9y","backupPub":"xpub661MyMwAqRbcGCNnmzqt3u5KhxmXBHiC78cwAyUMaKJXpFDfHpJwNap6qpG1Kz2SPexKXy3akhPQz7GDYWpHNWkLxRLj6bDxQSf74aTAP9y","bitgoPub":"xpub661MyMwAqRbcGCNnmzqt3u5KhxmXBHiC78cwAyUMaKJXpFDfHpJwNap6qpG1Kz2SPexKXy3akhPQz7GDYWpHNWkLxRLj6bDxQSf74aTAP9y","multisigType":"onchain","commonKeychain":"0280ec751d3b165a48811b2cc90f90dcf323f33e8bcaadc0341e1e010adcdcf7005afde80dd286d65b6be947af0424dd1e9f7611f3d20e02a4fc84ad8c8b74c1a5","tokenContractAddress":""EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v" // USDC on Solana","startingScanIndex":0,"endingScanIndex":100,"apiKey":"v2x8d5e46cf15a7b9b7xc60685d4f56xd8bd5f5cdcef3c1e9d4399c955d587179b","durableNonces":{,"publicKeys":["BurablNonc1234567890123456789012345678901","BurablNonc1234567890123456789012345678902"],"secretKey":"3XNrU5JSPs2VnZCLnWK8GDzB6Pqoy3tYNMJJVesKBXnGqRxwdXDg2QKgv7E9a6QbAiKnLHSxysKWgXDKNdfXZCQM"}}'

require 'uri' require 'net/http' url = URI("http://localhost:3080/api/v1/coin/advancedwallet/recoveryconsolidations") http = Net::HTTP.new(url.host, url.port) request = Net::HTTP::Post.new(url) request["accept"] = 'application/json' request["Authorization"] = 'Bearer YOUR_ACCESS_TOKEN' request["content-type"] = 'application/json' request.body = '{,"userPub":"xpub661MyMwAqRbcGCNnmzqt3u5KhxmXBHiC78cwAyUMaKJXpFDfHpJwNap6qpG1Kz2SPexKXy3akhPQz7GDYWpHNWkLxRLj6bDxQSf74aTAP9y","backupPub":"xpub661MyMwAqRbcGCNnmzqt3u5KhxmXBHiC78cwAyUMaKJXpFDfHpJwNap6qpG1Kz2SPexKXy3akhPQz7GDYWpHNWkLxRLj6bDxQSf74aTAP9y","bitgoPub":"xpub661MyMwAqRbcGCNnmzqt3u5KhxmXBHiC78cwAyUMaKJXpFDfHpJwNap6qpG1Kz2SPexKXy3akhPQz7GDYWpHNWkLxRLj6bDxQSf74aTAP9y","multisigType":"onchain","commonKeychain":"0280ec751d3b165a48811b2cc90f90dcf323f33e8bcaadc0341e1e010adcdcf7005afde80dd286d65b6be947af0424dd1e9f7611f3d20e02a4fc84ad8c8b74c1a5","tokenContractAddress":""EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v" // USDC on Solana","startingScanIndex":0,"endingScanIndex":100,"apiKey":"v2x8d5e46cf15a7b9b7xc60685d4f56xd8bd5f5cdcef3c1e9d4399c955d587179b","durableNonces":{,"publicKeys":["BurablNonc1234567890123456789012345678901","BurablNonc1234567890123456789012345678902"],"secretKey":"3XNrU5JSPs2VnZCLnWK8GDzB6Pqoy3tYNMJJVesKBXnGqRxwdXDg2QKgv7E9a6QbAiKnLHSxysKWgXDKNdfXZCQM"}}' response = http.request(request) puts response.read_body

<?php require_once('vendor/autoload.php'); $client = new \GuzzleHttp\Client(); $response = $client->request('POST', 'http://localhost:3080/api/v1/coin/advancedwallet/recoveryconsolidations', [ 'headers' => [ 'accept' => 'application/json', 'Authorization' => 'Bearer YOUR_ACCESS_TOKEN', 'content-type' => 'application/json', ], 'body' => '{,"userPub":"xpub661MyMwAqRbcGCNnmzqt3u5KhxmXBHiC78cwAyUMaKJXpFDfHpJwNap6qpG1Kz2SPexKXy3akhPQz7GDYWpHNWkLxRLj6bDxQSf74aTAP9y","backupPub":"xpub661MyMwAqRbcGCNnmzqt3u5KhxmXBHiC78cwAyUMaKJXpFDfHpJwNap6qpG1Kz2SPexKXy3akhPQz7GDYWpHNWkLxRLj6bDxQSf74aTAP9y","bitgoPub":"xpub661MyMwAqRbcGCNnmzqt3u5KhxmXBHiC78cwAyUMaKJXpFDfHpJwNap6qpG1Kz2SPexKXy3akhPQz7GDYWpHNWkLxRLj6bDxQSf74aTAP9y","multisigType":"onchain","commonKeychain":"0280ec751d3b165a48811b2cc90f90dcf323f33e8bcaadc0341e1e010adcdcf7005afde80dd286d65b6be947af0424dd1e9f7611f3d20e02a4fc84ad8c8b74c1a5","tokenContractAddress":""EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v" // USDC on Solana","startingScanIndex":0,"endingScanIndex":100,"apiKey":"v2x8d5e46cf15a7b9b7xc60685d4f56xd8bd5f5cdcef3c1e9d4399c955d587179b","durableNonces":{,"publicKeys":["BurablNonc1234567890123456789012345678901","BurablNonc1234567890123456789012345678902"],"secretKey":"3XNrU5JSPs2VnZCLnWK8GDzB6Pqoy3tYNMJJVesKBXnGqRxwdXDg2QKgv7E9a6QbAiKnLHSxysKWgXDKNdfXZCQM"}}', ]); echo $response->getBody();

import requests url = "http://localhost:3080/api/v1/coin/advancedwallet/recoveryconsolidations" payload = {,"userPub":"xpub661MyMwAqRbcGCNnmzqt3u5KhxmXBHiC78cwAyUMaKJXpFDfHpJwNap6qpG1Kz2SPexKXy3akhPQz7GDYWpHNWkLxRLj6bDxQSf74aTAP9y","backupPub":"xpub661MyMwAqRbcGCNnmzqt3u5KhxmXBHiC78cwAyUMaKJXpFDfHpJwNap6qpG1Kz2SPexKXy3akhPQz7GDYWpHNWkLxRLj6bDxQSf74aTAP9y","bitgoPub":"xpub661MyMwAqRbcGCNnmzqt3u5KhxmXBHiC78cwAyUMaKJXpFDfHpJwNap6qpG1Kz2SPexKXy3akhPQz7GDYWpHNWkLxRLj6bDxQSf74aTAP9y","multisigType":"onchain","commonKeychain":"0280ec751d3b165a48811b2cc90f90dcf323f33e8bcaadc0341e1e010adcdcf7005afde80dd286d65b6be947af0424dd1e9f7611f3d20e02a4fc84ad8c8b74c1a5","tokenContractAddress":""EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v" // USDC on Solana","startingScanIndex":0,"endingScanIndex":100,"apiKey":"v2x8d5e46cf15a7b9b7xc60685d4f56xd8bd5f5cdcef3c1e9d4399c955d587179b","durableNonces":{,"publicKeys":["BurablNonc1234567890123456789012345678901","BurablNonc1234567890123456789012345678902"],"secretKey":"3XNrU5JSPs2VnZCLnWK8GDzB6Pqoy3tYNMJJVesKBXnGqRxwdXDg2QKgv7E9a6QbAiKnLHSxysKWgXDKNdfXZCQM"}} headers = { "accept": "application/json", "Authorization": "Bearer YOUR_ACCESS_TOKEN", "content-type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.text)