DELETE
/
v2
/
user
/
{user_id}
curl --request DELETE \
     --url {{BASE_URL}}/v2/user/{user_id} \
     --header 'x-vital-api-key: <API_KEY>' \
     --header 'Accept: application/json'
{
  "success": true
}

Deleting a user would also deregister their all provider connections immediately. Vital erases the user data after a 7-day grace period.

If you wish to undo a user deletion for any reason, you can undo the deletion through the Undo User Deletion API. Note that undoing would not restore any provider connections.

curl --request DELETE \
     --url {{BASE_URL}}/v2/user/{user_id} \
     --header 'x-vital-api-key: <API_KEY>' \
     --header 'Accept: application/json'
{
  "success": true
}

Authorizations

x-vital-api-key
string
headerrequired

Vital Team API Key

Path Parameters

user_id
string
required

Response

200 - application/json
success
boolean
required

Whether operation was successful or not