Get Key

Edit online

Retrieves information about a key by its ID.

HTTP request
GET /keys/{keyId}
Authorization requirements
Header Type Required Description
Authorization string Yes Bearer token used to authenticate the request. See Authentication flows for instructions on generating this token.
Path parameter
Parameter Type Required Description
keyId string Yes ID of the key to retrieve. Length: 1 to 64 characters.
Request body
curl --request GET \
  --url https://api.digitalassets.ibm.com/keys/{keyId} \
  --header 'Authorization: Bearer <token>'
Response
200: Success

Example response:

{
  "id": "key-01snl-t56gb-j8tsok0vn802p80i",
  "scheme": "ECDSA",
  "curve": "ed25519",
  "publicKey": "<string>",
  "status": "Active",
  "custodial": true,
  "dateCreated": "2023-04-14T20:41:28.715Z",
  "wallets": [
    {
      "id": "wa-5pfuu-9euek-h0odgb6snva8ph3k",
      "network": "Algorand"
    }
  ],
  "store": {
    "id": "<string>",
    "kind": "Hsm",
    "keyId": "key-01snl-t56gb-j8tsok0vn802p80i",
    "derivationPath": "<string>"
  },
  "masterKey": true,
  "derivedFrom": {
    "keyId": "key-01snl-t56gb-j8tsok0vn802p80i",
    "path": "<string>"
  },
  "name": "<string>",
  "imported": true,
  "exported": true,
  "dateExported": "2023-04-14T20:41:28.715Z",
  "dateDeleted": "2023-04-14T20:41:28.715Z"
}