Login or Create via SMS

import { useCallback } from 'react';
import { useStytch } from '@stytch/react';
export const Login = () => {
const stytch = useStytch();
const sendPasscode = useCallback(() => {
  stytch.otps.sms.loginOrCreate('${examplePhoneNumber}', {
    expiration_minutes: 5,
  });
}, [stytch]);
return <button onClick={sendPasscode}>Send passcode</button>;
};

{
  "status_code": 200,
  "request_id": "request-id-test-b05c992f-ebdc-489d-a754-c7e70ba13141",
  "method_id": "phone-number-test-d5a3b680-e8a3-40c0-b815-ab79986666d0"
}

import { useCallback } from 'react';
import { useStytch } from '@stytch/react';
export const Login = () => {
const stytch = useStytch();
const sendPasscode = useCallback(() => {
  stytch.otps.sms.loginOrCreate('${examplePhoneNumber}', {
    expiration_minutes: 5,
  });
}, [stytch]);
return <button onClick={sendPasscode}>Send passcode</button>;
};

{
  "status_code": 200,
  "request_id": "request-id-test-b05c992f-ebdc-489d-a754-c7e70ba13141",
  "method_id": "phone-number-test-d5a3b680-e8a3-40c0-b815-ab79986666d0"
}

import { useCallback } from 'react';
import { useStytch } from '@stytch/react';
export const Login = () => {
const stytch = useStytch();
const sendPasscode = useCallback(() => {
  stytch.otps.sms.loginOrCreate('${examplePhoneNumber}', {
    expiration_minutes: 5,
  });
}, [stytch]);
return <button onClick={sendPasscode}>Send passcode</button>;
};

{
  "status_code": 200,
  "request_id": "request-id-test-b05c992f-ebdc-489d-a754-c7e70ba13141",
  "method_id": "phone-number-test-d5a3b680-e8a3-40c0-b815-ab79986666d0"
}

Wraps the login_or_create via SMS API endpoint. Call this method to send an SMS passcode to new or existing users.

Before configuring SMS or WhatsApp OTPs, please review how Stytch bills the costs of international OTPs and understand how to protect your app against toll fraud.

Parameters

phone_number

string

required

The phone number to use for one-time passcodes. The phone number should be in E.164 format (i.e. +1XXXXXXXXXX). You may use +10000000000 to test this endpoint, see Sandbox Values for more detail.

Configuration

object

Additional configuration.

Show properties

expiration_minutes

int

Set the expiration for the one-time passcode, in minutes. The minimum expiration is 1 minute and the maximum is 10 minutes. The default expiration is 2 minutes.

locale

string

Used to determine which language to use when sending the user this delivery method. Parameter is an IETF BCP 47 language tag, e.g. “en”. Supported languages are English (“en”), Spanish (“es”), French (“fr”) and Brazilian Portuguese (“pt-br”); if no value is provided, the copy defaults to English.

enable_autofill

boolean

Whether or not to append autofill metadata to SMS OTP messages

autofill_session_duration_minutes

number

The intended session duration for an autofilled SMS authenticate request

Response

method_id

string

The email_id or phone_id involved in the given authentication.

request_id

string

Globally unique UUID that is returned with every API call. This value is important to log for debugging purposes; we may ask for this value to help identify a specific API call when helping you debug an issue.

status_code

number

The HTTP status code of the response. Stytch follows standard HTTP response status code patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX are server errors.

⌘I

​Parameters

​Response

Parameters

Response