@digitalpersona/authentication
Version:
DigitalPersona Authentication API
28 lines (17 loc) • 1.14 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@digitalpersona/authentication](./authentication.md) > [SmsOtpAuth](./authentication.smsotpauth.md)
## SmsOtpAuth class
A one-time password authentication API based on a Short Message Service (SMS OTP). SMS OTP supports only authentication. Identification is not supported.
<b>Signature:</b>
```typescript
export declare class SmsOtpAuth extends Authenticator
```
## Constructors
| Constructor | Modifiers | Description |
| --- | --- | --- |
| [(constructor)(authService)](./authentication.smsotpauth.(constructor).md) | | Constructs a new SMS OTP authentication API object. |
## Methods
| Method | Modifiers | Description |
| --- | --- | --- |
| [authenticate(identity, code)](./authentication.smsotpauth.authenticate.md) | | Authenticates the user using a challenge sent to the user's registered mobile device via SMS. |
| [sendChallenge(user)](./authentication.smsotpauth.sendchallenge.md) | | Sends an SMS challenge with a OTP code to the user's registered mobile device. |