This document serves as an official registry for all known global parameters, properties, and values used by the Decentralized Identifier ecosystem.

This registry is under active development and implementers are advised against using the registry unless they are directly involved with the W3C DID Working Group.

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 an official registry for all known global parameters, properties, and values used by the Decentralized Identifier ecosystem.

The Registration Process

Software implementers might find that the existing Decentralized Identifier Core specification [[DID-CORE]] is not entirely capable of addressing their use case and might need to add a new parameters, properties, or values to this registry in order to achieve their use case in a globally interoperable fashion. In order to add a new parameter, property, or value to this registry, an implementer MUST submit a modification request for this registry, as a pull request on the repository where this registry is hosted, where the modification request adheres to the following policies:

  1. Any addition to the DID Core Registries MUST specify a human readable description of the addition.
  2. Any name or value of a property or parameter MUST be indicative of its function. Avoid generic terms such as "myProperty" or "foo".
  3. Any method name SHOULD avoid generic terms such as "mymethod" or "registry".
  4. If there are copyright, trademark, or any intellectual property rights concerns, the addition and use MUST be authorized in writing by the intellectual property rights holder under a F/RAND license. Examples include DID Methods that use trademarked brand names, property names that utilize the titles of copyrighted works, and patented technology that would cause the use of the extension to require licensing a patent.
  5. Any addition MUST NOT create unreasonable legal, security, moral, or privacy issues that will result in direct harm to others. Examples of unacceptable additions include any containing racist language, technologies used to persecute minority populations, and unconsented pervasive tracking.
  6. Any addition to the DID Core Registries MUST link, via at least a URL, preferably a content-integrity protected one, to the defining specification so that implementers can implement the property.
  7. Any addition to the DID Core Registries that is a property or value, MUST specify a machine readable JSON-LD Context for the addition.
    • The JSON-LD Context MUST be included in full as part of the submission.
    • A namespace URI MUST be provided for the JSON-LD Context so that consumer implementations can consistently map a URI to the full context.
    • The URI provided MUST be persistent, and link all terms to their associated human readable descriptions.
    • The URI provided SHOULD resolve or link to the full context contents.
    • JSON-LD Contexts MUST be versioned and MUST NOT be date stamped.
    • JSON-LD Contexts SHOULD use scoped terms and MUST use the @protected feature to eliminate the possibility of term conflicts.
  8. Properties in the DID Core Registries MUST NOT be removed, only deprecated.

The Editors of the DID Specification Registries MUST consider all of the policies above when reviewing additions to the registry and MUST reject registry entries if they violate any of the policies in this section. Entities registering additions can challenge rejections first with the W3C DID Working Group and then, if they are not satisfied with the outcome, with the W3C Staff. W3C Staff need not be consulted on changes to the DID Specification Registries, but do have the final authority on registry contents. This is to ensure that W3C can adequately respond to time sensitive legal, privacy, security, moral, or other pressing concerns without putting an undue operational burden on W3C Staff.

Entries that are identified to cause interoperability problems MAY be marked as such at the discretion of the maintainers of this registry, and if possible, after consultation with the entry maintainer.

Any submission to the registries that meet all the criteria listed above will be accepted for inclusion. These registries enumerate all known mechanisms that meet a minimum bar, without choosing between them.

The Labeling Process

This section describes labels that are used to categorize registry entries.

Deprecated
This label is applied to registry entries that should not be relied on.
No Contact Info
This label is applied to registry entries for which no point of contact has been provided.

Property Names

The following section defines the properties available for use in a DID document. Note that some of these properties are defined in the DID Core Specification, and others are defined elsewhere and may be method- or domain-specific. Please read the associated specifications to ensure that the properties you use are appropriate for your implementation. The properties are arranged here according to the purpose they serve.

This registry is a work in progress and some properties are missing normative definitions. We are working on this! This does NOT mean that in future it will be possible to submit items to the registry without normative definitions (see ).

DID document properties

These properties are foundational to DID documents, and are expected to be useful to all DID methods.

id

Normative Definition JSON-LD
DID Core DID Core 
{
  "id": "did:example:123",
  ...
}

