Download Customer Document

This request downloads a customer document saved within your account.


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:

  • The endpoint of this request requires the ID of the file. To find the ID of a customer document, send a GET Customer 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:{CustomerID})/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 added to the endpoint and is required to download the file. Here's an example of what to look for:
    "d": {
        "__metadata": {
            "uri": "",
            "type": "Entity.CustomerDocument"
        "FileAttachment": {
            "__metadata": {
                "uri": "",
                "type": "Entity.FileAttachment"
            "id": 456,
            "parentType": "Entity.CustomerDocument",
            "parentId": 46,
            "fileName": "ProofOfIncome_61d6253c578d8502f1d37ed9103df22671a82ea4f72f2.txt", // 👈 This is the system-generated filename.
            "fileOriginalName": "ProofOfIncome",
            "fileSize": 1,
            "fileMime": "text/plain",
            "fileUrl": null
        "summary": {
            "start": 0,
            "pageSize": 50,
            "total": 0

For an example of how customer documents work within the UI, take a look at our Uploading a Customer Document article.


For information regarding customer and document database tables, see the following articles:


Try It Instructions

Our pages often provide sample payload information so that you can try requests yourself. This request is ready for you—hit ‘Try It’ to send the request.

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.

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