Create user

Create User

curl --request POST \
  --url https://api.privy.io/v1/users \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --header 'privy-app-id: <privy-app-id>' \
  --data '
{
  "linked_accounts": [
    {
      "address": "[email protected]",
      "type": "email"
    }
  ]
}
'

{
  "id": "did:privy:cm3np4u9j001rc8b73seqmqqk",
  "created_at": 1731974895,
  "linked_accounts": [
    {
      "address": "[email protected]",
      "type": "email",
      "first_verified_at": 1674788927,
      "latest_verified_at": 1674788927,
      "verified_at": 1674788927
    },
    {
      "type": "farcaster",
      "fid": 4423,
      "owner_address": "0xE6bFb4137F3A8C069F98cc775f324A84FE45FdFF",
      "username": "payton",
      "display_name": "payton ↑",
      "bio": "engineering at /privy. building pixelpool.xyz, the first Farcaster video client. nyc. 👨‍💻🍎🏳️‍🌈  nf.td/payton",
      "profile_picture": "https://supercast.mypinata.cloud/ipfs/QmNexfCxdnFzWdJqKVgrjd27UGLMexNaw5FXu1XKR3cQF7?filename=IMG_2799.png",
      "profile_picture_url": "https://supercast.mypinata.cloud/ipfs/QmNexfCxdnFzWdJqKVgrjd27UGLMexNaw5FXu1XKR3cQF7?filename=IMG_2799.png",
      "verified_at": 1740678402,
      "first_verified_at": 1740678402,
      "latest_verified_at": 1741194370
    },
    {
      "type": "passkey",
      "credential_id": "Il5vP-3Tm3hNmDVBmDlREgXzIOJnZEaiVnT-XMliXe-BufP9GL1-d3qhozk9IkZwQ_",
      "authenticator_name": "1Password",
      "public_key": "pQECAyYgASFYIKdGwx5XxZ/7CJJzT8d5L6jyLNQdTH7X+rSZdPJ9Ux/QIlggRm4OcJ8F3aB5zYz3T9LxLdDfGpWvYkHgS4A8tPz9CqE=",
      "created_with_browser": "Chrome",
      "created_with_os": "Mac OS",
      "created_with_device": "Macintosh",
      "enrolled_in_mfa": true,
      "verified_at": 1741194420,
      "first_verified_at": 1741194420,
      "latest_verified_at": 1741194420
    }
  ],
  "mfa_methods": [
    {
      "type": "passkey",
      "verified_at": 1741194420
    }
  ],
  "has_accepted_terms": true,
  "is_guest": false
}

POST

users

Create User

curl --request POST \
  --url https://api.privy.io/v1/users \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --header 'privy-app-id: <privy-app-id>' \
  --data '
{
  "linked_accounts": [
    {
      "address": "[email protected]",
      "type": "email"
    }
  ]
}
'

{
  "id": "did:privy:cm3np4u9j001rc8b73seqmqqk",
  "created_at": 1731974895,
  "linked_accounts": [
    {
      "address": "[email protected]",
      "type": "email",
      "first_verified_at": 1674788927,
      "latest_verified_at": 1674788927,
      "verified_at": 1674788927
    },
    {
      "type": "farcaster",
      "fid": 4423,
      "owner_address": "0xE6bFb4137F3A8C069F98cc775f324A84FE45FdFF",
      "username": "payton",
      "display_name": "payton ↑",
      "bio": "engineering at /privy. building pixelpool.xyz, the first Farcaster video client. nyc. 👨‍💻🍎🏳️‍🌈  nf.td/payton",
      "profile_picture": "https://supercast.mypinata.cloud/ipfs/QmNexfCxdnFzWdJqKVgrjd27UGLMexNaw5FXu1XKR3cQF7?filename=IMG_2799.png",
      "profile_picture_url": "https://supercast.mypinata.cloud/ipfs/QmNexfCxdnFzWdJqKVgrjd27UGLMexNaw5FXu1XKR3cQF7?filename=IMG_2799.png",
      "verified_at": 1740678402,
      "first_verified_at": 1740678402,
      "latest_verified_at": 1741194370
    },
    {
      "type": "passkey",
      "credential_id": "Il5vP-3Tm3hNmDVBmDlREgXzIOJnZEaiVnT-XMliXe-BufP9GL1-d3qhozk9IkZwQ_",
      "authenticator_name": "1Password",
      "public_key": "pQECAyYgASFYIKdGwx5XxZ/7CJJzT8d5L6jyLNQdTH7X+rSZdPJ9Ux/QIlggRm4OcJ8F3aB5zYz3T9LxLdDfGpWvYkHgS4A8tPz9CqE=",
      "created_with_browser": "Chrome",
      "created_with_os": "Mac OS",
      "created_with_device": "Macintosh",
      "enrolled_in_mfa": true,
      "verified_at": 1741194420,
      "first_verified_at": 1741194420,
      "latest_verified_at": 1741194420
    }
  ],
  "mfa_methods": [
    {
      "type": "passkey",
      "verified_at": 1741194420
    }
  ],
  "has_accepted_terms": true,
  "is_guest": false
}