alsoKnownAs

Normative Definition JSON-LD
DID Core DID Core 
{
  "alsoKnownAs": "https://example.com/",
  ...
}

controller

Normative Definition JSON-LD
DID Core DID Core 
{
  "controller": "did:example:123",
  ...
}

verificationMethod

Normative Definition JSON-LD
DID Core Terminology DID Core 
{
  "id": "did:example:123",
  "verificationMethod": [
    {
      "id": "did:example:123#key-1",
      "type": "Ed25519VerificationKey2018",
      "controller": "did:example:123",
      "publicKeyBase58": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV"
    },
    {
      "id": "did:example:123#key-2",
      "type": "JsonWebKey2020",
      "controller": "did:example:123",
      "publicKeyJwk": {
        "kty": "OKP",
        "crv": "Ed25519",
        "x": "r7V8qmdFbwqSlj26eupPew1Lb22vVG5vnjhn3vwEA1Y"
      },
    }
  ]
}

publicKey

Deprecated

This property has been deprecated, use verificationMethod instead.

Normative Definition JSON-LD
security-vocab security-vocab context 
{
  "id": "did:example:123",
  "publicKey": [
    {
      "id": "did:example:123#ZC2jXTO6t4R501bfCXv3RxarZyUbdP2w_psLwMuY6ec",
      "type": "Ed25519VerificationKey2018",
      "controller": "did:example:123",
      "publicKeyBase58": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV"
    },
    {
      "id": "did:example:123#WjKgJV7VRw3hmgU6--4v15c0Aewbcvat1BsRFTIqa5Q",
      "type": "EcdsaSecp256k1VerificationKey2019",
      "controller": "did:example:123",
      "publicKeyJwk": {
        "crv": "secp256k1",
        "x": "NtngWpJUr-rlNNbs0u-Aa8e16OwSJu6UiFf0Rdo1oJ4",
        "y": "qN1jKupJlFsPFc1UkWinqljv4YE0mq_Ickwnjgasvmo",
        "kty": "EC",
        "kid": "WjKgJV7VRw3hmgU6--4v15c0Aewbcvat1BsRFTIqa5Q"
      }
    }
  ]
}

service

Normative Definition JSON-LD
DID Core DID Core 
{
  ...
  "service": [{
    "id": "did:example:123#edv",
    "type": "EncryptedDataVault",
    "serviceEndpoint": "https://edv.example.com/"
  }]
}

linkedResource

Normative Definition JSON-LD
DID Cosmos Linked Resources Cosmos JSON-LD Context 
    {  
        ...
        "linkedResource" : [{
          "id": "did:cosmos:1:impacthub:nft:abc123#resourceHashgraph",
          "path": "did:cosmos:1:impacthub:nft:abc123/resourceHashgraph",
          "type": "hashgraph",
          "proof": "afybeiemxf5abjwjbikoz4mcb3a3dla6ual3jsgpdr4cjr3oz",
          "endpoint" : "did:cosmos:1:impacthub:nft:abc123?service=mediator"
      }]
    }

Verification relationships

These are properties that express the relationship between the DID subject and a verification method using a verification relationship.

assertionMethod

Normative Definition JSON-LD
DID Core DID Core 
{
  ...
  "verificationMethod": [{
    "id": "did:example:123#WjKgJV7VRw3hmgU6--4v15c0Aewbcvat1BsRFTIqa5Q",
    "type": "EcdsaSecp256k1VerificationKey2019",
    "controller": "did:example:123",
    "publicKeyJwk": {
      "crv": "secp256k1",
      "x": "NtngWpJUr-rlNNbs0u-Aa8e16OwSJu6UiFf0Rdo1oJ4",
      "y": "qN1jKupJlFsPFc1UkWinqljv4YE0mq_Ickwnjgasvmo",
      "kty": "EC",
      "kid": "WjKgJV7VRw3hmgU6--4v15c0Aewbcvat1BsRFTIqa5Q"
    }
  }],
  "assertionMethod": [{
    "id": "did:example:123#z6MkpzW2izkFjNwMBwwvKqmELaQcH8t54QL5xmBdJg9Xh1y4",
    "type": "Ed25519VerificationKey2018",
    "controller": "did:example:123",
    "publicKeyBase58": "BYEz8kVpPqSt5T7DeGoPVUrcTZcDeX5jGkGhUQBWmoBg"
  },
  "did:example:123#WjKgJV7VRw3hmgU6--4v15c0Aewbcvat1BsRFTIqa5Q"
  ]
}

