1 of 1

Update a DID

Update a did:cheqd DID from ACA-Py Agent

Follow these instructions to update a did:cheqd DID from ACA-Py Agent.

⚠️ Important...
Your wallet must have the key(s) which were generated when the DID was created, without them signing will fail.

Update DID

To update an existing DID, you must pass the did id and the complete didDocumentin the request body. The main field that is updated using this method os the service object of the DID.

Update a DID

Update a did:cheqd DID from ACA-Py Agent

Follow these instructions to update a did:cheqd DID from ACA-Py Agent.

⚠️ Important...
Your wallet must have the key(s) which were generated when the DID was created, without them signing will fail.

Update DID

To update an existing DID, you must pass the did id and the complete didDocumentin the request body. The main field that is updated using this method os the service object of the DID.

Update a did:cheqd

POST/did/cheqd/update

Body

did*string

DID to update

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

Pattern:

^(did:cheqd:(testnet|mainnet):(?:(?:[a-zA-Z0-9]{21,22}|([a-z,0-9,-]{36,36}))*:)*((?:[a-zA-Z0-9]{21,22}|([a-z,0-9,-]{36,36}))+)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)([?][^#]*)?|did:cheqd:(testnet|mainnet):(?:(?:[a-zA-Z0-9]{21,22}|([a-z,0-9,-]{36,36}))*:)*((?:[a-zA-Z0-9]{21,22}|([a-z,0-9,-]{36,36}))+)/resources/([a-z,0-9,-]{36,36})([?][^#]*)?)$

didDocument*all of

DID Document to update

authentication*array of string

Authentication Methods

itemsstring

controller*array of string

DID Document controllers

itemsstring

id*string

DID ID

Example: "did:example:123"

servicearray of Service (object)

Services

id*string

Service ID

Example: "did:example:123#service-1"

serviceEndpoint*array of string

Array of Service endpoints

itemsstring

Service endpoint URL

type*string

Service Type

Example: "MessagingService"

verificationMethod*array of VerificationMethod (object)

Verification Methods

controller*string

Verification controller DID

id*string

Verification Method ID

Example: "did:example:123#key-1"

publicKeyBase58string

Public Key in base58 format

Example: "B12NYF8RZ5Zk.."

publicKeyJwkobject

Public Key in Jwk format

publicKeyMultibasestring

Public Key in multibase format

Example: "z6Mk..."

type*string

Type of Verification Method

Example: "Ed25519VerificationKey2018"

optionsobject

Additional configuration options

Response

Body

didstring

DID that has been updated

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

Pattern:

^(did:cheqd:(testnet|mainnet):(?:(?:[a-zA-Z0-9]{21,22}|([a-z,0-9,-]{36,36}))*:)*((?:[a-zA-Z0-9]{21,22}|([a-z,0-9,-]{36,36}))+)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)([?][^#]*)?|did:cheqd:(testnet|mainnet):(?:(?:[a-zA-Z0-9]{21,22}|([a-z,0-9,-]{36,36}))*:)*((?:[a-zA-Z0-9]{21,22}|([a-z,0-9,-]{36,36}))+)/resources/([a-z,0-9,-]{36,36})([?][^#]*)?)$

didState*string

State of the did update

successboolean

Flag to denote if the operation was successful

Example: true

Request

Response

Update a did:cheqd

POST/did/cheqd/update

Body

did*string

DID to update

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

Pattern:

^(did:cheqd:(testnet|mainnet):(?:(?:[a-zA-Z0-9]{21,22}|([a-z,0-9,-]{36,36}))*:)*((?:[a-zA-Z0-9]{21,22}|([a-z,0-9,-]{36,36}))+)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)([?][^#]*)?|did:cheqd:(testnet|mainnet):(?:(?:[a-zA-Z0-9]{21,22}|([a-z,0-9,-]{36,36}))*:)*((?:[a-zA-Z0-9]{21,22}|([a-z,0-9,-]{36,36}))+)/resources/([a-z,0-9,-]{36,36})([?][^#]*)?)$

didDocument*all of

DID Document to update

authentication*array of string

Authentication Methods

itemsstring

controller*array of string

DID Document controllers

itemsstring

id*string

DID ID

Example: "did:example:123"

servicearray of Service (object)

Services

id*string

Service ID

Example: "did:example:123#service-1"

serviceEndpoint*array of string

Array of Service endpoints

itemsstring

Service endpoint URL

type*string

Service Type

Example: "MessagingService"

verificationMethod*array of VerificationMethod (object)

Verification Methods

controller*string

Verification controller DID

id*string

Verification Method ID

Example: "did:example:123#key-1"

publicKeyBase58string

Public Key in base58 format

Example: "B12NYF8RZ5Zk.."

publicKeyJwkobject

Public Key in Jwk format

publicKeyMultibasestring

Public Key in multibase format

Example: "z6Mk..."

type*string

Type of Verification Method

Example: "Ed25519VerificationKey2018"

optionsobject

Additional configuration options

Response

Body

didstring

DID that has been updated

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

Pattern:

^(did:cheqd:(testnet|mainnet):(?:(?:[a-zA-Z0-9]{21,22}|([a-z,0-9,-]{36,36}))*:)*((?:[a-zA-Z0-9]{21,22}|([a-z,0-9,-]{36,36}))+)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)([?][^#]*)?|did:cheqd:(testnet|mainnet):(?:(?:[a-zA-Z0-9]{21,22}|([a-z,0-9,-]{36,36}))*:)*((?:[a-zA-Z0-9]{21,22}|([a-z,0-9,-]{36,36}))+)/resources/([a-z,0-9,-]{36,36})([?][^#]*)?)$

didState*string

State of the did update

successboolean

Flag to denote if the operation was successful

Example: true

Request

Response

const response = await fetch('/did/cheqd/update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "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",
        "service": [
          {
            "id": "did:cheqd:testnet:099be283-4302-40cc-9850-22016bcd1d86#service-1",
            "type": "MessagingService",
            "serviceEndpoint": [
              "https://example.com/service"
            ]
          }
        ],
        "verificationMethod": [
          {
            "id": "did:cheqd:testnet:099be283-4302-40cc-9850-22016bcd1d86#key-1",
            "type": "Ed25519VerificationKey2018",
            "controller": "did:cheqd:testnet:099be283-4302-40cc-9850-22016bcd1d86",
            "publicKeyMultibase": "z6Mk..."
          }
        ]
      }
    }),
});
const data = await response.json();

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