Prepare Clerk phone number verification

Send an SMS verification code to a Clerk phone number.

← All Clerk endpoints · Capability overview

POST/v1/clerk/phone-numbers/{phone_number_id}/prepare-verification

https://api.vee3.io/v1/clerk/phone-numbers/{phone_number_id}/prepare-verification

5 tokens

Send an SMS verification code to a Clerk phone number.

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_phone_number_verification

Parameters2 fields

clerk_instance_idstringOptional

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

phone_number_idstringRequired

Clerk phone number id (idn_... or phn_...) to retrieve or modify.

Response6 fields

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/phone-numbers/{phone_number_id}/prepare-verification"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "phone_number_id": "phn_2abc123"
}

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

Example responses1 example

200SMS verification code sent.

verification_prepared.json

{
  "verification": {
    "id": "ver_2abc123",
    "status": "unverified",
    "strategy": "phone_code",
    "attempts": 0,
    "expire_at": 1710003600000
  }
}