Download Loan Document

This request allows you to download a loan document saved within your account.

General

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

  • This request downloads a loan document that is saved within your account.
  • The endpoint of this request requires the ID of the file. To find the ID of a loan document, you will send a 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/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 you will include 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:

📘

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.

Language
Authentication
Click Try It! to start a request and see the response here!