Skip to main content

Remove Member from KYC Group

Removes one address from a KYC group.

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

The address in the path must match the stored address exactly, letter case included: copy it from the member list. Only the platform owner (root) node may call it.

Required permission: kyc:group:member:delete

Request​

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

Parameters​

NameTypeInDescription
kyc_token_idstringpathRequired. The KYC token's id, from List KYC Tokens
group_idstringpathRequired. The group's id (24-character hex), not its numeric group_id
user_addressstringpathRequired. The address to remove, exactly as stored

Headers​

NameDescription
AuthorizationRequired. Bearer <access_token>

Example​

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

Response​

Status 200.

{
"requires_approval": false,
"completed": true
}

Response Fields​

FieldTypeDescription
requires_approvalbooleanAlways false: KYC writes have no approval step
completedbooleantrue once the request is accepted and the on-chain call is queued. It does not mean the chain has confirmed it

Errors​

StatusCodeDescription
40310005 (domain 2)Your node is not the platform owner (root) node
40020001001KYC group not found, or it lives on another KYC token than the path names
40010015The address is not a member of this group (kyc group member not found)
40010015The KYC token cannot be resolved (kyc token not found or not deployed)

See Errors for the error format and common codes.