Get key

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

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 or token ticker symbol.
    Example: "btc"
  • idOrPubstringRequired
    Key ID or pub

200 Response

One of
encryptedPrv string
The encrypted private key
id string required
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
isBitGo boolean
"true" if this key is owned by BitGo
Example: false
source string
Allowed values: backup bitgo cold user
Example: user
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
pub string
public part of a key pair
Example: xpub661MyMwAqRbcGMVhmc7wqQRYMtcX9LAvSj1pjB213y5TsrkV2uuzJjWnjBrT1FUeNWGPjaVm5p7o6jdNcQJrV1cy3a1R8NQ9m7LuYKA8RpH

400 Response

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