Create Clerk allowlist identifier

Add an email, phone, domain pattern, or Web3 wallet to the Clerk allowlist.

← All Clerk endpoints · Capability overview

POST/v1/clerk/allowlist-identifiers

https://api.vee3.io/v1/clerk/allowlist-identifiers

8 tokens

Add an email, phone, domain pattern, or Web3 wallet to the Clerk allowlist.

Authorization

Send your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

MCP

The same capability is available as an MCP tool on Vee3 hosted MCP.

Tool name

clerk.create_allowlist_identifier

Parameters3 fields

clerk_instance_idstringOptional

Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

identifierstringRequired

Identifier to allowlist: email, wildcard domain (*@example.com), E.164 phone (+15555555555), or Web3 wallet address.

notifybooleanOptional

When true, notify the user by email or SMS that they were added to the allowlist.

Response7 fields

identifierobject

6 fields

Created allowlist identifier object from the Backend API.

idstring

Allowlist identifier id (alid_...).

identifierstring

Allowlisted email, phone, domain pattern, or Web3 wallet address.

identifier_typestring

Type of identifier: "email_address", "phone_number", or "web3_wallet".

invitation_idstring

Clerk invitation id (inv_...) when the entry was created from an invitation.

created_atinteger

Unix timestamp in milliseconds when the entry was created.

updated_atinteger

Unix timestamp in milliseconds when the entry was last updated.

HTTP errors: clerk_connection_required, clerk_connection_not_found, clerk_connection_invalid, validation_error, unauthorized, payment_required

Example request

Python

import requests

url = "https://api.vee3.io/v1/clerk/allowlist-identifiers"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "identifier": "ada@example.com"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Newly created allowlist identifier.

created_allowlist_identifier.json

{
  "identifier": {
    "id": "alid_2abc123",
    "identifier": "ada@example.com",
    "identifier_type": "email_address",
    "created_at": 1710000000000,
    "updated_at": 1710000000000
  }
}