Update or deactivate a DID
Users are able to update DID Documents for various reasons, such as to include a new section or to rotate the Verification Method keys within the DID Document.
With the /did/update
API, users are able to input either:
The section of the DID Document they would like to update; or
The full updated DID Document body.
Users are also able to deactivate DID Documents to prevent further updates and to provide client applications the relevant information that the DID Document is no longer actively used.
A /did/deactivate
request must be signed by all of the Verification Method keys listed in the DID Document.
This endpoint updates a DID Document. As an input, it can take JUST the sections/parameters that need to be updated in the DID Document (in this scenario, it fetches the current DID Document and applies the updated section). Alternatively, it take the fully-assembled DID Document with updated sections as well as unchanged sections.
DID identifier to be updated.
"did:cheqd:testnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0"
Service section of the DID Document.
DID appended with Service fragment ID (e.g., #service-1
in did:cheqd:mainnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0#service-1
)
"did:cheqd:mainnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0#service-1"
Service type as defined in DID Specification Registries.
"LinkedDomains"
Service endpoint as defined in DID Core Specification.
"https://example.com"
Verification Method section of the DID Document.
Authentication section of the DID Document.
List of key references (publicKeys) which will be used for signing the message. The should be in hexadecimal format and placed in the wallet of current user.
This input field contains either a complete DID document, or an incremental change (diff) to a DID document. See Universal DID Registrar specification.
DID appended with Service fragment ID (e.g., #service-1
in did:cheqd:mainnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0#service-1
)
"did:cheqd:mainnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0#service-1"
Service type as defined in DID Specification Registries.
"LinkedDomains"
Service endpoint as defined in DID Core Specification.
"https://example.com"
The request was successful.
The default key id of which is the key associated with the first verificationMethod
The list of keys associated with the list of verificationMethod's of DIDDocument
DID appended with Service fragment ID (e.g., #service-1
in did:cheqd:mainnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0#service-1
)
"did:cheqd:mainnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0#service-1"
Service type as defined in DID Specification Registries.
"LinkedDomains"
Service endpoint as defined in DID Core Specification.
"https://example.com"
The list of keyRefs which were used for signing the transaction
The list of all possible keys, inlcuding all controller's keys
This endpoint deactivates a DID Document by taking the DID identifier as input. Must be called and signed by the DID owner.
DID identifier to deactivate.
List of key references (publicKeys) which will be used for signing the message. The should be in hexadecimal format and placed in the wallet of current user.
The request was successful.
"https://w3id.org/did-resolution/v1"
"application/did+ld+json"
"2021-09-01T12:00:00Z"
"did:cheqd:testnet:55dbc8bf-fba3-4117-855c-1e0dc1d3bb47"
"cheqd"
"55dbc8bf-fba3-4117-855c-1e0dc1d3bb47"
This input field contains either a complete DID document, or an incremental change (diff) to a DID document. See Universal DID Registrar specification.
DID appended with Service fragment ID (e.g., #service-1
in did:cheqd:mainnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0#service-1
)
"did:cheqd:mainnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0#service-1"
Service type as defined in DID Specification Registries.
"LinkedDomains"
Service endpoint as defined in DID Core Specification.
"https://example.com"
"2021-09-01T12:00:00Z"
true
"2021-09-10T12:00:00Z"
"3ccde6ba-6ba5-56f2-9f4f-8825561a9860"
"did:cheqd:testnet:55dbc8bf-fba3-4117-855c-1e0dc1d3bb47/resources/398cee0a-efac-4643-9f4c-74c48c72a14b"
"55dbc8bf-fba3-4117-855c-1e0dc1d3bb47"
"398cee0a-efac-4643-9f4c-74c48c72a14b"
"cheqd-issuer-logo"
"CredentialArtwork"
"image/png"
"1.0"
"a95380f460e63ad939541a57aecbfd795fcd37c6d78ee86c885340e33a91b559"
"2021-09-01T12:00:00Z"
"d4829ac7-4566-478c-a408-b44767eddadc"
"ad7a8442-3531-46eb-a024-53953ec6e4ff"