Delete KYC Group

Deletes a KYC group from its KYC token.

Asynchronous: the on-chain deletion is queued, signed by the KYC token's owner wallet, and the group stays in List KYC Groups until it is confirmed. It is recorded as a node transaction of type 38 (DeleteKycGroup) on the platform owner node, with internal_id set to the group's id; see Asynchronous writes.

This call does not detach the group from tokens' whitelists or blacklists. Only the platform owner (root) node may call it.

Required permission: kyc:group:delete

Request

DELETE /v2/admin/kycs/{kyc_token_id}/groups/{group_id}

Parameters

Name	Type	In	Description
kyc_token_id	string	path	Required. The KYC token's id, from List KYC Tokens
group_id	string	path	Required. The group's id (24-character hex), not its numeric group_id

Headers

Name	Description
Authorization	Required. Bearer <access_token>

Example

curl --request DELETE \
  --url '{{baseUrl}}/v2/admin/kycs/68c4a1f2b9e3d70012a5c3e8/groups/68d2e7a9c1b4f30045e1a9b2' \
  --header 'Authorization: Bearer <access_token>'

Response

Status 200.

{
  "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
403	10005 (domain 2)	Your node is not the platform owner (root) node
400	20001001	KYC group not found, or it lives on another KYC token than the path names
400	10015	The KYC token cannot be resolved (kyc token not found or not deployed)

See Errors for the error format and common codes.