Sign in

v1

latestOpenAPI 3.0.02026-07-2482421001.1 KB
File Commands

Delete document

Delete a <glossary:Document> uploaded to a <glossary:Book>.

You can only delete files that are in the VERIFICATION_COMPLETE or REJECTED states. Attempting to delete a file in any other state will return a failure as shown in the examples.

🚧 No turning back! Deleted <glossary:Document>s and associated data (such as transactions) cannot be recovered. Make sure you're ready!

post/v1/document/remove

Request body

doc_uuidstring

The unique identifier of the <glossary:Document> (not the <glossary:Book>) that will be deleted. Mutually exclusive with doc_id.

doc_idstring

The <glossary:PK> of the <glossary:Document> (not the <glossary:Book>) that will be deleted. Mutually exclusive with doc_uuid.

Response

Success

statusinteger

A numerical code that indicates the status of the request.

responseobject

An object received from the server that potentially contains data.

messagestring

A textual description that indicates details about this response's status.

Example response

{
  "status": 200,
  "message": "OK"
}