Delete Loan Document

General

Loan documents are often used in lending to keep a copy of a borrower's loan agreement and more. Here's what you need to know about this request:

While deleting documents is possible, it's not recommended.
Deleting a document is not typically necessary, and it can do more harm than good. Instead, it's best just to update a document by uploading a new file and updating the title of the document. If you want to update a document and keep the existing one, we suggest creating a totally new document and archiving the old one by changing its archived parameter.

If you're thinking about deleting a document so it isn't displayed to customers, it's much better (and much easier) to update the document's customerVisible field.

But, if you uploaded something really embarrassing on accident and want to delete the document entirely to relieve you of your shame, we suppose a delete makes some sense.

If you're feeling independent, a tad destructive, or just don't want to listen to our advice because you don't like us, here's some more information for deleting documents:

Deleting a loan document executes a "soft delete" where it is still included in the database but marked as "deleted".
You will need to know the ID of the document, and this ID is not found in the UI. You will need to use a GET request to find a document's ID.

To see how loan documents work within the UI, take a look at our Loan Documents article.

Database

For information on loan document database tables, see the following articles:

❗️
Try It Instructions
Our requests often provide sample payload information so that you can receive a 200 response from simply hitting the Try It button. Since this is a DELETE request, this one is a bit different.
To receive a 200 response from the Try It button, you will have to try this request with your own tenant credentials. If you plan on doing so, make sure to change the headers to match your own authentication information.