Get KYC Groups

Retrieves a list of all KYC groups with pagination.

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 (minimum: 1)
per_page	integer	query	Required. Items per page (minimum: 1, maximum: 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' \
  --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'

Response

{
  "data": [
    {
      "id": "67d8774e903bfcbe7eb5d93e",
      "group_id": 1,
      "name": "Verified Users",
      "created_at": "2025-01-15T10:30:00Z",
      "updated_at": "2025-01-15T10:30:00Z",
      "deleted_at": null
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 10,
    "total": 25
  }
}

Response Fields

Field	Type	Description
data	array	Array of KYC group objects
pagination	object	Pagination information

KYC Group Object Fields

Field	Type	Description
id	string	Unique identifier for the KYC group
group_id	integer	Group ID number
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)

Pagination Object Fields

Field	Type	Description
page	integer	Current page number
per_page	integer	Number of items per page
total	integer	Total number of items

Status Codes

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