Sign in

v15

latestOpenAPI 3.0.0MIT Licenseraw.githubusercontent.com2026-08-016088119.5 KB
authentication

Sign in with SMS OTP

Initiate passwordless authentication by sending a one-time password to the user's phone number. If the user doesn't exist and AUTH_DISABLE_AUTO_SIGNUP is not set, a new account will be created with the provided options. When AUTH_DISABLE_AUTO_SIGNUP is enabled, users must use the /signup/passwordless/sms endpoint to register first.

post/signin/passwordless/sms

Request body

phoneNumberstring required

Phone number of the user

Example request

{
  "phoneNumber": "+123456789",
  "options": {
    "allowedRoles": [
      "me",
      "user"
    ],
    "defaultRole": "user",
    "displayName": "John Smith",
    "locale": "en",
    "metadata": {
      "firstName": "John",
      "lastName": "Smith"
    },
    "redirectTo": "https://my-app.com/catch-redirection"
  }
}

Response

OTP sent to the user's phone number. To prevent account enumeration, this response is also returned without side effects when the phone number is not registered and AUTH_DISABLE_AUTO_SIGNUP is enabled.

'OK' required