authentication

Normative Definition JSON-LD
DID Core DID Core 
{
  ...
  "verificationMethod": [{
    "id": "did:example:123#WjKgJV7VRw3hmgU6--4v15c0Aewbcvat1BsRFTIqa5Q",
    "type": "EcdsaSecp256k1VerificationKey2019",
    "controller": "did:example:123",
    "publicKeyJwk": {
      "crv": "secp256k1",
      "x": "NtngWpJUr-rlNNbs0u-Aa8e16OwSJu6UiFf0Rdo1oJ4",
      "y": "qN1jKupJlFsPFc1UkWinqljv4YE0mq_Ickwnjgasvmo",
      "kty": "EC",
      "kid": "WjKgJV7VRw3hmgU6--4v15c0Aewbcvat1BsRFTIqa5Q"
    }
  }],
  "authentication": [{
    "id": "did:example:123#z6MkpzW2izkFjNwMBwwvKqmELaQcH8t54QL5xmBdJg9Xh1y4",
    "type": "Ed25519VerificationKey2018",
    "controller": "did:example:123",
    "publicKeyBase58": "BYEz8kVpPqSt5T7DeGoPVUrcTZcDeX5jGkGhUQBWmoBg"
  },
  "did:example:123#WjKgJV7VRw3hmgU6--4v15c0Aewbcvat1BsRFTIqa5Q"
  ]
}

capabilityDelegation

Normative Definition JSON-LD
DID Core DID Core 
{
  ...
  "verificationMethod": [{
    "id": "did:example:123#WjKgJV7VRw3hmgU6--4v15c0Aewbcvat1BsRFTIqa5Q",
    "type": "EcdsaSecp256k1VerificationKey2019",
    "controller": "did:example:123",
    "publicKeyJwk": {
      "crv": "secp256k1",
      "x": "NtngWpJUr-rlNNbs0u-Aa8e16OwSJu6UiFf0Rdo1oJ4",
      "y": "qN1jKupJlFsPFc1UkWinqljv4YE0mq_Ickwnjgasvmo",
      "kty": "EC",
      "kid": "WjKgJV7VRw3hmgU6--4v15c0Aewbcvat1BsRFTIqa5Q"
    }
  }],
  "capabilityDelegation": [{
    "id": "did:example:123#z6MkpzW2izkFjNwMBwwvKqmELaQcH8t54QL5xmBdJg9Xh1y4",
    "type": "Ed25519VerificationKey2020",
    "controller": "did:example:123",
    "publicKeyMultibase": "z6MkpzW2izkFjNwMBwwvKqmELaQcH8t54QL5xmBdJg9Xh1y4"
  },
  "did:example:123#WjKgJV7VRw3hmgU6--4v15c0Aewbcvat1BsRFTIqa5Q"
  ]
}

capabilityInvocation

Normative Definition JSON-LD
DID Core DID Core 
{
  ...
  "verificationMethod": [{
    "id": "did:example:123#WjKgJV7VRw3hmgU6--4v15c0Aewbcvat1BsRFTIqa5Q",
    "type": "EcdsaSecp256k1VerificationKey2019",
    "controller": "did:example:123",
    "publicKeyJwk": {
      "crv": "secp256k1",
      "x": "NtngWpJUr-rlNNbs0u-Aa8e16OwSJu6UiFf0Rdo1oJ4",
      "y": "qN1jKupJlFsPFc1UkWinqljv4YE0mq_Ickwnjgasvmo",
      "kty": "EC",
      "kid": "WjKgJV7VRw3hmgU6--4v15c0Aewbcvat1BsRFTIqa5Q"
    }
  }],
  "capabilityInvocation": [{
    "id": "did:example:123#z6MkpzW2izkFjNwMBwwvKqmELaQcH8t54QL5xmBdJg9Xh1y4",
    "type": "Ed25519VerificationKey2020",
    "controller": "did:example:123",
    "publicKeyMultibase": "z6MkpzW2izkFjNwMBwwvKqmELaQcH8t54QL5xmBdJg9Xh1y4"
  },
  "did:example:123#WjKgJV7VRw3hmgU6--4v15c0Aewbcvat1BsRFTIqa5Q"
  ]
}

