Download documents

You can download documents associated with a HELOC application using the endpoints described below. These endpoints allow you to retrieve all documents for an application or a specific document by its unique identifier.

List all documents (fetch document metadata)#

Retrieve a list of all documents and their metadata for a given application. This endpoint returns document UUIDs, filenames, types, and content types, which can be used to download individual documents.

Request#

Path parameters#

• appUuid (string, required): The unique identifier for the application.

Response#

• 200 OK: Returns a JSON object containing an array of document metadata objects:

{
  "documents": [
    {
      "documentUuid": "abcdef12-3456-7890-abcd-ef1234567890",
      "fileName": "signed-agreement.pdf",
      "docType": "SIGNED_AGREEMENT",
      "contentType": "application/pdf"
    },
    {
      "documentUuid": "12345678-90ab-cdef-1234-567890abcdef",
      "fileName": "disclosures.zip",
      "docType": "DISCLOSURES",
      "contentType": "application/zip"
    }
  ]
}

Download a specific document#

Download a single document for a given application by its document UUID.

Request#

Path parameters#

• appUuid (string, required): The unique identifier for the application.
• documentUuid (string, required): The unique identifier for the document.

Response#

• 200 OK: Returns a binary file (PDF or other format) for the requested document.

Download all documents#

Download a zip file containing all documents for a given application.

Request#

Path parameters#

• appUuid (string, required): The unique identifier for the application.

Response#

• 200 OK: Returns a binary file (zip) containing all documents for the application.