REST API›Wallet & Transact›Key

GET

Get key

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

Path Params

  • coin string required
    A cryptocurrency symbol or token ticker symbol
  • id string required
    The key ID or the public key

Responses

200
OK

Response Body

object

  • id string required

    matches ^[0-9a-f]{32}$

  • pub string required
    Public part of a key pair
  • ethAddress string
    Ethereum address associated with this key
  • derivedFromParentWithSeed string
  • source string enum required
    usercoldbitgobackup
  • hsmType string enum
    The type of HSM that owns this key.
    institutionalnitroSDTrustNitrofrankfurtDETrustNitroawsKms
  • isBitGo boolean
    "true" if this key is owned by BitGo
  • isTrust boolean
    "true" if this key is owned by Trust
  • encryptedPrv string
    The encrypted private key
  • aspKeyId number
  • coinSpecific map of objects
    coinSpecific object
    • <key> object
  • type string enum 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.

    Defaults to independent

    tssindependent
  • 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
    The common public key. This value is required to be set for MPC 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 of objects
    webauthnDevices object
    • authenticatorInfo object required
      The information about the authenticator
      authenticatorInfo object
      • credID string required
        The credential ID of the authenticator
      • fmt string required
        The format of the authenticator
      • publicKey string required
        The public key of the authenticator
    • encryptedPrv string required
      The encrypted private key
    • otpDeviceId string required
      The OTP device ID
    • prfSalt string required
      The PRF salt
  • migratedFrom string
  • parent string
    The id of the parent key this key was derived from, if any
400
Bad Request

Response Body

object

  • name string
    Error code
  • context map of objects required
    Properties that apply to a specific error name
    context object
    • <key> object
  • error string required
    Human-readable error message
  • requestId string required
    Client request id
404
Not Found

Response Body

object

  • name string
    Error code
  • context map of objects required
    Properties that apply to a specific error name
    context object
    • <key> object
  • error string required
    Human-readable error message
  • requestId string required
    Client request id
500
Internal Server Error

Response Body

object

  • name string
    Error code
  • context map of objects required
    Properties that apply to a specific error name
    context object
    • <key> object
  • error string required
    Human-readable error message
  • requestId string required
    Client request id