keyAgreement

Normative Definition JSON-LD
DID Core DID Core 
{
  ...
  "keyAgreement": [
    {
      "id": "did:example:123#zC9ByQ8aJs8vrNXyDhPHHNNMSHPcaSgNpjjsBYpMMjsTdS",
      "type": "X25519KeyAgreementKey2019",
      "controller": "did:example:123",
      "publicKeyMultibase": "zC9ByQ8aJs8vrNXyDhPHHNNMSHPcaSgNpjjsBYpMMjsTdS"
    }
  ]
}

Verification method properties

These properties are for use on a verification method object, in the value of verificationMethod. An implementer is expected to not be relying directly on the linked contexts registered below in nearly every case and instead should be including the context definitions registered by the verificationMethod.

publicKeyJwk

Normative Definition JSON-LD
security-vocab https://w3id.org/security/suites/jws-2020/v1 
{
  "id": "did:example:123#_Qq0UL2Fq651Q0Fjd6TvnYE-faHiOpRlPVQcY_-tA4A",
  "type": "JsonWebKey2020",
  "controller": "did:example:123",
  "publicKeyJwk": {
    "crv": "Ed25519",
    "x": "VCpo2LMLhn6iWku8MKvSLg2ZAoC-nlOyPVQaO3FxVeQ",
    "kty": "OKP",
    "kid": "_Qq0UL2Fq651Q0Fjd6TvnYE-faHiOpRlPVQcY_-tA4A"
  }
},

publicKeyBase58

Deprecated

This property is deprecated in favor of publicKeyMultibase or publicKeyJwk. It's generally expected that this term will still be used in older suites and therefore needs be supported for legacy compatibility, but is expected to not be used for newly defined suites.

Normative Definition JSON-LD
security-vocab https://w3id.org/security/v2

publicKeyHex

Deprecated

This property is deprecated in favor of publicKeyMultibase or publicKeyJwk. It's generally expected that this term will still be used in older suites and therefore needs be supported for legacy compatibility, but is expected to not be used for newly defined suites.

Normative Definition JSON-LD
security-vocab https://w3id.org/security/v3-unstable 
  {
    "@context":[
      "https://www.w3.org/ns/did/v1",
      "https://identity.foundation/EcdsaSecp256k1RecoverySignature2020#"
    ],
    "id":"did:example:123",
    "verificationMethod":[{
      "id": "did:example:123#vm-2",
      "controller": "did:example:123",
      "type": "EcdsaSecp256k1RecoveryMethod2020",
      "publicKeyHex": "027560af3387d375e3342a6968179ef3c6d04f5d33b2b611cf326d4708badd7770"
    }]
  }

publicKeyMultibase

Normative Definition JSON-LD
security-vocab https://w3id.org/security/v3-unstable

blockchainAccountId

Normative Definition JSON-LD
security-vocab https://w3id.org/security/v3-unstable 
  {
    "@context":[
      "https://www.w3.org/ns/did/v1",
      "https://identity.foundation/EcdsaSecp256k1RecoverySignature2020#"
    ],
    "id":"did:example:123",
    "verificationMethod":[{
      "id": "did:example:123#vm-3",
      "controller": "did:example:123",
      "type": "EcdsaSecp256k1RecoveryMethod2020",
      "blockchainAccountId":"eip155:1:0xab16a96d359ec26a11e2c2b3d8f8b8942d5bfcdb"
    }]
  }

ethereumAddress

Deprecated

