/signin/passwordless/sms
Backend Services
- Authentication
- GET/.well-known/jwks.json
- POST/elevate/webauthn
- POST/elevate/webauthn/verify
- GET/healthz
- HEAD/healthz
- POST/link/idtoken
- GET/mfa/totp/generate
- POST/pat
- POST/signin/anonymous
- POST/signin/email-password
- POST/signin/idtoken
- POST/signin/mfa/totp
- POST/signin/otp/email
- POST/signin/otp/email/verify
- POST/signin/passwordless/email
- POST/signin/passwordless/sms
- POST/signin/passwordless/sms/otp
- POST/signin/pat
- GET/signin/provider/{provider}
- GET/signin/provider/{provider}/callback
- POST/signin/webauthn
- POST/signin/webauthn/verify
- POST/signout
- POST/signup/email-password
- POST/signup/webauthn
- POST/signup/webauthn/verify
- POST/token
- POST/token/verify
- GET/user
- POST/user/deanonymize
- POST/user/email/change
- POST/user/email/send-verification-email
- POST/user/mfa
- POST/user/password
- POST/user/password/reset
- POST/user/provider/tokens
- POST/user/webauthn/add
- POST/user/webauthn/verify
- GET/verify
- GET/version
- GET
- Storage
- AI
Client Libraries
- Javascript
- React
- Next.js
- Vue
- React Native
CLI
/signin/passwordless/sms
Send a one-time password (OTP) to a user through SMS
POST
/
signin
/
passwordless
/
sms
curl --request POST \
--url https://local.auth.local.nhost.run/v1/signin/passwordless/sms \
--header 'Content-Type: application/json' \
--data '{
"phoneNumber": "<string>",
"options": {
"allowedRoles": [
"me",
"user"
],
"defaultRole": "user",
"displayName": "John Smith",
"locale": "en",
"metadata": {
"firstName": "John",
"lastName": "Smith"
},
"redirectTo": "https://my-app.com/catch-redirection"
}
}'
"OK"
Body
application/json
Available options:
me
Example:
["me", "user"]
Available options:
me
, user
Example:
"user"
Example:
"John Smith"
A two-characters locale
Required string length:
2
Example:
"en"
Example:
{ "firstName": "John", "lastName": "Smith" }
Example:
"https://my-app.com/catch-redirection"
Response
200
application/json
SMS sent successfully
The response is of type string
.
Example:
"OK"
Was this page helpful?
curl --request POST \
--url https://local.auth.local.nhost.run/v1/signin/passwordless/sms \
--header 'Content-Type: application/json' \
--data '{
"phoneNumber": "<string>",
"options": {
"allowedRoles": [
"me",
"user"
],
"defaultRole": "user",
"displayName": "John Smith",
"locale": "en",
"metadata": {
"firstName": "John",
"lastName": "Smith"
},
"redirectTo": "https://my-app.com/catch-redirection"
}
}'
"OK"