Permanently Delete Document

Permanently Delete Document

This endpoint permanently deletes a completed document from the DOC Vault for a specific user. If a document has multiple recipients, deleting it for one user (e.g., the creator) does not remove it from other recipients. Each recipient must delete their copy to fully remove the document from the DOCONCHAIN system.


HTTP Method and URL

DELETE
{{host}}/api/v2/vault/items/:uuid?user_type=ENTERPRISE_API


Authentication Requirements

A valid authentication token (e.g., user-token) must be provided in the request headers.


Path and Query Parameters

  • Path Parameter:

    • uuid (string): The unique identifier of the document to be deleted.
  • Query Parameter:

    • user_type (string): Specifies the type of user. Must be set to ENTERPRISE_API.

Example Request

DELETE {{host}}/api/v2/vault/items/123e4567-e89b-12d3-a456-426614174000?user_type=ENTERPRISE_API
Authorization: Bearer {USER-TOKEN}

Example Successful Response

{
  "success": true,
  "message": "Document permanently deleted."
}

Error Responses

  • 401 Unauthorized

    • The request is missing a valid authentication token or the token is invalid.
  • 404 Not Found

    • The specified document does not exist or has already been deleted.

Usage Notes

  • Deletion is permanent and cannot be undone.

  • All recipients must delete their own copies for the document to be fully removed from the system.

  • Ensure you have the correct uuid before making this request.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Query Params
string
Response

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!