Optional
canonicalThe canonicalId
property is identical to the equivalentId
property except:
A requesting party is expected to use the canonicalId
value as its primary ID value for the
DID subject and treat all other equivalent values as secondary aliases (e.g., update
corresponding primary references in their systems to reflect the new canonical ID directive).
Optional
createdTimestamp of the Create operation.
The value of the property MUST be a string formatted as an XML Datetime normalized to
UTC 00:00:00 and without sub-second decimal precision. For example: 2020-12-20T19:17:47Z
.
Optional
deactivatedWhether the DID has been deactivated.
If a DID has been deactivated, DID document metadata MUST include this property with the
boolean value true
. If a DID has not been deactivated, this properrty is OPTIONAL, but if
present, MUST have the boolean value false
.
Optional
equivalentA DID method can define different forms of a DID that are logically equivalent. An example is
when a DID takes one form prior to registration in a verifiable data registry and another form
after such registration. In this case, the DID method specification might need to express one
or more DIDs that are logically equivalent to the resolved DID as a property of the DID
document. This is the purpose of the equivalentId
property.
A requesting party is expected to retain the values from the id and equivalentId properties to ensure any subsequent interactions with any of the values they contain are correctly handled as logically equivalent (e.g., retain all variants in a database so an interaction with any one maps to the same underlying account).
Optional
nextTimestamp of the next Update operation if the resolved document version is not the latest version of the document.
The value of the property MUST follow the same formatting rules as the created
property.
Optional
nextVersion ID of the next Update operation if the resolved document version is not the latest version of the document.
Optional
publishedFor DID methods that support publishing, the published
property indicates whether the DID
document has been published to the respective network.
A true
value signifies that the DID document is publicly accessible on the network (e.g.,
Mainline DHT), allowing it to be resolved by others. A false
value implies the DID document
is not published, limiting its visibility to public resolution. Absence of this property
indicates that the DID method does not support publishing.
Optional
updatedTimestamp of the last Update operation for the document version which was resolved.
The value of the property MUST follow the same formatting rules as the created
property.
The updated
property is omitted if an Update operation has never been performed on the DID
document. If an updated
property exists, it can be the same value as the created
property
when the difference between the two timestamps is less than one second.
Optional
versionVersion ID of the last Update operation for the document version which was resolved.
Represents metadata about a DID resulting from create, update, or deactivate operations.