Create KYC Group
Creates a KYC group on a KYC token.
Asynchronous: the group is recorded at once — it gets its id and its on-chain number group_id, and shows up in List KYC Groups — and the on-chain creation is queued, signed by the KYC token's owner wallet. It is recorded as a node transaction of type 37 (CreateKycGroup) on the platform owner node, with internal_id set to the group's id; see Asynchronous writes. The response does not carry the new group's id: read it from List KYC Groups (filter with search).
The API checks that the KYC token exists, not that its deploy has finished: create groups on tokens that List KYC Tokens returns. Only the platform owner (root) node may call it.
Required permission: kyc:group:create
Request
POST /v2/admin/kycs/{kyc_token_id}/groups
Parameters
| Name | Type | In | Description |
|---|---|---|---|
kyc_token_id | string | path | Required. The KYC token's id, from List KYC Tokens |
Headers
| Name | Description |
|---|---|
Authorization | Required. Bearer <access_token> |
Content-Type | Required. application/json |
Body
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | The group's name. Names do not have to be unique |
Example
curl --request POST \
--url '{{baseUrl}}/v2/admin/kycs/68c4a1f2b9e3d70012a5c3e8/groups' \
--header 'Authorization: Bearer <access_token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "Accredited Investors"
}'
Response
Status 201.
{
"requires_approval": false,
"completed": true
}
Response Fields
| Field | Type | Description |
|---|---|---|
requires_approval | boolean | Always false: KYC writes have no approval step |
completed | boolean | true once the request is accepted and the on-chain call is queued. It does not mean the chain has confirmed it |
Errors
| Status | Code | Description |
|---|---|---|
| 400 | 10015 | Validation failed — see details |
| 403 | 10005 (domain 2) | Your node is not the platform owner (root) node |
| 400 | 20001004 | kyc_token_id is not a valid id |
| 400 | 10015 | No KYC token with this kyc_token_id (kyc token not found or not deployed) |
See Errors for the error format and common codes.