Prepare Clerk email address verification

Send a verification code or link for a Clerk email address.

← All Clerk endpoints · Capability overview

POST/v1/clerk/email-addresses/{email_address_id}/prepare-verification

https://api.vee3.io/v1/clerk/email-addresses/{email_address_id}/prepare-verification

5 tokens

Send a verification code or link for a Clerk email address.

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.prepare_email_address_verification

Parameters4 fields

clerk_instance_idstringOptional

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

email_address_idstringRequired

Clerk email address id (idn_...) to retrieve or modify.

strategy"email_code" | "email_link"Required

Verification strategy: email_code sends an OTP; email_link sends a link.

redirect_urlstringOptional

Required when strategy is email_link. URL the user is redirected to after clicking the link.

Response15 fields

email_addressobject

8 fields

Clerk email address summary after preparing verification.

idstring

Clerk email address id (idn_...).

user_idstring

Clerk user id (user_...) that owns this email address.

email_addressstring

Email address value.

verification_statusstring

Verification status (e.g. verified, unverified, failed).

verifiedboolean

Whether the email address is verified.

primaryboolean

Whether this is the user's primary email address.

created_atinteger

Unix timestamp in milliseconds when the email address was created.

updated_atinteger

Unix timestamp in milliseconds when the email address was last updated.

verificationobject

5 fields

Verification object from the Clerk Backend API.

idstring

Verification id returned by prepare_verification.

statusstring

Verification status (verified, unverified, expired, or failed).

strategystring

Verification strategy (e.g. phone_code).

attemptsinteger

Number of verification attempts made.

expire_atinteger

Unix timestamp in milliseconds when the verification code expires.

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/email-addresses/{email_address_id}/prepare-verification"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "email_address_id": "idn_2abc123",
    "strategy": "email_code"
}

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

Example responses1 example

200Verification initiated for a Clerk email address.

verification_prepared.json

{
  "email_address": {
    "id": "idn_2abc123",
    "user_id": "user_2abc123",
    "email_address": "ada@example.com",
    "verification_status": "unverified",
    "verified": false,
    "primary": false,
    "created_at": 1710000000000,
    "updated_at": 1710086400000
  },
  "verification": {
    "id": "ver_2abc123",
    "status": "unverified",
    "strategy": "email_code",
    "attempts": 0,
    "expire_at": 1710003600000
  }
}