Ctrl+K

Create a key.

post/api/v2/{coin}/admin/key

Path Parameters

  • coinstringRequired
    A cryptocurrency symbol or token ticker symbol
    Example: btc
    Min length: >= 1 characters

Request Body

source string required
Allowed values: user cold bitgo backup
distributedCustodyOptions object
bitgoOrg string required
The BitGoOrg that will be used to create the key
Allowed values: BitGo Trust BitGo New York BitGo Germany BitGo Switzerland BitGo Europe ApS Frankfurt DE Trust BitGo Singapore BitGo Korea BitGo Custody MENA FZE BitGo India BitGo Sister Trust 1 BitGo Inc
pub string
Public part of this key pair. Required for all sources except `bitgo`.
Min length: >= 1 characters
Example: xpub661MyMwAqRbcGMVhmc7wqQRYMtcX9LAvSj1pjB213y5TsrkV2uuzJjWnjBrT1FUeNWGPjaVm5p7o6jdNcQJrV1cy3a1R8NQ9m7LuYKA8RpH
hsmType string
HSM to route to for key creation
Allowed values: institutional nitro SDTrustNitro
enterprise string
The Enterprise the key is created for
Min length: >= 1 characters
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$

200 Response

id string required
The unique identifier of the key
source string
The source of the key
Allowed values: user cold bitgo backup
providerName string
The name of the provider
pub string
The public key
ethAddress string
The Ethereum address
derivedFromParentWithSeed string
Indicates if the key was derived from a parent with a seed
type string
The type of the key
Allowed values: tss independent
commonKeychain string
The common keychain
commonPub string
The common public key
users array[object]
User array of the key, containing only the user ID and the public key (if exist) *
pub string
user string required

400 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id