NHnhost
authentication

Sign up with SMS OTP

Changed on

Register a new user account using SMS OTP authentication. Sends a one-time password to the specified phone number. Use this endpoint to explicitly register a new account. When AUTH_DISABLE_AUTO_SIGNUP is enabled, this is the only way to register through this method.

post/signup/passwordless/sms

Request

  • Base URL
    https://{subdomain}.auth.{region}.nhost.run/v1
  • URL
    https://{subdomain}.auth.{region}.nhost.run/v1/signup/passwordless/sms
  • Auth
    none declared

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 already registered.

'OK' required

Changes