POST
/
v3
/
identity
/
{identityId}
/
deactivate
Deactivate Identity
curl --request POST \
  --url https://platform.uat.proveapis.com/v3/identity/{identityId}/deactivate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "clientRequestId": "71010d88-d0e7-4a24-9297-d1be6fefde81"
}'
{
  "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.

Body

application/json

Request body for the V3 Deactivate Identity API.

Response

200
application/json

V3DeactivateIdentityResponse

Response body for the V3 Deactivate Identity API.