Skip to main content
POST
Start SMS Enrollment

Authorizations

Authorization
string
header
required

Use a short-lived token obtained from the Server API's Track Action endpoint. The token is valid for 10 minutes and should be passed in the Authorization header as 'Bearer {token}'.

Body

application/json
phoneNumber
string
required

The user’s phone number in E.164 format.

smsChannel
enum<string>
Available options:
DEFAULT,
WHATSAPP

Response

OK

userAuthenticatorId
string

The ID of the SMS authenticator which has been created but not yet verified.

userId
string
retryAfterSeconds
number

The number of seconds the client should wait before retrying the challenge. Only present if a rate limit threshold has been reached.

Example:

5