This property is deprecated in favor of blockchainAccountId. It's generally expected that this term will still be used in older suites and therefore needs be supported for legacy compatibility, but is expected to not be used for newly defined suites.

Normative Definition JSON-LD
security-vocab https://w3id.org/security/v3-unstable 
  {
    "@context":[
      "https://www.w3.org/ns/did/v1",
      "https://identity.foundation/EcdsaSecp256k1RecoverySignature2020#"
    ],
    "id":"did:example:123",
    "verificationMethod":[{
      "id": "did:example:123#vm-3",
      "controller": "did:example:123",
      "type": "EcdsaSecp256k1RecoveryMethod2020",
      "ethereumAddress": "0xF3beAC30C498D9E26865F34fCAa57dBB935b0D74"
    }]
  }

Service properties

These properties are for use on a service object, in the value of service.

serviceEndpoint

Normative Definition JSON-LD
DID Core DID Core 
{
  ...
  "service": [{
    "id": "did:example:123#edv",
    "type": "EncryptedDataVault",
    "serviceEndpoint": "https://edv.example.com/"
  }]
}

Property Values

Verification method types

These are values to be used for the type in a verification method object.

JsonWebKey2020

Do not include private or extraneous information in verification methods. The class of private information related to JWKs is defined here. Please review the DID Core specification for additional details on this topic.

Normative Definition JSON-LD
JSON Web Signature 2020 https://w3id.org/security/suite/jws-2020/v1 
  {
    "id": "did:example:123#_TKzHv2jFIyvdTGF1Dsgwngfdg3SH6TpDv0Ta1aOEkw",
    "type": "JsonWebKey2020",
    "controller": "did:example:123",
    "publicKeyJwk": {
      "crv": "P-256",
      "x": "38M1FDts7Oea7urmseiugGW7tWc3mLpJh6rKe7xINZ8",
      "y": "nDQW6XZ7b_u2Sy9slofYLlG03sOEoug3I0aAPQ0exs4",
      "kty": "EC",
      "kid": "_TKzHv2jFIyvdTGF1Dsgwngfdg3SH6TpDv0Ta1aOEkw"
    }
  }

EcdsaSecp256k1VerificationKey2019

Normative Definition JSON-LD
Ecdsa Secp256k1 Signature 2019 https://w3id.org/security/suites/secp256k1-2019 
{
  "id": "did:example:123#WjKgJV7VRw3hmgU6--4v15c0Aewbcvat1BsRFTIqa5Q",
  "type": "EcdsaSecp256k1VerificationKey2019",
  "controller": "did:example:123",
  "publicKeyJwk": {
    "crv": "secp256k1",
    "x": "NtngWpJUr-rlNNbs0u-Aa8e16OwSJu6UiFf0Rdo1oJ4",
    "y": "qN1jKupJlFsPFc1UkWinqljv4YE0mq_Ickwnjgasvmo",
    "kty": "EC",
    "kid": "WjKgJV7VRw3hmgU6--4v15c0Aewbcvat1BsRFTIqa5Q"
  }
}

Ed25519VerificationKey2018

Normative Definition JSON-LD
Ed25519 Signature 2018 https://w3id.org/security/suites/ed25519-2018/v1 
          {
            "id": "did:example:123#ZC2jXTO6t4R501bfCXv3RxarZyUbdP2w_psLwMuY6ec",
            "type": "Ed25519VerificationKey2018",
            "controller": "did:example:123",
            "publicKeyBase58": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV"
          }

Bls12381G1Key2020

Normative Definition JSON-LD
BBS+ Signatures 2020 https://w3id.org/security/suites/bls12381-2020/v1 
          {
            "id": "did:example:123#z3tEGVtEKzdhJB2rT5hLVjwQPis8k7bTM16t7vDZrQaoddk6wZ7or6xPPs1P8H9U16Xe75",
            "type": "Bls12381G1Key2020",
            "controller": "did:example:123",
            "publicKeyBase58": "7bXhTVonHPizXP72AE92PPmRiaXipC519yU7F6NxUFExWpyQo57LuKKBoTyuZ3uWm9",
          }

