Skip to main content

Delete User KYC Token

Recalls the KYC token held by one of the user's wallets. KYC is recorded per (wallet, network, KYC token), so a user with several wallets has no single "KYC" to recall: wallet_id names the wallet and setup_id names the setup whose KYC token is recalled (a network may host several KYC tokens; the setup's own KYC token is the one taken back).

The call is asynchronous. 200 means the recall was queued. It runs as a node transaction of type 31 (RecallKycToken) on the platform root node; follow it with List Node Transactions. Once it settles, the KYC entry for that token is removed from this wallet only; the user's other wallets keep theirs. A setup_id that does not resolve to a deployed KYC token is not refused here: nothing is recalled.

Required permission: user:update

Request​

DELETE /v2/users/{user_id}/kyc-token?setup_id={setup_id}&wallet_id={wallet_id}

Parameters​

NameTypeInDescription
user_idstringpathRequired. User ID
setup_idstringqueryRequired. Setup whose KYC token is recalled
wallet_idstringqueryRequired. The user's wallet the KYC token is taken from. Must belong to this user and hold at least one KYC token

Headers​

NameDescription
AuthorizationRequired. Bearer <access_token>

Example​

curl --request DELETE \
--url '{{baseUrl}}/v2/users/6a87455ad5f439809d488ac3/kyc-token?setup_id=6a80f1c2d5f439809d488a10&wallet_id=6a8754e187be1d0e22aa6d83' \
--header 'Authorization: Bearer <access_token>'

Response​

Status Code: 200 OK, empty body.

Errors​

StatusCodeDescription
40010015Validation failed (setup_id or wallet_id missing) — see details
40010016wallet_id is not a valid id
40010001Domain 1: the wallet does not exist or is not this user's (user not found), or it holds no KYC token (wallet has no kyc token to recall)

See Errors for the error format and common codes.