Universal Registrar

Deactivate a DID

Changed on Apr 1, 2026

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

Base URL
/1.0/ (relative, and the document was published on a file host, not at the API’s origin)
Auth
none declared
TypeScript
https://skmtc.dev/decentralized-identity/apis/universal-registrar/docs/deactivate/post.ts
A function with typed inputs. Its response is checked against the schema.

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"
          }
        }
      ]
    }
  }
}

Changes

Apr 1, 2026175d66d8fd37 Revision changes
- breaking
  the //// request property type changed from string to no type
- breaking
  added subschema #1 subschema #2 subschema #3 to the //// response property oneOf list for the response status
- breaking
  added subschema #1 subschema #2 subschema #3 to the //// response property oneOf list for the response status
- breaking
  added subschema #1 subschema #2 subschema #3 to the //// response property oneOf list for the response status
- breaking
  the //// response's property type changed from string to no type for status
- breaking
  the //// response's property type changed from string to no type for status
- breaking
  the //// response's property type changed from string to no type for status
- info
  added subschema #1 subschema #2 subschema #3 to the //// request property oneOf list
Jan 20, 202686de75bd330a Revision changes
- breaking
  removed from the ////// request property oneOf list
- breaking
  added to the /////// response property oneOf list for the response status
- breaking
  added to the /////// response property oneOf list for the response status
- breaking
  added to the /////// response property oneOf list for the response status
- info
  added to the ////// request property oneOf list
- info
  removed from the /////// response property oneOf list for the response status
- info
  removed from the /////// response property oneOf list for the response status
- info
  removed from the /////// response property oneOf list for the response status

Operation history (18 revisions)