Bls12381G2Key2020

Normative Definition JSON-LD
BBS+ Signatures 2020 https://w3id.org/security/suites/bls12381-2020/v1 
          {
            "id": "did:example:123#zUC7K51WYEsj8y6KPVa1XfwdW5ZJrW5kSbMV619j128T6atCLLXJjjovMZsJ3Ay4STdngRkvM4ygT4qm1mk6HR8FvipSY435nLgYS1TTcaqJAzDWzM1iB9vh3hTL1DEKitwn56i",
            "type": "Bls12381G2Key2020",
            "controller": "did:example:123",
            "publicKeyBase58": "25ETdUZDVnME6yYuAMjFRCnCPcDmYQcoZDcZuXAfeMhXPvjZg35QmZ7uctBcovA69YDM3Jf7s5BHo4u1y89nY6mHiji8yphZ4AMm4iNCRh35edSg76Dkasu3MY2VS9LnuaVQ",

          }

PgpVerificationKey2021

Normative Definition JSON-LD Additional Details
Linked Data Signatures for PGP https://w3id.org/security/suites/pgp-2021/v1 Use of this verification key should be in line with the OpenPGP Message Format as defined in RFC 4880 
{
  "@context":[
    "https://www.w3.org/ns/did/v1",
    "https://gpg.jsld.org/contexts/lds-gpg2020-v0.0.jsonld"
  ],
  "id":"did:example:123",
  "verificationMethod":[{
    "id": "did:example:123#989ed1057a294c8a3665add842e784c4d08de1e2",
    "type": "PgpVerificationKey2021",
    "controller": "did:example:123",
    "publicKeyPgp": "-----BEGIN PGP PUBLIC KEY BLOCK-----\r\nVersion: OpenPGP.js v4.9.0\r\nComment: https://openpgpjs.org\r\n\r\nxjMEXkm5LRYJKwYBBAHaRw8BAQdASmfrjYr7vrjwHNiBsdcImK397Vc3t4BL\r\nE8rnN......v6\r\nDw==\r\n=wSoi\r\n-----END PGP PUBLIC KEY BLOCK-----\r\n"
  }]
}

RsaVerificationKey2018

DID Specification Registries Issue 370 This property should be moved into a separate suite and linked to here rather than relying on the Verifiable Credentials vocabulary. There are known issues with the first version of the Security vocabulary JSON-LD context and the first version of the Verifiable Credentials JSON-LD context which will prevent these contexts from being listed in the same document. For now it's suggested that implementers rely upon the first version of the Verifiable Credentials JSON-LD context and not rely on the Security vocabulary JSON-LD context in the same document.

Normative Definition JSON-LD
RSA Signature Suite 2018 https://www.w3.org/2018/credentials/v1 
  {
    "id": "did:example:123#key-0",
    "type": "RsaVerificationKey2018",
    "controller": "did:example:123",
    "publicKeyJwk": {
      "kty":"RSA",
      "e":"AQAB",
      "use":"sig",
      "kid":"tNksV42EUs3Xct9AkgZyFWglItRGMxVZ1A1XM68SNq0
      "n":"kO2d_qQTEBjYFGcoY_da7ziFY4L2QX14K7snCee09n-cY2eP-oJXk8T2_lL20YnpYhf4i
      jhkWHGU8kY8-FWPRrzSeu3JUMVSZoqTgoAiKWdnSLNvPVxvGuD2CiA3T6AkwUC03D2AkOLCcJV
      8h_hxUEPeDawF7ArpuJW5DXzEJjE7gOjN4r6d7VB6sd5y-3la54H2ADz2amHLdBWs30fL4BRBH
      lVdx0YmF37V4u5yvnnb5Iyr3kBXJes8t0MUMPkjqEEXRmukpKUzZYNpWDXY0tVcXeK5sRx0DAn
      lNgNNf14-vsyjGkj2Rz0oGW73jjWa8dw-yVlDEHyIkQU9-UY4dFXbVjdIO8j_5ghh62o1T7Y4w
      5CWMc-FxPE3LHe-_teW97X__NN-ToYgfi42IvV2mYOdQMCbvnvY2oMdK3b9wmeVi0marToauL5
      LMg5xHDKopmIR7E3VyRtNYwDFAZ89kadcbSrZ8zTR5APaB7Tmp2L2ZfXKxqKQuxlFTTCcZtg4e
      5AN8QuYdI18DEDQn2umUU_Twj7k4CXvuIKVL8p4yRHC4CHAGIm9cH_t11dF3wXygaENVOGRXQu
      0g1iKq0mO2rWpOqkGJ5uXMFb5lx54i8uOjCdZ9y2el28xA55Ve95KCxeTHp997Bn3TIgbeQ-B_
      -3PBVTuuAAH8y9fFNKtu5E"
    }
  }

