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

didstringrequired

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})([?][^#]*)?)$

optionsobject

Additional configuration options

Example: {"network":"testnet"}

didDocumentall ofrequired

DID Document to update

Example: {"id":"did:cheqd:testnet:099be283-4302-40cc-9850-22016bcd1d86","authentication":["did:cheqd:testnet:099be283-4302-40cc-9850-22016bcd1d86#key-1"],"controller":["did:cheqd:testnet:099be283-4302-40cc-9850-22016bcd1d86"],"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..."}],"service":[{"id":"did:cheqd:testnet:099be283-4302-40cc-9850-22016bcd1d86#service-1","type":"MessagingService","serviceEndpoint":["https://example.com/service"]}]}

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/did/cheqd/update' \
  --header 'Content-Type: application/json' \
  --data '{"did":"did:cheqd:testnet:099be283-4302-40cc-9850-22016bcd1d86","options":{"network":"testnet"},"didDocument":{"id":"did:cheqd:testnet:099be283-4302-40cc-9850-22016bcd1d86","authentication":["did:cheqd:testnet:099be283-4302-40cc-9850-22016bcd1d86#key-1"],"controller":["did:cheqd:testnet:099be283-4302-40cc-9850-22016bcd1d86"],"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..."}],"service":[{"id":"did:cheqd:testnet:099be283-4302-40cc-9850-22016bcd1d86#service-1","type":"MessagingService","serviceEndpoint":["https://example.com/service"]}]}}'

200

200

{
  "did": "did:cheqd:testnet:099be283-4302-40cc-9850-22016bcd1d86",
  "success": true,
  "didState": {
    "did": "did:cheqd:testnet:099be283-4302-40cc-9850-22016bcd1d86",
    "state": "finished",
    "didDocument": {
      "id": "did:cheqd:testnet:099be283-4302-40cc-9850-22016bcd1d86",
      "authentication": [
        "did:cheqd:testnet:099be283-4302-40cc-9850-22016bcd1d86#key-1"
      ],
      "controller": [
        "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..."
        }
      ]
    }
  }
}