Skip to main content

Retrieve Deposit Documents

Retrieves all documents for a specific deposit account.

Command Name

RetrieveDepositDocumentsListQuery

Endpoint

POST /api/core/cmd

Request Parameters

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

Request Example

{
"Cmd": "RetrieveDepositDocumentsListQuery",
"Data": {
"depositId": 54321,
"pageNumber": 1,
"pageSize": 20
}
}

Response Structure

{
"IsSuccessful": true,
"StatusCode": "00",
"Message": "Deposit documents retrieved successfully.",
"Data": {
"items": [
{
"Id": 321,
"EntityType": "Deposit",
"EntityId": 54321,
"FileName": "account_opening_form.pdf",
"Title": "Account Opening Form",
"DocumentType": 6,
"DocumentTypeDescription": "Form",
"UploadedAt": "2024-01-10T09:00:00"
}
],
"totalRows": 5,
"totalPages": 1,
"pageSize": 20,
"currentPage": 1
}
}

Typical Deposit Documents

  • Account opening form
  • Signature card
  • Mandate forms (for withdrawals)
  • KYC documents
  • Fixed deposit certificate
  • Standing order instructions
  • Beneficiary designation
  • Account statements

Use Case Example

Retrieve all deposit account documents:

{
"Cmd": "RetrieveDepositDocumentsListQuery",
"Data": {
"depositId": 54321,
"isExport": true
}
}