Delete user

Remove user via the Junction API. Requires authentication with your team API key.

DELETE /v2/user/{user_id}

cURL

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

200

{
  "success": true
}

Deleting a user would also deregister all their provider connections immediately. Junction 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

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

Authorizations

x-vital-api-key · string · header · required

Vital Team API Key

Path Parameters

user_id · string<uuid> · required

Response

200

application/json

Successful Response

success · boolean · required

Whether operation was successful or not