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 pulls a specific document saved to a customer within your account.
- You will need to know the document's ID to use this request. If you need help finding it, a GET request to the
Customersendpoint like the following will help:
- You won't be able to view or download the document with this request. You'll simply be able to view the document's information such its file name, document ID, upload IP address, and more.
A Note About Customer Documents
When you pull document information through the API, the
activeproperty will show
0for all documents. The
activeproperty is no longer used to show if a document is active. The
archivedproperty, on the other hand, is now used to show whether the document is active/archived. An
1means it has been archived, and
0means it is still active.
To see how customer documents work within the UI, take a look at our Uploading a Customer Document article.
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)
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.