cheqd StudioSupport / Bug Reports

Keys

Create an identity key pair.

post

This endpoint creates an identity key pair associated with the user's account for custodian-mode clients.

Authorizations
Query parameters
typestring · enumOptional

Key type of the identity key pair to create.

Possible values:
Responses
200

The request was successful.

application/json
post
POST /key/create HTTP/1.1
Host: studio-api.cheqd.net
x-api-key: YOUR_API_KEY
Accept: */*

{
  "kid": "text",
  "type": "Ed25519",
  "publicKeyHex": "text"
}

Import an identity key pair.

post

This endpoint imports an identity key pair associated with the user's account for custodian-mode clients.

Authorizations
Body
aliasstringOptional
typestring · enumOptionalPossible values:
privateKeyHexstringOptional
Responses
200

The request was successful.

application/json
post
POST /key/import HTTP/1.1
Host: studio-api.cheqd.net
x-api-key: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 56

"alias='text'&type='Ed25519'&privateKeyHex='text'"
{
  "kid": "text",
  "type": "Ed25519",
  "publicKeyHex": "text"
}

Fetch an identity key pair.

get

This endpoint fetches an identity key pair's details for a given key ID. Only the user account associated with the custodian-mode client can fetch the key pair.

Authorizations
Path parameters
kidstringRequired

Key ID of the identity key pair to fetch.

Responses
200

The request was successful.

application/json
get
GET /key/read/{kid} HTTP/1.1
Host: studio-api.cheqd.net
x-api-key: YOUR_API_KEY
Accept: */*

{
  "kid": "text",
  "type": "Ed25519",
  "publicKeyHex": "text"
}

Was this helpful?