Download loan document

Loan documents are often used in lending to keep copies of a borrower's loan agreement and more. Note the following when using this request:

This request downloads a loan document that is saved within the account.

The endpoint of this request requires the ID of the file. To find the ID of a loan document, use the GET loan documents request.

The endpoint of this request also requires the name of the file. This is a value that's generated by the system when the file is uploaded—not the name of the file shown in the UI. This value isn't shown in the UI, and it's stored within the FileAttachment object nested within the Documents object. To find this value, send a GET request to the following endpoint:

https://loanpro.simnang.com/api/public/api/1/odata.svc/Loans({LoanID})/Documents({DocumentID})?$select=FileAttachment&$expand=FileAttachment

The response from the request above will include system-generated filename within the "fileName" field. The value in this field is what is included in the endpoint to download the file. Here's an example of what to look for:

{
    "d": {
        "__metadata": {
            "uri": "http://loanpro.simnang.com/api/public/api/1/odata.svc/LoanDocuments(id=348)",
            "type": "Entity.Document"
        },
        "FileAttachment": {
            "__metadata": {
                "uri": "http://loanpro.simnang.com/api/public/api/1/odata.svc/FileAttachments(id=487)",
                "type": "Entity.FileAttachment"
            },
            "id": 487,
            "parentType": "Entity.LoanDocument",
            "parentId": 348,
            "fileName": "Contract_63cb047e555d1f6a2d13de8fbae0386142e9126945555.pdf", // 👈 This is the system-generated filename.
            "fileOriginalName": "Contract.pdf",
            "fileSize": 49,
            "fileMime": "application/pdf",
            "fileUrl": null
        },
        "summary": {
            "start": 0,
            "pageSize": 50,
            "total": 0
        }
    }
}

For an example of 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:

Database – Loan Document Entity (loan_document_entity)

Database – Loan Table (loan_entity)

Endpoint Example

https://loanpro.simnang.com/api/public/api/1/files/5200243/LoanDocuments(340)/loan_document_623e249820d0751fb09cce250a7e2a783034e836b6232.txt