Skip to content
Registry StackDocsDevelopment (unreleased)

The DID document of the did:web client identifier

GET
/.well-known/did.json
curl --request GET \
  --url https://example.com/.well-known/did.json

Served only when a decentralized-identifier client identifier is configured.

Responses

Section titled “Responses”

200

Section titled “200”

DID document

Media typeapplication/json
object
@context
required
Array<string>
assertionMethod
required
Array<string>
authentication
required
Array<string>
id
required
string
/^did:web:/
verificationMethod
required
Array<object>
>= 1 items <= 1 items
object
controller
required
string
id
required
string
publicKeyMultibase
required
string
/^z/
type
required
Allowed value: Ed25519VerificationKey2020

Example 

{
  "verificationMethod": [
    {
      "type": "Ed25519VerificationKey2020"
    }
  ]
}

Headers

Section titled “Headers”
Cache-Control
string
Allowed value: public, max-age=300
Traceparent
string
/^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$/

The W3C Trace Context version 0 field of the request, or a server-created one when the request carried none or an invalid or repeated one. tracestate is never answered.

404

Section titled “404”

No did:web client identifier is configured

Media typeapplication/problem+json
object
detail
string
status
required
integer
title
required
string
type
required
string format: uri

Example generated

{
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "https://example.com"
}

Headers

Section titled “Headers”
Cache-Control
string
Allowed value: no-store
Traceparent
string
/^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$/

The W3C Trace Context version 0 field of the request, or a server-created one when the request carried none or an invalid or repeated one. tracestate is never answered.

408

Section titled “408”

The configured request deadline elapsed

Media typeapplication/problem+json
object
detail
string
status
required
integer
title
required
string
type
required
string format: uri

Example generated

{
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "https://example.com"
}

Headers

Section titled “Headers”
Cache-Control
string
Allowed value: no-store
Traceparent
string
/^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$/

The W3C Trace Context version 0 field of the request, or a server-created one when the request carried none or an invalid or repeated one. tracestate is never answered.