Skip to main content
DELETE
/
v3
/
identity
/
{identityId}
C#
using Prove.Proveapi;
using Prove.Proveapi.Models.Components;

var sdk = new ProveAPI(auth: "<YOUR_AUTH_HERE>");

var res = await sdk.Identity.V3DisenrollIdentityAsync(identityId: "<id>");

// handle response
{
  "success": true
}

Authorizations

​
Authorization
string
header
required

The access token received from the /token endpoint. Refer to the Authentication page for more details.

Path Parameters

​
identityId
string
required

A Prove-generated unique ID for a specific identity.

Query Parameters

​
clientRequestId
string

A client-generated unique ID for a specific session. This can be used to identify specific requests. The format of this ID is defined by the client - Prove recommends using a GUID, but any format can be accepted. Do not include Personally Identifiable Information (PII) in this field.

Response

V3DisenrollIdentityResponse

Response body for the V3 Disenroll Identity API.

​
success
boolean
required

If true, the disenroll operation was successful.

Example:

true