SMS

Start SMS enrollment

POST https://api.authsignal.com/v1/client/user-authenticators/sms

Use this endpoint to start a challenge to enroll a new SMS authenticator for a given phone number.

Request

• phoneNumberstring

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

Response

• userAuthenticatorIdstring

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

Start SMS challenge

Use this endpoint to start a challenge when the user is already enrolled with at least one SMS authenticator.

POST https://api.authsignal.com/v1/client/challenge/sms

Request

• userAuthenticatorIdstring | undefined

  The ID of the SMS authenticator to use. Only required if the user has multiple SMS authenticators and you want to target a specific one.

Verify SMS challenge

POST https://api.authsignal.com/v1/client/verify/sms

Use this endpoint to verify a challenge when enrolling a new SMS authenticator or when re-authenticating with an existing SMS authenticator.

Request

• verificationCodestring

  The OTP code inputted by the user.

Response

• isVerifiedboolean

  True if the inputted OTP code matches the code which was sent.

• accessTokenstring | undefined

  A new short-term token with scopes to manage authenticators (e.g. add secondary authenticators, remove authenticators, view or regenerate recovery codes). Only present if the challenge succeeded.

• failureReasonstring | undefined

  One of the following values: CODE_INVALID_OR_EXPIRED, MAX_ATTEMPTS_EXCEEDED.