Authorizations

Authorization

string

header

required

Basic Auth header with your app ID as the username and your app secret as the password.

Headers

privy-app-id

string

required

ID of your Privy app.

Body

application/json

linked_accounts

required

The input for adding a linked account to a user.

Wallet
Email
Phone
Google
Twitter
Discord
Github
Spotify
Instagram
Tiktok
LINE
Twitch
Apple
LinkedIn
Farcaster
Telegram
Custom JWT

Show child attributes

linked_accounts.type

enum<string>

required

Available options:

wallet

linked_accounts.address

required

linked_accounts.chain_type

enum<string>

required

Available options:

ethereum,

solana

Example:

{
  "type": "email",
  "address": "[email protected]"
}

custom_metadata

object

Custom metadata associated with the user.

Show child attributes

custom_metadata.{key}

wallets

object[]

Wallets to create for the user.

Show child attributes

wallets.chain_type

enum<string>

required

The wallet chain types.

Available options:

ethereum,

solana,

cosmos,

stellar,

sui,

aptos,

movement,

tron,

bitcoin-segwit,

near,

ton,

starknet,

spark

wallets.additional_signers

object[]

Additional signers for the wallet.

Show child attributes

wallets.additional_signers.signer_id

string

required

The key quorum ID for the signer.

wallets.additional_signers.override_policy_ids

string[]

The array of policy IDs that will be applied to wallet requests. If specified, this will override the base policy IDs set on the wallet. Currently, only one policy is supported per signer.

Required string length: 24

wallets.policy_ids

string[]

Policy IDs to enforce on the wallet. Currently, only one policy is supported per wallet.

Maximum array length: 1

Required string length: 24

wallets.create_smart_wallet

boolean

Create a smart wallet with this wallet as the signer. Only supported for wallets with chain_type: "ethereum".

Response

200 - application/json

Newly created user object.

string

required

linked_accounts

required

A linked account for the user.

Email
Phone
CrossApp
Authorization Key
Custom Jwt
Apple
Discord
Github
Google
Instagram
LinkedIn
Spotify
Tiktok
Line
Twitch
Twitter
LinkedAccountSmartWallet
Passkey
Farcaster
Telegram
Ethereum
LinkedAccountEthereumEmbeddedWallet
Solana
LinkedAccountSolanaEmbeddedWallet
LinkedAccountBitcoinSegwitEmbeddedWallet
LinkedAccountBitcoinTaprootEmbeddedWallet
LinkedAccountCurveSigningEmbeddedWallet
LinkedAccountCustomOauth

Show child attributes

linked_accounts.type

enum<string>

required

Available options:

email

linked_accounts.address

string

required

linked_accounts.verified_at

number

required

linked_accounts.first_verified_at

number | null

required

linked_accounts.latest_verified_at

number | null

required

mfa_methods

(Passkey · object | SMS · object | TOTP · object)[]

required

Passkey
SMS
TOTP

Show child attributes

mfa_methods.type

enum<string>

required

Available options:

passkey

mfa_methods.verified_at

number

required

created_at

number

required

Unix timestamp of when the user was created in milliseconds.

has_accepted_terms

boolean

required

Indicates if the user has accepted the terms of service.

is_guest

boolean

required

Indicates if the user is a guest account user.

custom_metadata

object

Custom metadata associated with the user.

Show child attributes

custom_metadata.{key}

Delete key quorum Get user by ID

⌘I

API reference

Wallets

Account funding

Policies

Condition sets

Transactions

Key quorums

Users

Authorizations

Headers

Body

Response