Keys

Create an identity key pair.

post

https://studio-api.cheqd.nethttps://studio-api-staging.cheqd.nethttp://localhost:3000

/key/create

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

Authorizations

ApiKeyAuth

x-api-keystringRequired

Query parameters

typestring · enumOptional

Key type of the identity key pair to create.

Possible values:

Responses

200

The request was successful.

application/json

400

A problem with the input fields has occurred. Additional state information plus metadata may be available in the response body.

application/json

401

Access token is missing or invalid

500

An internal error has occurred. Additional state information plus metadata may be available in the response body.

application/json

post

/key/create

HTTPcURLJavaScriptPython

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

https://studio-api.cheqd.nethttps://studio-api-staging.cheqd.nethttp://localhost:3000

/key/import

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

Authorizations

ApiKeyAuth

x-api-keystringRequired

Body

application/x-www-form-urlencodedapplication/json

aliasstringOptional

typestring · enumOptionalPossible values:

privateKeyHexstringOptional

Responses

200

The request was successful.

application/json

400

A problem with the input fields has occurred. Additional state information plus metadata may be available in the response body.

application/json

401

Access token is missing or invalid

500

An internal error has occurred. Additional state information plus metadata may be available in the response body.

application/json

post

/key/import

HTTPcURLJavaScriptPython

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'"

application/x-www-form-urlencodedapplication/json

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

Fetch an identity key pair.

get

https://studio-api.cheqd.nethttps://studio-api-staging.cheqd.nethttp://localhost:3000

/key/read/{kid}

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

ApiKeyAuth

x-api-keystringRequired

Path parameters

kidstringRequired

Key ID of the identity key pair to fetch.

Responses

200

The request was successful.

application/json

400

A problem with the input fields has occurred. Additional state information plus metadata may be available in the response body.

application/json

401

Access token is missing or invalid

500

An internal error has occurred. Additional state information plus metadata may be available in the response body.

application/json

get

/key/read/{kid}

HTTPcURLJavaScriptPython

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"
}

Convert a key to a W3C Verification Method.

get

https://studio-api.cheqd.nethttps://studio-api-staging.cheqd.nethttp://localhost:3000

/key/{kid}/verification-method

This endpoint converts a stored key (by key ID) into a W3C Verification Method format.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Path parameters

kidstringRequired

Key ID of the identity key pair to convert.

Query parameters

verificationMethodTypestring · enumRequired

Type of verification method to use for the DID. See DID Core specification for more details. Only the types listed below are supported.

Possible values:

controllerstringOptional

Controller DID of the verification method

idstringOptional

Verification Method Id Fragment

Responses

200

The request was successful.

application/json

400

A problem with the input fields has occurred. Additional state information plus metadata may be available in the response body.

application/json

401

Access token is missing or invalid

404

The key was not found.

application/json

500

An internal error has occurred. Additional state information plus metadata may be available in the response body.

application/json

get

/key/{kid}/verification-method

HTTPcURLJavaScriptPython

GET /key/{kid}/verification-method?verificationMethodType=Ed25519VerificationKey2018 HTTP/1.1
Host: studio-api.cheqd.net
x-api-key: YOUR_API_KEY
Accept: */*

{
  "controller": "did:cheqd:testnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0",
  "id": "did:cheqd:testnet :7bf81a20-633c-4cc7-bc4a-5a45801005e0#key-1",
  "publicKeyBase58": "BTJiso1S4iSiReP6wGksSneGfiKHxz9SYcm2KknpqBJt",
  "type": "Ed25519VerificationKey2018"
}