Key

Get key

Changed on

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

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

Request

  • Base URL
    https://developers.bitgo.com
  • URL
    https://developers.bitgo.com/api/v2/{coin}/key/{id}
  • Auth
    none declared

Path parameters

coinstring required

A cryptocurrency symbol or token ticker symbol

Example:btc
idstring required

The key ID or the public key

Response

OK

idstring required
pubstring required

Public part of a key pair

ethAddressstring

Ethereum address associated with this key

derivedFromParentWithSeedstring
derivedFromParentWithPathstring
source'user' | 'cold' | 'bitgo' | 'backup' required
hsmType'institutional' | 'nitro' | 'SDTrustNitro' | 'frankfurtDETrustNitro' | 'awsKms'

The type of HSM that owns this key.

isBitGoboolean

"true" if this key is owned by BitGo

isTrustboolean

"true" if this key is owned by Trust

encryptedPrvstring

The encrypted private key

aspKeyIdnumber
coinSpecificobject
type'tss' | 'independent' required
commonKeychainstring

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.

verifiedVssProofboolean
commonPubstring

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.

commonPubSigstring
providerstring
distributedCustodystring
migratedFromstring
parentstring

The id of the parent key this key was derived from, if any

Example response

{
  "id": "59cd72485007a239fb00282ed480da1f",
  "pub": "xpub661MyMwAqRbcGMVhmc7wqQRYMtcX9LAvSj1pjB213y5TsrkV2uuzJjWnjBrT1FUeNWGPjaVm5p7o6jdNcQJrV1cy3a1R8NQ9m7LuYKA8RpH",
  "derivedFromParentWithPath": "m/0'",
  "hsmType": "institutional"
}

Changes

  • a7126d55243dRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the optional property to the response with the status

  • 1ce83f8f93b4Revision changes
    • info

      added the optional property to the response with the status