Skip to main content

Get Client Activities

Retrieve all activities related to a specific client. This is a convenience query that wraps GetActivitiesQuery with entity type set to Client.

Command​

Use GetActivitiesQuery with entity: "Client":

{
  "Cmd": "GetActivitiesQuery",
  "Data": {
    "entity": "Client",
    "entityId": "12345",
    "pageSize": 50
  }
}

Request Parameters​

ParameterTypeRequiredDescription
entitystringYesMust be "Client"
entityIdstringNo*Database ID of the client
encodedKeystringNo*Client's encoded key
startDatestringNoStart date filter (YYYY-MM-DD)
endDatestringNoEnd date filter (YYYY-MM-DD)
pageNumberintegerNoPage number (default: 1)
pageSizeintegerNoItems per page (default: 50)

*Either entityId or encodedKey is required.

Examples​

Using Client ID​

{
  "Cmd": "GetActivitiesQuery",
  "Data": {
    "entity": "Client",
    "entityId": "12345",
    "startDate": "2025-01-01",
    "pageSize": 100
  }
}

Using Client Encoded Key​

{
  "Cmd": "GetActivitiesQuery",
  "Data": {
    "entity": "Client",
    "encodedKey": "8a80866e7f123456",
    "pageSize": 50
  }
}

Response Example​

{
  "Status": "00",
  "Message": "Activities retrieved successfully",
  "Data": {
    "activities": [
      {
        "Id": 1001,
        "CreationDate": "2025-12-24T10:30:00",
        "UserName": "jane.doe@banklingo.com",
        "UserKey": "8a80866e7f123456",
        "Action": "Create",
        "ActivityDescription": "Created client profile",
        "AffectedItemType": "Customer",
        "AffectedCustomerName": "John Smith",
        "AffectedCustomerEncodedKey": "8a80866e7f654321"
      },
      {
        "Id": 1002,
        "CreationDate": "2025-12-24T11:00:00",
        "UserName": "jane.doe@banklingo.com",
        "Action": "Update",
        "ActivityDescription": "Updated client KYC information",
        "AffectedItemType": "Customer",
        "AffectedCustomerName": "John Smith",
        "AffectedCustomerEncodedKey": "8a80866e7f654321"
      }
    ],
    "totalRows": 25,
    "totalPages": 1,
    "currentPage": 1,
    "pageSize": 50
  }
}

TypeScript Example​

async function getClientActivities(clientId: string, startDate?: string): Promise<ActivityResponse> {
  const response = await fetch('/api/core/cmd', {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'Authorization': `Bearer ${token}`
    },
    body: JSON.stringify({
      Cmd: 'GetActivitiesQuery',
      Data: {
        entity: 'Client',
        entityId: clientId,
        startDate: startDate,
        pageSize: 50
      }
    })
  });

  return await response.json();
}

// Usage
const activities = await getClientActivities('12345', '2025-01-01');
console.log(`Client has ${activities.Data.totalRows} activities`);

Common Activity Types for Clients​

  • Create: Client profile created
  • Update: Profile information updated
  • KYC: KYC documents uploaded/verified
  • Account Opening: New loan or deposit account created for client
  • Status Change: Client status changed (active, inactive, blocked)
  • Relationship: Assigned to new relationship manager
  • Contact: Contact information updated
  • Document: Document uploaded or verified

Use Cases​

Client Profile History​

View complete history of changes to a client profile:

{
  "Cmd": "GetActivitiesQuery",
  "Data": {
    "entity": "Client",
    "encodedKey": "8a80866e7f123456",
    "pageSize": 100
  }
}

Recent Client Interactions​

View recent activities for a client:

{
  "Cmd": "GetActivitiesQuery",
  "Data": {
    "entity": "Client",
    "entityId": "12345",
    "startDate": "2025-12-01",
    "pageSize": 20
  }
}

Client Audit Trail​

Generate complete audit trail for compliance:

{
  "Cmd": "GetActivitiesQuery",
  "Data": {
    "entity": "Client",
    "entityId": "12345",
    "startDate": "2024-01-01",
    "endDate": "2024-12-31",
    "pageSize": 1000
  }
}

Note: This query only returns activities where the client is the affected entity. For activities performed by a client (if they have user access), use Get User Activities instead.