Start SMS Enrollment

POST

user-authenticators

sms

curl --request POST \
  --url https://api.authsignal.com/v1/client/user-authenticators/sms \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phoneNumber": "<string>"
}
'

{
  "userAuthenticatorId": "<string>",
  "userId": "<string>"
}

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

userAuthenticatorId

string

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

userId

string

Start SMS ChallengeStart a challenge when the user is already enrolled with at least one SMS authenticator.

⌘I

Start SMS Enrollment

curl --request POST \
  --url https://api.authsignal.com/v1/client/user-authenticators/sms \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phoneNumber": "<string>"
}
'

{
  "userAuthenticatorId": "<string>",
  "userId": "<string>"
}