Skip to content

Send SMS verification

POST
/api/auth/phone/send-sms
curl --request POST \
--url http://localhost:3001/api/auth/phone/send-sms \
--header 'Content-Type: application/json' \
--data '{}'

Send an SMS verification code. CAPTCHA-gated. Rate-limited per phone and per IP.

SMS request payload

Media typeapplication/json
object
key
additional properties
any
Examplegenerated
{}

OK

Media typeapplication/json
object
key
additional properties
any
Examplegenerated
{}

Bad Request

Media typeapplication/json
object
error
string
success
boolean
Examplegenerated
{
"error": "example",
"success": true
}

Unauthorized

Media typeapplication/json
object
error
string
success
boolean
Examplegenerated
{
"error": "example",
"success": true
}

Too Many Requests

Media typeapplication/json
object
error
string
success
boolean
Examplegenerated
{
"error": "example",
"success": true
}

Internal Server Error

Media typeapplication/json
object
error
string
success
boolean
Examplegenerated
{
"error": "example",
"success": true
}