You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -100,7 +100,7 @@ export default App;
100
100
```
101
101
102
102
> ## `ENROLL()` - ENROLL NEW USER
103
-
103
+
104
104
> ### SYNTAX
105
105
106
106
```js
@@ -119,7 +119,7 @@ console.log(userInfo)
119
119
> ### PARAMETERS
120
120
`enroll()` takes a **single, optional `parameters` object** with the properties to be configured. The table below lists all possible `properties` of the parameters object:
|`userConsent`| Boolean | false |**If you have already collected user consent before enrollment** you can **set this parameter** to true. In which case, the Terms of Use consent screen is not displayed for the end user being enrolled. **It is your responsibility to explicitly ask for consent before enrolling a new user**. |
134
134
|`showAbortBtn`| Boolean | false |**Set to true if you want the abort button (close modal) to always appear during enrollment.** If the user explicitly aborts the enrollment process by clicking this button, the `fioErrCode.ABORTED_BY_USER` error will be raised. |
**A Promise whose fulfillment handler receives a `userData` object when the user has successfully been identified**. On failure, the promise is rejected with one of the possible **error codes**.
224
224
@@ -230,9 +230,9 @@ The table below lists all fields of the `userData` object returned to your web a
230
230
|`facialId`|*UUID (String)*|**The Universally Unique Identifier assigned to this particular user**. |
231
231
232
232
> ## `RESTARTSESSION()` - REQUEST NEW USER SESSION
The table below lists all possible error codes that are returned from either the `enroll()` or the `authenticate()` methods when **their promises are rejected respectively**.
248
248
249
249
|**Error Code**|**Description**|**Effect on `enroll()` or `authenticate()`**|
0 commit comments