Adding to the allowlist

Privy allows you to easily add a user's email address, phone number, or wallet address to the allowlist for your app.

Using @privy-io/server-auth

Use the PrivyClient's inviteToAllowlist method to add a user to your allowlist.

const allowlistEntry = await privy.inviteToAllowlist({
  type: 'email',
  value: 'batman@privy.io',
});

As a parameter to the method, pass an AllowlistEntryInput object with the following fields:

Field	Type	Description
type	'email' | 'phone' | 'wallet'	The type of account to add to the allowlist.
value	string	The identifier of the account to add to the allowlist. Should be the corresponding email address, phone number, or wallet address.

If the invitation is successful, the method will return an AllowlistEntryResponse. If the invitation fails, the method will throw an error.

Using the REST API

Make a POST request to:

https://auth.privy.io/api/v1/apps/<your-privy-app-id>/allowlist

In the body of the request, include the following fields:

Field	Type	Description
type	'email' | 'phone' | 'wallet'	The type of account to add to the allowlist.
value	string	The identifier of the account to add to the allowlist. Should be the corresponding email address, phone number, or wallet address.

Below is a sample cURL command for adding an email to the allowlist:

curl --request POST 'https://auth.privy.io/api/v1/apps/<your-privy-app-id>/allowlist' \
-u "<your-privy-app-id>:<your-privy-app-secret>" \
-H "privy-app-id: <your-privy-app-id>" \
-H 'Content-Type: application/json' \
--data-raw '{
    "type": "email",
    "value": "user@email.com"
}'

A successful response will include the new allowlist entry, like below

{
    "id": "allowlist-entry-ID",
    "type": "wallet",
    "value": "0xab5801a7d398351b8be11c439e05c5b3259aec9b",
    "appId": "your-privy-app-ID"
},