Skip to main content
POST
/
auth
/
sms
/
start
Start SMS login
curl --request POST \
  --url https://apiv2.example.com/auth/sms/start \
  --header 'Content-Type: application/json' \
  --data '
{
  "msisdn": "+15551234567"
}
'
{
  "nonce": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "expiresIn": 300,
  "createdAt": "2023-11-07T05:31:56Z",
  "expiresAt": "2023-11-07T05:31:56Z"
}

Body

application/json

Request to initiate an SMS-based login flow. A verification code will be sent to the provided phone number.

​
msisdn
string<phone>
required

The phone number to send the verification code to.

Example:

"+15551234567"

Response

Login flow initiated. A verification code has been sent to the phone number if it matches an account.

Response from initiating an email login. Contains the nonce needed for verification and timing information.

​
nonce
string
required

Token to reference this authentication request during verification.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

​
expiresIn
integer
required

Number of seconds until the verification code expires.

Example:

300

​
createdAt
string<date-time>
required

When the authentication request was created.

​
expiresAt
string<date-time>
required

When the verification code will expire.