Add Member to KYC Group
Adds one address to a KYC group.
Asynchronous: the member is recorded at once and shows up in List KYC Group Members, and the on-chain call is queued, signed by the KYC token's owner wallet. It is recorded as a node transaction of type 39 (AddMemberToKycGroup) on the platform owner node, with internal_id set to the group's id; see Asynchronous writes.
Only the platform owner (root) node may call it.
Required permission: kyc:group:member:create
Request
POST /v2/admin/kycs/{kyc_token_id}/groups/{group_id}/members
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> |
Content-Type | Required. application/json |
Body
| Field | Type | Required | Description |
|---|---|---|---|
user_address | string | Yes | The wallet address to add. Stored exactly as sent; its format is not checked |
Example
curl --request POST \
--url '{{baseUrl}}/v2/admin/kycs/68c4a1f2b9e3d70012a5c3e8/groups/68d2e7a9c1b4f30045e1a9b2/members' \
--header 'Authorization: Bearer <access_token>' \
--header 'Content-Type: application/json' \
--data '{
"user_address": "0x1234567890123456789012345678901234567890"
}'
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 | 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) |
| 500 | 10000 | The address is already a member of this group |
See Errors for the error format and common codes.