Create a DID

Create a DID using the did:cheqd method from ACA-Py Agent

Follow these instructions to create a new DID from ACA-Py Agent and publish the associated DID Document on cheqd ledger.

⚠️ Before you begin...

Make sure you've correctly configured the cheqd plugin's agent settings for ACA-Py.

For wallet storage, utilise a Postgres database to ensure key persistence, enabling future updates to the DID.

Create DID

Populate the various optionsand featuresin the JSON request body and call the API to create the DID.

Create a did:cheqd

POST/did/cheqd/create

Body

application/json

featuresobject

Additional features to enable for the did.

Example: "{}"

optionsobject

Additional configuration options

Example: {"key_type":"ed25519","method_specific_id_algo":"uuid","network":"testnet"}

Response

200

Body

application/json

didstring

DID created

Example: "did:cheqd:testnet:099be283-4302-40cc-9850-22016bcd1d86"

didStateobject

The published didState

Example: {"did":"did:cheqd:testnet:099be283-4302-40cc-9850-22016bcd1d86","didDocument":{"authentication":["did:cheqd:testnet:099be283-4302-40cc-9850-22016bcd1d86#key-1"],"controller":["did:cheqd:testnet:099be283-4302-40cc-9850-22016bcd1d86"],"id":"did:cheqd:testnet:099be283-4302-40cc-9850-22016bcd1d86","verificationMethod":[{"id":"did:cheqd:testnet:099be283-4302-40cc-9850-22016bcd1d86#key-1","type":"Ed25519VerificationKey2020","controller":"did:cheqd:testnet:099be283-4302-40cc-9850-22016bcd1d86","publicKeyMultibase":"z6Mk..."}]},"secret":{"signingResponse":[{"kid":"did:cheqd:testnet:099be283-4302-40cc-9850-22016bcd1d86#key-1","signature":"SHFz..."}]},"state":"finished"}

successboolean

Flag to denote if the operation was successful

Example: true

verkeystring

Verification key

Example: "BnSWTUQmdYCewSGFrRUhT6LmKdcCcSzRGqWXMPnEP168"

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/did/cheqd/create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "features": "{}",
      "options": {
        "key_type": "ed25519",
        "method_specific_id_algo": "uuid",
        "network": "testnet"
      }
    }),
});
const data = await response.json();

Response

200

{
  "did": "did:cheqd:testnet:099be283-4302-40cc-9850-22016bcd1d86",
  "didState": {
    "did": "did:cheqd:testnet:099be283-4302-40cc-9850-22016bcd1d86",
    "didDocument": {
      "authentication": [
        "did:cheqd:testnet:099be283-4302-40cc-9850-22016bcd1d86#key-1"
      ],
      "controller": [
        "did:cheqd:testnet:099be283-4302-40cc-9850-22016bcd1d86"
      ],
      "id": "did:cheqd:testnet:099be283-4302-40cc-9850-22016bcd1d86",
      "verificationMethod": [
        {
          "id": "did:cheqd:testnet:099be283-4302-40cc-9850-22016bcd1d86#key-1",
          "type": "Ed25519VerificationKey2020",
          "controller": "did:cheqd:testnet:099be283-4302-40cc-9850-22016bcd1d86",
          "publicKeyMultibase": "z6Mk..."
        }
      ]
    },
    "secret": {
      "signingResponse": [
        {
          "kid": "did:cheqd:testnet:099be283-4302-40cc-9850-22016bcd1d86#key-1",
          "signature": "SHFz..."
        }
      ]
    },
    "state": "finished"
  },
  "success": true,
  "verkey": "BnSWTUQmdYCewSGFrRUhT6LmKdcCcSzRGqWXMPnEP168"
}

Request Body

These are the variables that can be passed in the Body:

features (optional)

Optional Object with Key-Value format for additional features of the new DID. This is for future use.

options (optional)

Optional Object with Key-Value format for additional configuration options, recommendations below:

"network": testnet or mainnet

"key_type": "ed25519" or "bls12381g2"

List DIDs associated with your wallet

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

List wallet DIDs

GET/wallet/did

Query parameters

Response

200

Body

application/json

resultsarray of object

DID list

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/wallet/did', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "results": [
    {
      "did": "did:peer:WgWxqztrNooG92RXvxSTWv",
      "key_type": "ed25519",
      "metadata": {},
      "method": "sov",
      "posture": "wallet_only",
      "verkey": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV"
    }
  ]
}