Retrieve Client Documents

Retrieves all documents for a specific client.

Command Name

RetrieveClientDocumentsListQuery

Endpoint

POST /api/core/cmd

Request Parameters

Parameter	Type	Required	Description
clientId	long	Yes	Client ID
documentType	integer	No	Filter by document type
pageNumber	integer	No	Page number (default: 1)
pageSize	integer	No	Items per page (default: 20)
isExport	boolean	No	Export all results (default: false)

Request Example

{
  "Cmd": "RetrieveClientDocumentsListQuery",
  "Data": {
    "clientId": 12345,
    "pageNumber": 1,
    "pageSize": 20
  }
}

Response Structure

{
  "IsSuccessful": true,
  "StatusCode": "00",
  "Message": "Client documents retrieved successfully.",
  "Data": {
    "items": [
      {
        "Id": 789,
        "EntityType": "Client",
        "EntityId": 12345,
        "FileName": "passport.pdf",
        "Title": "International Passport",
        "DocumentType": 2,
        "DocumentTypeDescription": "Passport",
        "UploadedAt": "2024-01-20T14:30:00",
        "IsExpired": false
      }
    ],
    "totalRows": 8,
    "totalPages": 1,
    "pageSize": 20,
    "currentPage": 1
  }
}

Typical Client Documents

• National ID
• Passport
• Driver's License
• Utility Bill (proof of address)
• Bank Statement
• Employment Letter
• Tax Identification Number (TIN)
• Business Registration (for corporate clients)

Use Case Example

Retrieve all client documents for KYC review:

{
  "Cmd": "RetrieveClientDocumentsListQuery",
  "Data": {
    "clientId": 12345,
    "isExport": true
  }
}