Sign in

v1

latestOpenAPI 3.1.02026-07-17105740.5 KB
Universal Registrar

Deactivate a DID

This endpoint deactivates a DID. As input it takes the existing DID, plus optional DID registration options and secrets needed to deactivate a DID. The output is a state object that represents the current state of the DID deactivation process.

See the DID Registration specification for additional details.

post/deactivate

Request body

didstring required

This input field indicates the DID that is the target of the DID deactivation operation.

Example request

{
  "options": {
    "clientSecretMode": true,
    "network": "testnet"
  },
  "secret": {
    "seed": "72WGp7NgFR1Oqdi8zlt7jQQ434XR0cNQ",
    "verificationMethod": [
      {
        "id": "did:indy:sovrin:WRfXPg8dantKVubE3HX8pw#key-1",
        "type": "JsonWebKey2020",
        "privateKeyJwk": {
          "kty": "OKP",
          "crv": "Ed25519",
          "d": "NzJXR3A3TmdGUjFPcWRpOHpsdDdqUVE0MzRYUjBjTlE",
          "x": "jpIKKU2b77lNXKTNW2NGvw1GUMjU6v_l_tLJAH5uYz0"
        }
      }
    ]
  },
  "did": "did:indy:sovrin:WRfXPg8dantKVubE3HX8pw"
}

Response

The request was successful, and the DID may or may not be fully deactivated yet, as indicated by the "didState.state" and "jobId" output fields. Additional state information plus metadata are available in the response body.

didRegistrationMetadataobject
didDocumentMetadataobject

Example response

{
  "didState": {
    "secret": {
      "verificationMethod": [
        {
          "id": "did:indy:sovrin:WRfXPg8dantKVubE3HX8pw#key-1",
          "type": "JsonWebKey2020",
          "privateKeyJwk": {
            "kty": "OKP",
            "crv": "Ed25519",
            "d": "NzJXR3A3TmdGUjFPcWRpOHpsdDdqUVE0MzRYUjBjTlE",
            "x": "jpIKKU2b77lNXKTNW2NGvw1GUMjU6v_l_tLJAH5uYz0"
          }
        }
      ]
    }
  }
}