Sign in
Dids

Replace a DID

Replaces the mutable declarative fields of a DID in one request. Collections in the body are full replacement sets. Verification methods and key mappings are intentionally managed through their dedicated sub-resource endpoints.

put/identifiers/{did}

Parameters

./common-components.yml#/components/parameters/CorrelationId — unresolved $ref

Request body

aliasstring nullable
canonicalIdstring nullable
controllersstring[]

Full replacement set of controller DID strings.

alsoKnownAsstring[]

Full replacement set of also-known-as URIs.

equivalentIdsstring[]

Full replacement set of equivalent DID strings.

contextsstring[]

Full replacement set of DID document context URIs.

deactivatedboolean nullable

Optional DID document deactivated flag to store with the replacement.

servicesDidDocumentService[] — unresolved $ref

Full replacement set of DID service entries.

Example request

{
  "alias": "acme-issuer",
  "controllers": [
    "did:web:controller-a.example.com"
  ],
  "alsoKnownAs": [
    "https://acme.example.com/about"
  ],
  "equivalentIds": [
    "did:web:acme.example.com"
  ],
  "contexts": [
    "https://www.w3.org/ns/did/v1"
  ],
  "canonicalId": "did:web:enterprise.example.com",
  "deactivated": false,
  "services": [
    {
      "id": "svc-linked-domains",
      "type": "LinkedDomains",
      "serviceEndpoint": "https://example.com"
    }
  ],
  "relationships": [
    {
      "purpose": "assertionMethod",
      "verificationMethodId": "#key-1"
    }
  ]
}

Response

DID replaced successfully.

Did required— unresolved $ref

Changes