clerk.prepare_email_address_verification

Active

Tool of Vee3

declared in 1.27.1

Start email address verification for a Clerk user. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns a verification object with id and status. Use attempt-clerk-email-address-verification to submit the code the user receives. Cost = 5 tokens.

Parameters schema

{
  "type": "object",
  "title": "prepare_clerk_email_address_verificationArguments",
  "required": [
    "email_address_id",
    "strategy"
  ],
  "properties": {
    "strategy": {
      "enum": [
        "email_code",
        "email_link"
      ],
      "type": "string",
      "title": "Strategy",
      "description": "Verification strategy: email_code sends an OTP; email_link sends a link."
    },
    "redirect_url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Redirect Url",
      "default": null,
      "description": "Required when strategy is email_link. URL the user is redirected to after clicking the link."
    },
    "email_address_id": {
      "type": "string",
      "title": "Email Address Id",
      "description": "Clerk email address id (idn_...) to retrieve or modify."
    },
    "clerk_instance_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Clerk Instance Id",
      "default": null,
      "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account."
    }
  }
}

What this tool wraps· 1 endpoint

min confidence0.70 0.50

Data resourceYouTube Data API
Google · media
name mention0.60

Parent server

Vee3

https://github.com/Vee3io/Vee3

1/7 registries

View full server →