Documentation | Users › Create Custom Metadata

API Reference

Users

users

Methods

Create User ->

User

post/v1/users

Create a new user with linked accounts. Optionally pre-generate embedded wallets for the user.

Response fields

User

Request example

curl https://api.privy.io/v1/users \
    -H 'Content-Type: application/json' \
    -H "Authorization: Basic $PRIVY_APP_ID:$PRIVY_APP_SECRET" \
    -d '{
      "linked_accounts": [
        {
          "address": "[email protected]",
          "type": "email"
        }
      ]
    }'

200Example

{
  "id": "did:privy:clddy332f002tyqpq3b3lv327",
  "created_at": 1674788927,
  "has_accepted_terms": false,
  "is_guest": false,
  "linked_accounts": [
    {
      "address": "[email protected]",
      "first_verified_at": 1674788927,
      "latest_verified_at": 1674788927,
      "type": "email",
      "verified_at": 1674788927
    }
  ],
  "mfa_methods": [
    {
      "type": "passkey",
      "verified_at": 0
    }
  ],
  "custom_metadata": {
    "foo": "string"
  }
}

Create Custom Metadata -> { custom_metadata }

post/v1/users/{user_id}/custom_metadata

Adds custom metadata to a user by user ID.

path Parameters

user_id: string

ID of the user.

Response fields

custom_metadata: Record<string, string | number | boolean>

Request example

curl https://api.privy.io/v1/users/$USER_ID/custom_metadata \
    -X POST \
    -H "Authorization: Basic $PRIVY_APP_ID:$PRIVY_APP_SECRET"

200Example

{
  "custom_metadata": {
    "foo": "string"
  }
}

Delete User ->

delete/v1/users/{user_id}

Delete a user by user ID.

Get User ->

User

get/v1/users/{user_id}

Get a user by user ID.

Lookup User By Email Address ->

User

post/v1/users/email/address

Looks up a user by their email address.

Lookup User By Custom Auth ID ->

User

post/v1/users/custom_auth/id

Looks up a user by their custom auth ID.

Lookup User By Wallet Address ->

User

post/v1/users/wallet/address

Looks up a user by their wallet address.

Gets Users -> Cursor<

User

get/v1/users

Get all users in your app.

Get User ->

User

get/v1/users/{user_id}

Get a user by user ID.

Domain types

User = { id, created_at, has_accepted_terms, 4 more... }