Fetch Sub-Entities Profile (Paginated)

This endpoint retrieves a paginated list of sub-entity profiles belonging to the institution associated with the auth token. It supports filtering by name, KYC status, KYC level, and active status.

GET {{host}}/api/v1/institutions/profile/sub-entity

Query Parameters

#	Field Name	Data Type	Required	Default	Description
1	`page`	Integer	Yes	1	Page number to retrieve (1-indexed)
2	`perPage`	Integer	Yes	20	Number of records to return per page
3	`name`	String	No	-	Filter by sub-entity name (partial or full match)
4	`kycStatus`	String	No	-	Filter by KYC verification status
5	`kycLevel`	String	No	-	Filter by KYC level
6	`enabled`	Boolean	No	-	Filter by active status (`true` or `false`)

Sample Request

GET {{host}}/api/v1/institutions/profile/sub-entity?page=1&perPage=20&kycStatus=APPROVED&enabled=true

Response Message Field Description

#	Field Name	Description
1	`page`	The current page number returned
2	`perPage`	Number of records per page
3	`message`	Human-readable result message
4	`totalData`	Total number of sub-entity records across all pages
5	`totalFilteredCount`	Total number of records matching the applied filters
6	`data`	Array of sub-entity objects

Sample Response (Success)

{
  "page": 1,
  "perPage": 20,
  "message": "Success",
  "totalData": 45,
  "totalFilteredCount": 12,
  "data": [
    {
      "id": 78,
      "institutionId": 3,
      "institutionCode": "ACME001",
      "name": "Acme Sub-entity Alpha",
      "email": "[email protected]",
      "vaultId": "94",
      "kycStatus": "APPROVED",
      "kycLevel": "TIER_2",
      "enabled": true,
      "createdOn": "2025-12-01T09:00:00",
      "lastUpdatedOn": "2026-02-10T14:30:00"
    }
  ]
}

Sample Response (Failure)

{
  "success": false,
  "responseCode": "401",
  "responseMessage": "Unauthorized"
}