Skip to main content
POST
/
signin
/
passwordless
/
sms
Sign In SMS
curl --request POST \
  --url https://local.auth.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
​
phoneNumber
string
required
​
options
object

Response

SMS sent successfully

The response is of type string.

Example:

"OK"

⌘I