Ctrl+K

Get key

get/api/v2/{coin}/key/{id}

Get Key using either the key id or the pub. When using the public key, it will only return the mandatory fields.

Path Parameters

  • coinstringRequired
    A cryptocurrency symbol or token ticker symbol
    Example: "btc"
  • idstringRequired
    The key ID or the public key

200 Response

id string required
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
pub string required
Public part of a key pair
Example: xpub661MyMwAqRbcGMVhmc7wqQRYMtcX9LAvSj1pjB213y5TsrkV2uuzJjWnjBrT1FUeNWGPjaVm5p7o6jdNcQJrV1cy3a1R8NQ9m7LuYKA8RpH
ethAddress string
Ethereum address associated with this key
derivedFromParentWithSeed string
source string required
Allowed values: user cold bitgo backup
Example: user
isBitGo boolean
"true" if this key is owned by BitGo
Example: false
encryptedPrv string
The encrypted private key
aspKeyId number
coinSpecific object
type string required
A value from a string enum denoting what kind of key this is. Defaults to “independent” indicating an on-chain key is requested. If set to “tss” this tells us that a “tss” key is requested.
Allowed values: tss independent blsdkg
Default: independent
Example: tss
commonKeychain string
The commonKeychain for the key if this is a MPC key. This value is required to be set when the type is set to “tss” and when the source is either “user” or “backup”. Setting this indicates to BitGo that the owner of the key has received all key shares they needed for generating their key. This value is the concatenation of the common public key (32-byte) with the common chaincode (32-byte) as a hex string.
verifiedVssProof boolean
commonPub string
e common public key. This value is required to be set for BLS keys when the source is either "user" or "backup". Setting this indicates to BitGo that the owner of the key has received all key shares they needed for generating their key.
commonPubSig string
provider string
distributedCustody string
webauthnDevices array[object]
authenticatorInfo object required
The information about the authenticator
encryptedPrv string required
The encrypted private key
otpDeviceId string required
The OTP device ID
prfSalt string required
The PRF salt
migratedFrom string

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

404 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

500 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