Deleting users

Privy allows you to delete users via their Privy user ID. This is a destructive action: if the user logs into your app again, they will have a new user ID, will create a new embedded wallet address, and will have to relink any formerly linked accounts.

Please take extreme care when deleting users. For security of user assets, Privy does not delete the embedded wallet, and instead “soft deletes” it by disassociating it from the deleted user and archiving the data. If the user still has access to their login method, their wallet can be recovered after deletion. Reprovisioning a deleted wallet involves a support process, so please take care to only delete users that you intend to delete.

NodeJS
NodeJS (server-auth)
REST API
Rust
Dashboard

Use the PrivyClient’s delete method from the users() interface to delete a user. As a parameter, pass the user’s Privy ID as a string:

await privy.users().delete('insert-user-id');

Complete Example

import { PrivyClient } from '@privy-io/node';

const privy = new PrivyClient({
  appId: process.env.PRIVY_APP_ID,
  appSecret: process.env.PRIVY_APP_SECRET
});

async function deletePrivyUser(id: string) {
  try {
    await privy.users().delete(id);
    console.log(`User ${id} successfully deleted`);
    return true;
  } catch (error) {
    console.error(`Failed to delete user: ${error.message}`);
    return false;
  }
}

This method will throw an error if the deletion operation failed (e.g. due to an invalid Privy ID).

The @privy-io/server-auth library is deprecated. We recommend integrating @privy-io/node for the latest features and support.

Use the PrivyClient’s deleteUser method to delete a user. As a parameter, pass the user’s Privy DID as a string:

await privy.deleteUser('did:privy:XXXXXX');

Complete Example

import { PrivyClient } from '@privy-io/server-auth';

const privy = new PrivyClient(
  process.env.PRIVY_APP_ID,
  process.env.PRIVY_APP_SECRET
);

async function deletePrivyUser(did: string) {
  try {
    await privy.deleteUser(did);
    console.log(`User ${did} successfully deleted`);
    return true;
  } catch (error) {
    console.error(`Failed to delete user: ${error.message}`);
    return false;
  }
}

This method will throw an error if the deletion operation failed (e.g. due to an invalid Privy DID).

Make a DELETE request to:

https://auth.privy.io/api/v1/users/<did>

Replace <did> with your user’s Privy DID. It should have the format did:privy:XXXXXX.

Request

Authentication

Basic Auth

Use your Privy app ID as the username and your Privy app secret as the password.

Headers

Object

privy-app-id

string

required

Your Privy app ID.

Example

Below is a sample cURL command for deleting the user object associated with a Privy DID:

curl --request DELETE https://auth.privy.io/api/v1/users/<user-did> \
-u "<your-privy-app-id>:<your-privy-app-secret>" \
-H "privy-app-id: <your-privy-app-id>"

Response

Status Code

number

204 No Content

The user was successfully deleted.

404 Not Found

There is no user associated with the provided Privy DID.

Use the PrivyClient’s delete method from the users() interface to delete a user. As a parameter, pass the user’s Privy ID as a string:

use privy_rs::PrivyClient;

let client = PrivyClient::new(app_id, app_secret)?;
client.users().delete("insert-user-id").await?;

Complete Example

use privy_rs::PrivyClient;

async fn delete_privy_user(
    client: &PrivyClient,
    user_id: &str,
) -> Result<(), Box<dyn std::error::Error>> {
    match client.users().delete(user_id).await {
        Ok(_) => {
            println!("User {} successfully deleted", user_id);
            Ok(())
        }
        Err(error) => {
            eprintln!("Failed to delete user: {}", error);
            Err(error.into())
        }
    }
}

// Usage
let client = PrivyClient::new(app_id, app_secret)?;
delete_privy_user(&client, "cmf56qacr01qpl90brxql83lx").await?;

This method will return an error if the deletion operation failed (e.g. due to an invalid Privy ID).

Migrating users to Privy

Users

Managing users

Webhooks

Complete Example

Complete Example

Request

Example

Response

Complete Example

Steps to delete a user

Migrating users to Privy

Users

Managing users

Webhooks

​Complete Example

​Complete Example

​Request

​Example

​Response

​Complete Example

​Steps to delete a user

Complete Example

Complete Example

Request

Example

Response

Complete Example

Steps to delete a user