Delete Wallets
Overview
You can delete wallets from your enterprise that you no longer want to use. Once you delete a wallet from your enterprise you can't view or access it. However, the wallet does remain visible and accessible to other wallet users. If you're the only wallet user, then the wallet must have a 0 balance before you can delete it from your enterprise. Therefore, to delete a wallet from your enterprise and prevent anyone from accessing it, transfer all assets out of the wallet and remove the users before deleting it.
Once deleted, wallets are identified by the isDeleted boolean.
Note: If you need to restore a deleted wallet, contact BitGo support at [email protected].
Prerequisites
Steps
import { BitGoAPI } from '@bitgo/sdk-api';
import { Tstx } from '@bitgo/sdk-coin-stx';
// Fill in with actual access token
const accessToken = '<your_actual_access_token>';
const walletId = '<your_actual_wallet_id>';
// Initialize the SDK
const bitgo = new BitGoAPI({
accessToken: accessToken,
env: 'test',
});
const coin = '<your_coin_name>';
bitgo.register(coin, Tstx.createInstance);
const wallet = await bitgo.coin(coin).wallets().get({ id: walletId });
console.log('Wallet :', wallet);
const delWallet = await wallet.remove();
console.log('Wallet removed :', delWallet);
DELETE /api/v2/{coin}/wallet/{walletId}
Step Result
The wallet is no longer visible or accessible to you.
{
"admin": {
"policy": {
"id": "59cd72485007a239fb00282ed480da1f",
"date": "2019-08-24T14:15:22Z",
"label": "string",
"latest": true,
"rules": [
{
"id": "string",
"lockDate": "2019-08-24T14:15:22Z",
"mutabilityConstraint": "managed",
"coin": "btc",
"type": "advancedWhitelist",
"condition": {
"amountString": "2000000",
"timeWindow": 2678400,
"groupTags": [
"59cd72485007a239fb00282ed480da1f"
],
"excludeTags": [
"59cd72485007a239fb00282ed480da1f"
]
},
"action": {
"type": "deny",
"approvalsRequired": 1,
"userIds": [
"59cd72485007a239fb00282ed480da1f"
]
}
}
],
"version": 0
}
},
"allowBackupKeySigning": true,
"approvalsRequired": 1,
"balanceString": "string",
"buildDefaults": {
"minFeeRate": 12000
},
"coin": "btc",
"coinSpecific": {
"creationFailure": [
"b8a828b98dbf32d9fd1875cbace9640ceb8c82626716b4a64203fdc79bb46d26"
],
"pendingChainInitialization": true,
"rootAddress": "GCTTCPH4IIDK7P72FFAEJ3ZFN6WDHJH6GGMRPHPM56ZWGIQ7B3XTIJAM",
"stellarUsername": "[email protected]",
"homeDomain": "bitgo.com",
"stellarAddress": "[email protected]*bitgo.com"
},
"custodialWallet": {},
"custodialWalletId": "59cd72485007a239fb00282ed480da1f",
"deleted": true,
"disableTransactionNotifications": true,
"enterprise": "59cd72485007a239fb00282ed480da1f",
"freeze": {
"time": "string",
"expires": "string"
},
"id": "59cd72485007a239fb00282ed480da1f",
"isCold": true,
"keys": [
"585951a5df8380e0e304a553",
"585951a5df8380e0e30d645c",
"585951a5df8380e0e30b6147"
],
"label": "My Wallet",
"m": 2,
"n": 3,
"nodeId": "59cd72485007a239fb00282ed480da1f",
"receiveAddress": {
"id": "59cd72485007a239fb00282ed480da1f",
"address": "2MvrwRYBAuRtPTiZ5MyKg42Ke55W3fZJfZS",
"chain": 1,
"index": 0,
"coin": "string",
"lastNonce": -1,
"wallet": "59cd72485007a239fb00282ed480da1f",
"coinSpecific": {
"xlm": {
"memoId": "2000000",
"rootAddress": "GCTTCPH4IIDK7P72FFAEJ3ZFN6WDHJH6GGMRPHPM56ZWGIQ7B3XTIJAM"
},
"txlm": {
"memoId": "2000000",
"rootAddress": "GCTTCPH4IIDK7P72FFAEJ3ZFN6WDHJH6GGMRPHPM56ZWGIQ7B3XTIJAM"
}
},
"balance": {
"updated": "2019-08-24T14:15:22Z",
"balance": 50000,
"balanceString": "50000",
"totalReceived": 0,
"totalSent": 0,
"confirmedBalanceString": "40000",
"spendableBalanceString": "40000"
},
"label": "Bob's Hot Wallet Address",
"addressType": "p2sh"
},
"recoverable": true,
"tags": [
"59cd72485007a239fb00282ed480da1f"
],
"spendableBalanceString": "string",
"startDate": "string",
"type": "cold",
"users": [
{
"user": "55e8a1a5df8380e0e30e20c6",
"permissions": [
"admin",
"view",
"spend"
]
}
],
"customChangeKeySignatures": {
"user": "string",
"backup": "string",
"bitgo": "string"
},
"multisigType": "onchain"
}See Also
Updated 22 days ago