@digitalpersona/enrollment
Version:
DigitalPersona Enrollment API
29 lines (17 loc) • 1 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@digitalpersona/enrollment](./enrollment.md) > [TimeOtpEnroll](./enrollment.timeotpenroll.md) > [enrollSoftwareOtp](./enrollment.timeotpenroll.enrollsoftwareotp.md)
## TimeOtpEnroll.enrollSoftwareOtp() method
Enrolls One-Time Password using a software TOTP (e.g. DigitalPersona app, Google Authenticator etc.)
<b>Signature:</b>
```typescript
enrollSoftwareOtp(code: string, key: Uint8Array, phoneNumber?: string): Promise<void>;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| code | <code>string</code> | a verification code entered by a user. |
| key | <code>Uint8Array</code> | a secret key used to "seed" an OTP generator. |
| phoneNumber | <code>string</code> | a phone number the verification code was sent to |
<b>Returns:</b>
`Promise<void>`
a promise to perform the enrollment or reject in case of an error.