This document serves as a collection of known DID Resolution and Dereferencing extensions.

Comments regarding this document are welcome. Please file issues directly on GitHub, or send them to public-did-wg@w3.org ( subscribe, archives).

Portions of the work on this specification have been funded by the United States Department of Homeland Security's Science and Technology Directorate under contracts HSHQDC-16-R00012-H-SB2016-1-002, 70RSAT20T00000010, and HSHQDC-17-C-00019. The content of this specification does not necessarily reflect the position or the policy of the U.S. Government and no official endorsement should be inferred.

Work on this registry has also been supported by the Rebooting the Web of Trust community facilitated by Christopher Allen, Shannon Appelcline, Kiara Robles, Brian Weller, Betty Dhamers, Kaliya Young, Kim Hamilton Duffy, Manu Sporny, Drummond Reed, Joe Andrieu, and Heather Vescent, Dmitri Zagidulin, and Dan Burnett.

Introduction

This document serves as a collection of known DID Resolution and Dereferencing extensions.

The Registration Process

The registration process is described in the [[[DID-EXTENSIONS]]].

Representations

This table provides a reference for media types and the associated specifications for producing and consuming those representations.

Media Type Specification
application/did+json DID Core
application/did+ld+json DID Core
application/did+cbor The Plain CBOR Representation

Representation-Specific Entries

JSON

These are entries in DID documents that are specific to the JSON representation.

(No entries yet)

JSON-LD

These are entries in DID documents that are specific to the JSON-LD representation.

@context

Normative Definition
DID Core

The following values are acceptable values for the @context entry as a JSON String or first item of a JSON Array, represented as a JSON String.

`@context` Values Specification Version
https://www.w3.org/ns/did/v1 DID Core 1.0 Working draft 
{
  "@context": [
    "https://www.w3.org/ns/did/v1",
    "https://example.com/blockchain-identity/v1"
  ],
  ...
}

CBOR

These are entries in DID documents that are specific to the CBOR representation.

(No entries yet)

DID Resolution Options

These properties contain information pertaining to the DID resolution request.

accept

Normative Definition
DID Core 
{
  "accept": "application/did+ld+json"
}

DID Resolution Metadata

These properties contain information pertaining to the DID resolution response.

contentType

Normative Definition
DID Core 
{
  "contentType": "application/did+ld+json"
}

error

Normative Definition
DID Core 
{
  "error": "notFound"
}

invalidDid

Normative Definition
DID Core 
{
  "error": "invalidDid"
}

notFound

Normative Definition
DID Core 
{
  "error": "notFound"
}

representationNotSupported

Normative Definition
DID Core 
{
  "error": "representationNotSupported"
}

methodNotSupported

Normative Definition
DID Resolution 
{
  "error": "methodNotSupported"
}

internalError

Normative Definition
DID Resolution 
{
  "error": "internalError"
}

invalidPublicKey

Normative Definition
DID Resolution 
{
  "error": "invalidPublicKey"
}

invalidPublicKeyLength

Normative Definition
DID Resolution 
{
  "error": "invalidPublicKeyLength"
}

invalidPublicKeyType

Normative Definition
DID Resolution 
{
  "error": "invalidPublicKeyType"
}

unsupportedPublicKeyType

Normative Definition
DID Resolution 
{
  "error": "unsupportedPublicKeyType"
}

notAllowedVerificationMethodType

Normative Definition
DID Spec Extension: notAllowedVerificationMethodType 
{
  "error": "notAllowedVerificationMethodType"
}

notAllowedKeyType

Normative Definition
DID Spec Extension: notAllowedKeyType 
{
  "error": "notAllowedKeyType"
}

notAllowedMethod

Normative Definition
DID Spec Extension: notAllowedMethod 
{
  "error": "notAllowedMethod"
}

notAllowedCertificate

Normative Definition
DID Spec Extension: notAllowedCertificate 
{
  "error": "notAllowedCertificate"
}

notAllowedLocalDuplicateKey

Normative Definition
DID Spec Extension: notAllowedLocalDuplicateKey 
{
  "error": "notAllowedLocalDuplicateKey"
}

notAllowedLocalDerivedKey

Normative Definition
DID Spec Extension: notAllowedLocalDerivedKey 
{
  "error": "notAllowedLocalDerivedKey"
}

notAllowedGlobalDuplicateKey

Normative Definition
DID Spec Extension: notAllowedGlobalDuplicateKey 
{
  "error": "notAllowedGlobalDuplicateKey"
}

DID Dereferencing Metadata

These properties contain information pertaining to the DID dereferencing response.

error

Normative Definition
DID Core 
{
  "error": "notFound"
}

invalidDidUrl

Normative Definition
DID Core 
{
  "error": "invalidDidUrl"
}

notFound

Normative Definition
DID Core 
{
  "error": "notFound"
}

DID Document Metadata

These properties contain information pertaining to the DID document itself, rather than the DID subject.

created

See DID Core #203.

Normative Definition JSON-LD
DID Core DID Core 
{
  "created": "2019-03-23T06:35:22Z"
}

updated

See DID Core #203.

Normative Definition JSON-LD
DID Core DID Core 
{
  "updated": "2023-08-10T13:40:06Z"
}

deactivated

Normative Definition JSON-LD
DID Core DID Core 
{
  "deactivated": true
}

nextUpdate

Normative Definition JSON-LD
DID Core DID Core 
{
  "nextUpdate": "2023-08-10T13:40:06Z"
}

versionId

Normative Definition JSON-LD
DID Core DID Core 
{
  "versionId": "bafyreifederejlobaec6kwpl2mc3tw7qk3j3ey4uytkbiw2qw7dzylud6i"
}

nextVersionId

Normative Definition JSON-LD
DID Core DID Core 
{
  "nextVersionId": "bafyreifederejlobaec6kwpl2mc3tw7qk3j3ey4uytkbiw2qw7dzylud6i"
}

equivalentId

Normative Definition JSON-LD
DID Core DID Core 
{
  "equivalentId": ["did:example:ABC", "did:example:Abc"]
}

canonicalId

Normative Definition JSON-LD
DID Core DID Core 
{
  "canonicalId": "did:example:ABC"
}

Parameters

hl

Normative Definition
DID Core 
did:example:123?hl=zQmWvQxTqbG2Z9HPJgG57jjwR154cKhbtJenbyYTWkjgF3e

service

Normative Definition
DID Core 
did:example:123?service=agent

versionId

Normative Definition
DID Core 
did:example:123?versionId=4

versionTime

Normative Definition
DID Core 
did:example:123?versionTime=2016-10-17T02:41:00Z

relativeRef

Normative Definition
DID Core 
did:example:123?service=files&relativeRef=%2Fmyresume%2Fdoc%3Fversion%3Dlatest%23intro

initialState

Normative Definition
DID Spec Extensions by DIF 
did:example:123?initialState=eyJkZWx0YV9oYXNoIjoiRWlDUlRKZ2Q0U0V2YUZDLW9fNUZjQnZJUkRtWF94Z3RLX3g...

transformKeys

Normative Definition
DID Spec Extensions by DIF 
did:example:123?transformKeys=jwk

signedIetfJsonPatch

Normative Definition
DID Spec Extensions by DIF 
did:example:123?signedIetfJsonPatch=eyJraWQiOiJkaWQ6ZXhhbXBsZTo0NTYjX1FxMFVMMkZxNjUxUTBGamQ2VH...

resource

Normative Definition
DID URL Resource Parameter Specification 
did:foo:21tDAKCERh95uGgKbJNHYp?resource=true