clerk.attempt_phone_number_verification
ActiveTool of Vee3
declared in 1.27.1
Verify an SMS code sent to a Clerk phone number. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns updated verification status. Cost = 5 tokens.
Parameters schema
{
"type": "object",
"title": "attempt_clerk_phone_number_verificationArguments",
"required": [
"phone_number_id",
"verification_id",
"code"
],
"properties": {
"code": {
"type": "string",
"title": "Code",
"description": "SMS verification code entered by the user."
},
"phone_number_id": {
"type": "string",
"title": "Phone Number Id",
"description": "Clerk phone number id (idn_... or phn_...) to retrieve or modify."
},
"verification_id": {
"type": "string",
"title": "Verification Id",
"description": "Verification id from prepare-clerk-phone-number-verification."
},
"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."
}
}
}Parent server
Vee3
https://github.com/Vee3io/Vee3
1/7 registries