Generate wallet

post/api/v2/{coin}/wallet/generate

This API call creates a new wallet. Under the hood, the SDK (or BitGo Express) does the following:

  1. Creates the user keychain locally on the machine, and encrypts it with the provided passphrase (skipped if userKey is provided).
  2. Creates the backup keychain locally on the machine.
  3. Uploads the encrypted user keychain and public backup keychain.
  4. Creates the BitGo key (and the backup key if backupXpubProvider is set) on the service.
  5. Creates the wallet on BitGo with the 3 public keys above.

ⓘ Ethereum wallets can only be created under an enterprise. Pass in the id of the enterprise to associate the wallet with. Your enterprise id can be seen by clicking on the “Manage Organization” link on the enterprise dropdown. Each enterprise has a fee address which will be used to pay for transaction fees on all Ethereum wallets in that enterprise. The fee address is displayed in the dashboard of the website, please fund it before creating a wallet.

ⓘ You cannot generate a wallet by passing in a subtoken as the coin. Subtokens share wallets with their parent coin and it is not possible to create a wallet specific to one token. Please see Coin-Specific Implementation for details.

ⓘ This endpoint should be called through BitGo Express if used without the SDK, such as when using cURL.

Path Parameters

  • coinstringRequired
    A cryptocurrency or token ticker symbol.
    Example: "btc"

Query Parameters

  • includeKeychainsbooleanDefault: false
    Include user, backup and bitgo keychains along with generated wallet

Request Body

label string required
Example: My Wallet
passphrase string
Passphrase to be used to encrypt the user key on the wallet
userKey string
User provided public key
backupXpub string
public part of a key pair
Example: xpub661MyMwAqRbcGMVhmc7wqQRYMtcX9LAvSj1pjB213y5TsrkV2uuzJjWnjBrT1FUeNWGPjaVm5p7o6jdNcQJrV1cy3a1R8NQ9m7LuYKA8RpH
backupXpubProvider string
Optional key recovery service to provide and store the backup key
Allowed value: keyternal
enterprise string
Enterprise id. This is required for Ethereum wallets since they can only be created as part of an enterprise
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
disableTransactionNotifications boolean
Flag for disabling wallet transaction notifications
passcodeEncryptionCode string
The passphrase used for decrypting the encrypted user private key during wallet recovery
coldDerivationSeed string
Seed used to derive an extended user key for a cold wallet
gasPrice integer
Gas price to use when deploying an Ethereum wallet
disableKRSEmail boolean
Flag for preventing KRS from sending email after creating backup key
walletVersion integer
(ETH only) Specify the wallet creation contract version used when creating a wallet contract. Use 0 for the old wallet creation, 1 for the new wallet creation, where it is only deployed upon receiving funds.
Minimum: >= 0
Maximum: <= 1
Default: 1
javascript
1 2 3 4 5 6 7 8 bitgo .coin('tltc') .wallets() .generateWallet({ label: 'My Test Wallet', passphrase: 'secretpassphrase1a5df8380e0e30' }) .then(function (wallet) { // print the new wallet console.dir(wallet); });

200 Response

One of
id string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
users array[object]
Ids of users with access to the wallet
permissions array[string]
Array of permissions for the user
coin string
Name of the blockchain the wallet is on
Example: tbtc
label string
Name the user assigned to the wallet
Example: My TBTC Wallet
m integer
Number of signatures required for the wallet to send
Example: 2
n integer
Number of signers on the wallet
Example: 3
keys array
Ids of wallet keys
keySignatures object
Signatures for the backup and BitGo public keys signed by the user key
backupPub string
Signature for the backup pub
Example: 1fe81d0c91457d89993b01475bfb9e5809067ae046926faeab6e63beea009d8dd460387e0c3843034570798a9c2bcc1dbbea2988ee5a36979e0bbe6e02f7840af2
bitgoPub string
Signature for the BitGo pub
Example: 209d0e9a6d4352b66fae0a35ce62c1059bcc4db9e2883abc4f1b3d20481c5cebb7299c581efd9e0151abaf2496da7c6d75d276de36ed3de37c94e9cc5a2ea77e59
tags array
Tags set on the wallet
receiveAddress object
id string
platform public id for an address
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
address string
Max length: <= 250 characters
Example: 2MvrwRYBAuRtPTiZ5MyKg42Ke55W3fZJfZS
chain integer
Allowed values: 0 1 10 11 20 21 30 31
Example: 1
index integer
coin string
lastNonce integer
Default: -1
wallet string
The wallet which contains this address
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
coinSpecific object
Properties which are specific to certain coin types
balance object
Balance of the address. In case of Eth and Celo, if returnBalancesForToken is passed with includeBalances, then it will return token balance in the address object. This field will be present only when "includeBalances" query param is passed as true.
labelOne of
A human-readable label for the address.
addressType string
Allowed values: p2sh p2sh-p2wsh p2wsh
Example: p2sh
balance integer
Wallet balance as number
Example: 0
balanceString string
Wallet balance as string
Example: 0
confirmedBalance integer
Confirmed wallet balance as number
Example: 0
confirmedBalanceString string
Confirmed wallet balance as string
Example: 0
spendableBalance integer
Spendable wallet balance as number
Example: 0
spendableBalanceString string
Spendable wallet balance as string
Example: 0
deleted boolean
Flag which indicates the wallet has been deleted
Example: false
isCold boolean
Flag for identifying cold wallets
Example: false
freeze object
Freeze state (used to stop the wallet from spending)
Example: {}
time string <date-time>
Time when the wallet becomes frozen
expires string <date-time>
Time when the wallet is unfrozen and allowed to spend
disableTransactionNotifications boolean
Flag for disabling wallet transaction notifications
Example: false
admin object
Admin data (wallet policies)
Example: {}
approvalsRequired integer
Number of admin approvals required for an action to fire
Example: 1
pendingApprovals array[object]
Pending approvals on the wallet
Example: []
wallet string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
createDate string <date-time>
infoAny of
stateAny of
scope string
What kind of entity the Pending Approval is tied to
Allowed values: enterprise wallet
userIds array
All the Users who should see this Pending Approval
walletLabel string
allowBackupKeySigning boolean
Flag for allowing signing with backup key
Example: false
coinSpecific object
Coin-specific data
clientFlags array[string]
recoverable boolean
Flag indicating whether this wallet's user key is recoverable with the passphrase held by the user.
startDate string <date-time>
Time when this wallet was created
hasLargeNumberOfAddresses boolean
Flag indicating that this wallet is large (more than 100,000 addresses). If this is set, some APIs may omit properties which are expensive to calculate for wallets with many addresses (for example, the total address counts returned by the List Addresses API).
config object
Custom configuration options for this wallet