Skip to main content

List KYC Group Members

Retrieves a paginated list of all members in a specific KYC group.

Request

GET /v2/admin/kyc/groups/{groupID}/members

Parameters

NameTypeInDescription
groupIDstringpathRequired. The ID of the KYC group
searchstringqueryOptional. Search by member address
pageintegerqueryRequired. Page number (default: 1)
per_pageintegerqueryRequired. Items per page (default: 10, max: 100)

Headers

NameDescription
AuthorizationRequired. Bearer token for authentication

Example

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

Response

{
"data": [
{
"id": "67d8774e903bfcbe7eb5d93e",
"kyc_group_id": "67d8774e903bfcbe7eb5d93e",
"address": "0x1234567890123456789012345678901234567890",
"created_at": "2025-01-15T10:30:00.000Z",
"updated_at": "2025-01-15T10:30:00.000Z",
"deleted_at": null
}
],
"pagination": {
"page": 1,
"per_page": 10,
"total": 1
}
}

Response Fields

FieldTypeDescription
dataarrayArray of KYC group member objects
paginationobjectPagination information
pagination.pageintegerCurrent page number
pagination.per_pageintegerNumber of items per page
pagination.totalintegerTotal number of items

KYC Group Member Object Fields

FieldTypeDescription
idstringUnique identifier for the group member entry
kyc_group_idstringID of the KYC group
addressstringUser wallet address
created_atstringISO 8601 timestamp when the member was added
updated_atstringISO 8601 timestamp when the member was updated
deleted_atstring/nullISO 8601 timestamp when the member was removed (null if not deleted)

Status Codes

Status CodeDescription
200Success
400Bad Request - Invalid parameters
401Unauthorized - Invalid or missing authentication token
404Not Found - KYC group ID does not exist
500Internal Server Error