Cancel verified digital identity (admin)

POST

https://api.vlenseg.com/api/DigitalIdentity/CancelVerifiedDigitalIdentityForAdmin

POST

/api/DigitalIdentity/CancelVerifiedDigitalIdentityForAdmin

$ curl -X POST https://api.vlenseg.com/api/DigitalIdentity/CancelVerifiedDigitalIdentityForAdmin \
>      -H "ApiKey: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "userId": "{{user_id}}"
> }'

200Digital Identity - Account Management_postDigitalIdentityCancelVerifiedDigitalIdentityForAdmin_example

1 {
2   "data": {
3     "hasPendingRequest": "<boolean>",
4     "isEmailConfirmationRequired": "<boolean>",
5     "isEmailConfirmed": "<boolean>",
6     "isPhoneNumberConfirmationRequired": "<boolean>",
7     "isPhoneNumberConfirmed": "<boolean>",
8     "phoneNumberOtp": "<string>",
9     "phoneNumberOtpRequestId": "<uuid>",
10     "isDigitalIdentityVerified": "<boolean>",
11     "accessToken": "<string>",
12     "encryptedAccessToken": "<string>",
13     "expireInSeconds": "<integer>",
14     "userName": "<string>",
15     "userFullName": "<string>",
16     "user": {
17       "name": "<string>",
18       "surname": "<string>",
19       "fullName": "<string>",
20       "userName": "<string>",
21       "emailAddress": "<string>",
22       "phoneNumber": "<string>",
23       "idNumber": "<string>"
24     }
25   },
26   "error_code": "<integer>",
27   "error_message": "<string>"
28 }

Allows an admin to cancel verified digital identity for a specific user. Requires ApiKey and an admin bearer token.

Authentication

ApiKeystring

Static API key issued to your tenant. Required on every request.

AuthorizationBearer

Admin JWT from /api/credentials/Login. Required for admin operations.

Request

This endpoint expects an object.

userIdstringRequired

ID of the user whose verified digital identity should be cancelled.

Response

Verified digital identity cancelled for the specified user.

dataobject

error_codestring

error_messagestring