X25519KeyAgreementKey2019

Normative Definition JSON-LD
Normative definition pending http://w3id.org/security/suites/x25519-2019/v1 
  {
    ...
    "keyAgreement": [
      {
        "id": "did:example:123#zC9ByQ8aJs8vrNXyDhPHHNNMSHPcaSgNpjjsBYpMMjsTdS",
        "type": "X25519KeyAgreementKey2019",
        "controller": "did:example:123",
        "publicKeyBase58": "9hFgmPVfmBZwRvFEyniQDBkz9LmV7gDEqytWyGZLmDXE"
      }
    ]
  }

EcdsaSecp256k1RecoveryMethod2020

Normative Definition JSON-LD
ECDSA Secp256k1 Recovery Signature 2020 https://w3id.org/security/suites/secp256k1recovery-2020 
{
  "@context": [
    "https://www.w3.org/ns/did/v1",
    "https://identity.foundation/EcdsaSecp256k1RecoverySignature2020#"
  ],
  "id":"did:example:123",
  "verificationMethod": [
    {
      "id": "did:example:123#vm-1",
      "controller": "did:example:123",
      "type": "EcdsaSecp256k1RecoveryMethod2020",
      "publicKeyJwk": {
        "crv": "secp256k1",
        "kid": "JUvpllMEYUZ2joO59UNui_XYDqxVqiFLLAJ8klWuPBw",
        "kty": "EC",
        "x": "dWCvM4fTdeM0KmloF57zxtBPXTOythHPMm1HCLrdd3A",
        "y": "36uMVGM7hnw-N6GnjFcihWE3SkrhMLzzLCdPMXPEXlA"
      }
    },
    {
      "id": "did:example:123#vm-2",
      "controller": "did:example:123",
      "type": "EcdsaSecp256k1RecoveryMethod2020",
      "publicKeyHex": "027560af3387d375e3342a6968179ef3c6d04f5d33b2b611cf326d4708badd7770"
    },
    {
      "id": "did:example:123#vm-3",
      "controller": "did:example:123",
      "type": "EcdsaSecp256k1RecoveryMethod2020",
      "ethereumAddress": "0xF3beAC30C498D9E26865F34fCAa57dBB935b0D74"
    }
  ]
}

VerifiableCondition2021

Normative Definition JSON-LD
Verifiable Conditions Verification Method Suite 2021 https://w3c-ccg.github.io/verifiable-conditions/contexts/verifiable-conditions-2021-v1.json 
          {
              "id": "did:example:123#1",
              "controller": "did:example:123",
              "type": "VerifiableCondition2021",
              "conditionAnd": [{
                  "id": "did:example:123#1-1",
                  "controller": "did:example:123",
                  "type": "VerifiableCondition2021",
                  "conditionOr": [{
                      "id": "did:example:123#1-1-1",
                      "controller": "did:example:123",
                      "type": "EcdsaSecp256k1VerificationKey2019",
                      "publicKeyBase58": "5JBxKqYKzzoHrzeqwp6zXk8wZU3Ah94ChWAinSj1fYmyJvJS5rT"
                  }, {
                      "id": "did:example:123#1-1-2",
                      "controller": "did:example:123",
                      "type": "Ed25519VerificationKey2018",
                      "publicKeyBase58": "PZ8Tyr4Nx8MHsRAGMpZmZ6TWY63dXWSCzamP7YTHkZc78MJgqWsAy"
                  }]
              }, {
                  "id": "did:example:123#1-2",
                  "controller": "did:example:123",
                  "type": "Ed25519VerificationKey2018",
                  "publicKeyBase58": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV"
              }]
          }

