This request allows you to edit an existing customer document.
General
Customer documents are often used in lending to keep copies of a borrower's loan agreement, identification information, and more. Here's what you need to know about this request:
- This request edits an existing customer document in your account.
- This request does not edit the document itself; instead, it edits the document's information that is stored in LoanPro such as
sectionId
,fileName
,description
, andactive
status. - You will need to know the document's ID to use this request. If you need help finding it, a GET request to the
Customers
endpoint like the following will help:
https://loanpro.simnang.com/api/public/api/1/odata.svc/Customers(1183)/Documents
A Note About Customer Documents
When you pull document information through the API, the
active
property will show0
for all documents. Theactive
property is no longer used to show if a document is active. Thearchived
property, on the other hand, is now used to show whether the document is active/archived. Anarchive
value of1
means it has been archived, and0
means it is still active.
To see how customer documents work within the UI, take a look at our Uploading a Customer Document article.
Database
For information on customer and customer document database tables, see the following articles:
- Database – Customer Document Entity (customer_document_entity)
- Database – Document Section Entity (doc_section_entity)
- Database – Customer Main Table (customer_entity)
{
"id":9,
"sectionId":1,
"fileName":"test.jpg",
"description":"Test JPeg",
"active":1,
"archived":0,
"customerVisible":1
}
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. This request is ready for you—hit Try It to send the request.
However, if you would like to try this request with your own tenant account, make sure to change the headers to match your own authentication information.