Create Issuer DID

Create a DID using the did:cheqd method

To create a cheqd DID (did:cheqd) and associated DID Document there are two ways of building the payload for the request:

Step 1: Set up your account

Make sure you have set up your account with cheqd Studio and are logged in, using our guide below:

Set up your account

Set up your account with cheqd Studio and get your API key to start using the APIs.

Step 2: Create a DID and associated DID Document

Using the /did/create API, users have two options for creating a did:cheqd DID and associated DID Document on-ledger:

1. Filling out a simple form using the application/x-www-url-form-encoded option within an API client of your choice.

2. Compiling a DID Document body yourself using the application/json option within an API client of your choice.

Create a DID Document.

This endpoint creates a DID and associated DID Document. As input, it can take the DID Document parameters via a form, or the fully-assembled DID Document itself.

post

/did/create

Authorizations

Body

application/x-www-form-urlencodedapplication/json

keystring

The unique identifier in hexadecimal public key format used in the verification method to create the DID.

networkstring · enum

Network to create the DID on (testnet or mainnet)

Options: testnet, mainnet

identifierFormatTypestring · enum

Algorithm to use for generating the method-specific ID. The two styles supported are UUIDs and Indy-style Base58. See <a href="https://docs.cheqd.io/identity/architecture/adr-list/adr-001-cheqd-did-method#cheqd-did-method-did-cheqd">cheqd DID method documentation</a> for more details.

Options: uuid, base58btc

verificationMethodTypestring · enum

Type of verification method to use for the DID. See <a href="https://www.w3.org/TR/did-core/#verification-methods">DID Core specification</a> for more details. Only the types listed below are supported.

Options: Ed25519VerificationKey2018, JsonWebKey2020, Ed25519VerificationKey2020

@contextstring[]

Example: ["https://www.w3.org/ns/did/v1"]

serviceobject[]

It's a list of special objects which are designed to build the actual service. It's almost the same as in <a href="https://www.w3.org/TR/did-core/#services">DID Core specification</a>, but instead of id it utilises idFragment field for making the right id for each service. !!! WARN. Cause swagger-ui does not handle x-ww-form based arrays correctly, please frame all your services in brackets while using swagger UI. !!!

Example: [{"idFragment":"service-1","type":"LinkedDomains","serviceEndpoint":["https://example.com"]}]

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/did/create' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data '{"network":"testnet","identifierFormatType":"uuid","verificationMethodType":"Ed25519VerificationKey2018","@context":["https://www.w3.org/ns/did/v1"],"service":[{"idFragment":"service-1","type":"LinkedDomains","serviceEndpoint":["https://example.com"]}]}'

200

400

401

500

200

{
  "did": "text",
  "controllerKeyId": "text",
  "keys": [
    {}
  ],
  "services": [
    {
      "id": "did:cheqd:mainnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0#service-1",
      "type": "LinkedDomains",
      "serviceEndpoint": [
        "https://example.com"
      ]
    }
  ]
}

The request was successful.

Option 1. Choose from a few variables and we will compile the DID for you

This is the easiest way to create DIDs on cheqd and is recommended for users who are not overly familiar with compiling DID Documents.

Using the application/x-www-url-form-encoded option, users are able to choose between the following variables to compile your DID:

network (required)

• "testnet" (recommended for testing)

• "mainnet" (recommended for production)

methodSpecificIdAlgo (required)

• "uuid" - this is a Universally Unique Identifier (recommended)

• "base58btc" - this is an identifier which is commonly used for Hyperledger Indy transactions

verificationMethod / type (required)

• "Ed25519VerificationKey2018" (recommended)

• "Ed25519VerificationKey2020"

• "JSONWebKey2020"

assertionMethod (optional)

• true (recommended if used for issuing Verifiable Credentials)

• false

didDocument (optional)

This input field contains either a complete DID document, or an incremental change (diff) to a DID document. For example:

{
  "service": [
    {
      "id": "did:cheqd:testnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0#service-1",
      "type": "LinkedDomains",
      "serviceEndpoint": [
        "https://example.com"
      ]
    }
  ]
}

From this request, the Credential Service will automatically create and publish a DID and associated DID Document to the ledger and return it as a response.

Option 2. Publish a DID Document body yourself

Instead of generating a DID Document using simple parameters, you can create a fully formatted DID Document yourself. Before, submitting a manually created DID, you will need to have created a set of identity keys to input the key material into the DID document.

Step 1: Create a new keypair

Use the /key/create API to generate a new keypair within the Credential Service key management store. Copy the "publicKeyHex".

Step 2: Utilise the DID Document template helper

To simplify this process of formatting a DID Document using your own keys, we've created a Helper Tool in our DID Registrar here. Simply paste in your publicKeyHex and choose the variables to compile your DID Document template.

