List All KYC Groups

Retrieves a paginated list of all KYC groups in the system.

Request

GET /v2/admin/kyc/groups

Parameters

Name	Type	In	Description
search	string	query	Optional. Search by group name
page	integer	query	Required. Page number (default: 1)
per_page	integer	query	Required. Items per page (default: 10, max: 100)

Headers

Name	Description
Authorization	Required. Bearer token for authentication

Example

curl --request GET \
  --url '{{baseUrl}}/v2/admin/kyc/groups?page=1&per_page=10&search=Premium' \
  --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'

Response

{
  "data": [
    {
      "id": "67d8774e903bfcbe7eb5d93e",
      "group_id": 1,
      "name": "Premium Investors",
      "created_at": "2025-01-15T10:30:00.000Z",
      "updated_at": "2025-01-15T10:30:00.000Z",
      "deleted_at": null
    },
    {
      "id": "67d8774e903bfcbe7eb5d93f",
      "group_id": 2,
      "name": "Standard Users",
      "created_at": "2025-01-16T11:00:00.000Z",
      "updated_at": "2025-01-16T11:00:00.000Z",
      "deleted_at": null
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 10,
    "total": 2
  }
}

Response Fields

Field	Type	Description
data	array	Array of KYC group objects
pagination	object	Pagination information
pagination.page	integer	Current page number
pagination.per_page	integer	Number of items per page
pagination.total	integer	Total number of items

KYC Group Object Fields

Field	Type	Description
id	string	Unique identifier for the KYC group
group_id	integer	Numeric group identifier
name	string	Name of the KYC group
created_at	string	ISO 8601 timestamp when the group was created
updated_at	string	ISO 8601 timestamp when the group was updated
deleted_at	string/null	ISO 8601 timestamp when the group was deleted (null if not deleted)

Status Codes

Status Code	Description
200	Success
400	Bad Request - Invalid parameters
401	Unauthorized - Invalid or missing authentication token
500	Internal Server Error