Skip to main content

Retrieve Loan Documents

Retrieves all documents for a specific loan account.

Command Name

RetrieveLoanDocumentsListQuery

Endpoint

POST /api/core/cmd

Request Parameters

ParameterTypeRequiredDescription
loanIdlongYesLoan account ID
documentTypeintegerNoFilter by document type
pageNumberintegerNoPage number (default: 1)
pageSizeintegerNoItems per page (default: 20)
isExportbooleanNoExport all results (default: false)

Request Example

{
"Cmd": "RetrieveLoanDocumentsListQuery",
"Data": {
"loanId": 67890,
"pageNumber": 1,
"pageSize": 20
}
}

Response Structure

{
"IsSuccessful": true,
"StatusCode": "00",
"Message": "Loan documents retrieved successfully.",
"Data": {
"items": [
{
"Id": 456,
"EntityType": "Loan",
"EntityId": 67890,
"FileName": "loan_agreement.pdf",
"Title": "Signed Loan Agreement",
"DocumentType": 6,
"DocumentTypeDescription": "Contract",
"UploadedAt": "2024-01-15T10:00:00"
}
],
"totalRows": 12,
"totalPages": 1,
"pageSize": 20,
"currentPage": 1
}
}

Typical Loan Documents

  • Loan application form
  • Collateral documents
  • Property valuations
  • Guarantor documents
  • Signed loan agreement
  • Disbursement authorization
  • Insurance certificates
  • Title deeds
  • Post-dated checks

Use Case Example

Attach property valuation to loan:

{
"Cmd": "CreateDocumentCommand",
"Data": {
"entityType": "Loan",
"loanId": 67890,
"fileName": "property_valuation.pdf",
"fileContentBase64": "...",
"title": "Property Valuation Report",
"description": "Independent valuation for collateral",
"documentType": 6,
"issueDate": "2024-01-15"
}
}