rip.pds.account.deleteAccount Documentation (EN)

main procedure

Delete an account the caller minted, ahead of its expiry. The identity is retired as it would have been on expiry.

Input

Encodingapplication/json

did stringdid Required

A decentralized identifier (DID).

Output

Encodingapplication/json

deleted boolean Required

No description available.

did stringdid Required

A decentralized identifier (DID).

Errors

AccountNotFound No live account with that DID was minted by the caller.

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Service Endpoint Base URL for XRPC calls (e.g., https://bsky.social)

Request Body (JSON) Enter valid JSON for the request body

View raw schema

{
  "type": "procedure",
  "input": {
    "schema": {
      "type": "object",
      "required": [
        "did"
      ],
      "properties": {
        "did": {
          "type": "string",
          "format": "did"
        }
      }
    },
    "encoding": "application/json"
  },
  "errors": [
    {
      "name": "AccountNotFound",
      "description": "No live account with that DID was minted by the caller."
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "did",
        "deleted"
      ],
      "properties": {
        "did": {
          "type": "string",
          "format": "did"
        },
        "deleted": {
          "type": "boolean"
        }
      }
    },
    "encoding": "application/json"
  },
  "description": "Delete an account the caller minted, ahead of its expiry. The identity is retired as it would have been on expiry."
}