Step 3: Paste the response

Within the /did/create JSON payload, paste the response of your DID Document template, with your own signing keys.

Request format:

{
  "didDocument": {
    "id": "did:cheqd:testnet:0ff9df5d-653b-4f77-a66c-0035abc34d63",
    "controller": [
      "did:cheqd:testnet:0ff9df5d-653b-4f77-a66c-0035abc34d63"
    ],
    "verificationMethod": [
      {
        "id": "did:cheqd:testnet:0ff9df5d-653b-4f77-a66c-0035abc34d63#key-1",
        "type": "JsonWebKey2020",
        "controller": "did:cheqd:testnet:0ff9df5d-653b-4f77-a66c-0035abc34d63",
        "publicKeyJwk": {
          "crv": "Ed25519",
          "kty": "OKP",
          "x": "BFSLOxwMJgpmWRtTUuo0JAvz6VXGp4WDDcN0dFfCQKo"
        }
      }
    ],
    "authentication": [
      "did:cheqd:testnet:0ff9df5d-653b-4f77-a66c-0035abc34d63#key-1"
    ]
  }
}

Step 3: Hit execute on the API

Hit execute on the API below to create your did:cheqd DID and associated DID Document.

Create a DID Document.

This endpoint creates a DID and associated DID Document. As input, it can take the DID Document parameters via a form, or the fully-assembled DID Document itself.

post

/did/create

Authorizations

Body

application/x-www-form-urlencodedapplication/json

keystring

The unique identifier in hexadecimal public key format used in the verification method to create the DID.

networkstring · enum

Network to create the DID on (testnet or mainnet)

Options: testnet, mainnet

identifierFormatTypestring · enum

Algorithm to use for generating the method-specific ID. The two styles supported are UUIDs and Indy-style Base58. See <a href="https://docs.cheqd.io/identity/architecture/adr-list/adr-001-cheqd-did-method#cheqd-did-method-did-cheqd">cheqd DID method documentation</a> for more details.

Options: uuid, base58btc

verificationMethodTypestring · enum

Type of verification method to use for the DID. See <a href="https://www.w3.org/TR/did-core/#verification-methods">DID Core specification</a> for more details. Only the types listed below are supported.

Options: Ed25519VerificationKey2018, JsonWebKey2020, Ed25519VerificationKey2020

@contextstring[]

Example: ["https://www.w3.org/ns/did/v1"]

serviceobject[]

It's a list of special objects which are designed to build the actual service. It's almost the same as in <a href="https://www.w3.org/TR/did-core/#services">DID Core specification</a>, but instead of id it utilises idFragment field for making the right id for each service. !!! WARN. Cause swagger-ui does not handle x-ww-form based arrays correctly, please frame all your services in brackets while using swagger UI. !!!

Example: [{"idFragment":"service-1","type":"LinkedDomains","serviceEndpoint":["https://example.com"]}]

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/did/create' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data '{"network":"testnet","identifierFormatType":"uuid","verificationMethodType":"Ed25519VerificationKey2018","@context":["https://www.w3.org/ns/did/v1"],"service":[{"idFragment":"service-1","type":"LinkedDomains","serviceEndpoint":["https://example.com"]}]}'

200

400

401

500

200

{
  "did": "text",
  "controllerKeyId": "text",
  "keys": [
    {}
  ],
  "services": [
    {
      "id": "did:cheqd:mainnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0#service-1",
      "type": "LinkedDomains",
      "serviceEndpoint": [
        "https://example.com"
      ]
    }
  ]
}

The request was successful.

List DIDs associated with your account

After creating a DID or multiple DIDs, users can list all the created DIDs associated with their account. Using the /did/list API.

Fetch DIDs associated with an account.

This endpoint returns the list of DIDs controlled by the account.

get

/did/list

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/did/list' \
  --header 'x-api-key: YOUR_API_KEY'

200

400

401

500

200

[
  "text"
]

The request was successful.

Alternatives

Below are a list of alternatives for creating cheqd DIDs.

Credo

Credo is an SDK which supports the European Architecture and Reference Framework (ARF) standards as well as AnonCreds with full cheqd support for DIDs.

Veramo

The Veramo SDK Plugin supports JSON, JSON-LD credentials as well as cheqd Credential Payments in an SDK.

Walt.id Community Stack

Walt.id Community Stack is an SDK that supports the European Architecture and Reference Framework (ARF) standards for identity, with full cheqd support.

DID Registrar

Simple setup for building cheqd DIDs into existing applications using REST APIs, building into the Universal Registrar.

cheqd Cosmos CLI

Cosmos CLI which directly communicates with the cheqd network. This should only be used for testing environments.