v1

latestOpenAPI 3.0.02026-07-2482421001.1 KB

File Commands

Delete mixed document

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

Before deleting a mixed document, make sure all its child documents have finished processing. You can proceed with deletion if the child documents are in VERIFICATION_COMPLETE, COMPLETED, FAILED, or REJECTED state. Any child documents already marked as DELETED or DELETING are automatically skipped.

The deletion will fail if any child document is still being processed such as, in QUEUED, PROCESSING, VERIFYING, or GROOMING state. It will also fail if the mixed document itself is already in DELETING or DELETED state.

🚧 No turning back! Deleted mixed documents and associated data, such as transactions, cannot be recovered. Make sure you want to proceed before deleting.

post/v1/document/mixed/remove

Request body

pkstring

The <glossary:PK> of the mixed <glossary:Document> to delete. Required if doc_uuid is not provided.

doc_uuidstring

The unique identifier of the mixed <glossary:Document> to delete. Required if pk is not provided.

Example request

{
  "pk": "25817375",
  "doc_uuid": "1b701415-535b-4a50-b62b-dcb67cb13bd9"
}

Response

Success

statusinteger

A numerical code that indicates the status of the request.

messagestring

A short message describing the result of the request.

Example response

{
  "status": 200,
  "message": "OK",
  "response": {
    "pk": 12345,
    "checksum": "f0a2bc1e9d4b…",
    "created_ts": "2026-05-14T07:34:56Z",
    "book_pk": 6789,
    "name": "loan_packet.pdf",
    "page_count": 17,
    "document_status": "DELETING"
  }
}