Service types

These are values to be used for the type property in a service object.

LinkedDomains

Normative Definition JSON-LD
Well Known DID Configuration Well Known DID Configuration 
{
  "@context": ["https://www.w3.org/ns/did/v1","https://identity.foundation/.well-known/did-configuration/v1"],
  "id": "did:example:123",
  "verificationMethod": [{
    "id": "did:example:123#456",
    "type": "JsonWebKey2020",
    "controller": "did:example:123",
    "publicKeyJwk": {
      "kty": "OKP",
      "crv": "Ed25519",
      "x": "VCpo2LMLhn6iWku8MKvSLg2ZAoC-nlOyPVQaO3FxVeQ"
    }
  }],
  "service": [
    {
      "id":"did:example:123#foo",
      "type": "LinkedDomains",
      "serviceEndpoint": {
        "origins": ["https://foo.example.com", "https://identity.foundation"]
      }
    },
    {
      "id":"did:example:123#bar",
      "type": "LinkedDomains",
      "serviceEndpoint": "https://bar.example.com"
    }
  ]
}

DIDCommMessaging

Normative Definition JSON-LD
DIDComm Messaging A valid JSON-LD context needs to be published. DIDComm Messaging 
{
  "@context":[
      "https://www.w3.org/ns/did/v1",
      "https://didcomm.org/messaging/contexts/v2"
  ],
  ...
  "type":"DIDCommMessaging",
  "serviceEndpoint":"http://example.com/path",
  "accept":[
      "didcomm/v2",
      "didcomm/aip2;env=rfc587"
  ],
  "routingKeys":[
      "did:example:somemediator#somekey"
  ]
  ...
}

CredentialRegistry

The CredentialRegistry endpoint allows publication of a dedicated service endpoint in a DID document, through which verifiable credentials can be queried. Each registry endpoint is a REST endpoint. When a `GET` request is sent to the URI formed by appending the credentialSubject.id as a URL-encoded string to the given endpoint URI, the registry MUST return an array of verifiable credentials associated with the subject ID. A sample registry endpoint can be found here.

Verifiable credential registries are supposed to hold credentials that are publicly accessible by default, e.g., for product passports on a product type level. An additional authentication for limiting access to certain credentials is currently under development.

Normative Definition JSON-LD
Verifiable Credential Registry Verifiable Credential Registry 
{
  ...
  "service": [
    {
      "id": "did:example:123#vcregistry-1",
      "type": "CredentialRegistry",
      "serviceEndpoint": {
        "registries": ["https://registry.example.com/{credentialSubject.id}", "https://identity.foundation/vcs/{credentialSubject.id}"]
      }
    },
    {
      "id": "did:example:123#vcregistry-2",
      "type": "CredentialRegistry",
      "serviceEndpoint": "https://ssi.eecc.de/api/registry/vcs/{credentialSubject.id}"
    }
  ]
}
        
$ curl 'https://ssi.eecc.de/api/registry/vcs/https%3A%2F%2Ftest.de%2Ftest1' -H 'accept: application/ld+json, application/json'

[
  {
    "@context": ["https://www.w3.org/2018/credentials/v1",... ],
    "type": ["VerifiableCredential",...],
    "credentialSubject": {...},
    "proof": {...},
    ...
  },
  ...
]

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

DID Methods

This table summarizes the DID method specifications currently in development. The links will be updated as subsequent Implementer’s Drafts are produced.

The normative requirements for DID method specifications can be found in Decentralized Identifiers v1.0: Methods [[DID-CORE]]. DID methods that do not meet these requirements will not be accepted. We encourage DID method authors to provide an email address in the Author Links column, as this helps with maintenance. If an email address is omitted, a label noting that there is no contact information for the author will be applied to the registry entry.