Interface DidRegistrationResult

Represents the result of a Decentralized Identifier (DID) registration operation.

This type encapsulates the complete outcome of registering a DID, including the registration metadata, the DID document (if registration is successful), and metadata about the DID document.

interface DidRegistrationResult {
    didDocument: null | DidDocument;
    didDocumentMetadata: DidMetadata;
    didRegistrationMetadata: DidRegistrationMetadata;
}

Properties

didDocument: null | DidDocument

The DID document resulting from the registration process, if successful.

If the registration operation was successful, this MUST contain a DID document corresponding to the DID. If the registration is unsuccessful, this value MUST be empty.

didDocumentMetadata: DidMetadata

Metadata about the DID Document.

This structure contains information about the DID Document like creation and update timestamps, deactivation status, versioning information, and other details relevant to the DID Document.

didRegistrationMetadata: DidRegistrationMetadata

A metadata structure consisting of values relating to the results of the DID registration process.

This structure is REQUIRED, and in the case of an error in the registration process, this MUST NOT be empty. If the registration is not successful, this structure MUST contain an error property describing the error.