Create Identity Keys and Subject DIDs

Create holder Decentralized Identifiers (DIDs), of method did:key, and associated identity keys using cheqd Studio.

Issuers may want to create identity keypairs for multiple reasons, such as for signing payloads or for creating did:key DIDs.

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: 
x-api-key: YOUR_API_KEY
Accept: */*

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

There is also an option to fetch an identity keypair by inputting a Key ID (kid) as a request format.

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: 
x-api-key: YOUR_API_KEY
Accept: */*

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

Creating a Subject DID

cheqd Studio currently supports one types of subject DIDs:

  • did:key

With the former, you can follow the did:key specification to create a subject DID based on a generated keypair.

Last updated

Was this helpful?