@getyoti/react-face-capture 2.7.0 → 2.8.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +36 -0
- package/LICENCE.md +214 -62
- package/README.md +24 -23
- package/index.d.ts +9 -2
- package/index.js +7 -7
- package/index.js.LICENSE.txt +48 -37
- package/package.json +1 -2
- package/vanilla/index.js +10 -10
- package/vanilla/index.js.LICENSE.txt +217 -65
- package/vanilla/index.js.map +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,41 @@
|
|
|
1
1
|
# CHANGELOG
|
|
2
2
|
|
|
3
|
+
## v2.8.1
|
|
4
|
+
|
|
5
|
+
### New features
|
|
6
|
+
|
|
7
|
+
- Add new localisation:
|
|
8
|
+
|
|
9
|
+
- `ta-SG`: Tamil (Singapore)
|
|
10
|
+
- `zh-SG`: Chinese (Singapore)
|
|
11
|
+
|
|
12
|
+
- Update UI component library to enhance theming stability.
|
|
13
|
+
- Improve usability for keyboard only users.
|
|
14
|
+
- Improve screen readers compatibility.
|
|
15
|
+
|
|
16
|
+
### Fixes
|
|
17
|
+
|
|
18
|
+
- Fix visual bug when taking a picture in manual mode. The feedback prompt is now highlighted correctly.
|
|
19
|
+
|
|
20
|
+
## v2.8.0
|
|
21
|
+
|
|
22
|
+
### New features
|
|
23
|
+
|
|
24
|
+
- Axios has been removed and now fetch is used across the app.
|
|
25
|
+
- Improve user guidance in `center` mode.
|
|
26
|
+
- Extra on-screen feedback is displayed if the user has not placed their face in the frame after a certain amount of time.
|
|
27
|
+
- Add new localisation:
|
|
28
|
+
- `ka-GE`: Georgian
|
|
29
|
+
- `sr-RS`: Serbian (Cyrillic script)
|
|
30
|
+
- `sr-Latn-RS`: Serbian (Latin script)
|
|
31
|
+
- Localisation has been revised. The following languages have been updated:
|
|
32
|
+
- `el-GR`: Greek
|
|
33
|
+
- `bs-BA`: Bosnian
|
|
34
|
+
- Improve user feedback stability.
|
|
35
|
+
- Improve documentation:
|
|
36
|
+
- `returnPreviewImage` property. Highlighting that the preview image is not signed and should only be used for user feedback.
|
|
37
|
+
- `EXCEEDED_TIME_TO_LOAD` error. Making it more straightforward.
|
|
38
|
+
|
|
3
39
|
## v2.7.0
|
|
4
40
|
|
|
5
41
|
### New features
|
package/LICENCE.md
CHANGED
|
@@ -1,66 +1,218 @@
|
|
|
1
1
|
# YOTI FACE CAPTURE MODULE SDK TERMS
|
|
2
2
|
|
|
3
|
-
By downloading or using the Yoti Face Module Capture SDK, you are
|
|
3
|
+
By downloading or using the Yoti Face Module Capture SDK, you are
|
|
4
|
+
agreeing to this licence ("**Terms**") which is a legal agreement
|
|
5
|
+
between us and either (a) you,if you are an individual not working for
|
|
6
|
+
an entity; or (b) the entity that either employs or has contracted with
|
|
7
|
+
you in respect of your use of the SDK (the "**User**"). If you
|
|
8
|
+
(_the User_) do not agree with these Terms, you should not use the SDK.
|
|
4
9
|
|
|
5
|
-
We are Yoti Limited (the
|
|
10
|
+
We are Yoti Limited (the "**Provider**") a company registered in
|
|
11
|
+
England and Wales, with company number _08998951_ and registered office
|
|
12
|
+
at _6th Floor, 107 Leadenhall Street, London, EC3A 4AF_. You can
|
|
13
|
+
contact us by writing to us at: <hello@yoti.com>, or at our registered
|
|
14
|
+
office.
|
|
6
15
|
|
|
7
|
-
1.
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
User
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
16
|
+
1. **Interpretation**
|
|
17
|
+
1. **Definitions:**
|
|
18
|
+
- **Affiliate:** has the meaning given in the Yoti Org T&Cs.
|
|
19
|
+
- **Business Day:** a day other than a Saturday, Sunday or
|
|
20
|
+
public holiday in England.
|
|
21
|
+
- **Hub:** has the meaning given in the Yoti Org T&Cs.
|
|
22
|
+
- **Intellectual Property Rights:** has the meaning given in
|
|
23
|
+
clause 14.1 of the Yoti Org T&Cs.
|
|
24
|
+
- **Maintenance Release:** release of the SDK that corrects
|
|
25
|
+
faults, adds functionality or otherwise amends or upgrades
|
|
26
|
+
the SDK.
|
|
27
|
+
- **the SDK:** the source or object code that forms the Yoti
|
|
28
|
+
Face Module Capture SDK made available to the User by the
|
|
29
|
+
Provider.
|
|
30
|
+
- **Yoti Age:** has the meaning given in the Yoti Org T&Cs.
|
|
31
|
+
- **Yoti Auth:** has the meaning given in the Yoti Org T&Cs.
|
|
32
|
+
- **Yoti Org T&Cs:** means the terms of use of the Yoti
|
|
33
|
+
Platform available at
|
|
34
|
+
<https://www.yoti.com/terms/organisations/>
|
|
35
|
+
- **Yoti Platform:** has the meaning given in the Yoti Org
|
|
36
|
+
T&Cs.
|
|
37
|
+
2. Any phrase introduced by the terms **including, include, in
|
|
38
|
+
particular** shall be interpreted as if the words "without
|
|
39
|
+
limitation" followed them.
|
|
40
|
+
2. **Basis of contract**
|
|
41
|
+
1. These Terms apply to the exclusion of any other terms that the
|
|
42
|
+
User seeks to impose or incorporate, or which are implied by
|
|
43
|
+
trade, custom, practice or course of dealing.
|
|
44
|
+
3. **Licence**
|
|
45
|
+
1. The Provider hereby grants to the User a non-exclusive,
|
|
46
|
+
royalty-free revocable, worldwide licence to use the SDK for the
|
|
47
|
+
duration of these Terms and strictly in accordance with the use
|
|
48
|
+
permitted in these Terms. The sole permitted use of the SDK to
|
|
49
|
+
capture user face images strictly as necessary in order to use
|
|
50
|
+
the Yoti Age or Yoti Auth solutions embedded in your own websites
|
|
51
|
+
or applications. It is a condition of these Terms that you have
|
|
52
|
+
accepted and agreed to the Yoti Org T&Cs (either on the Hub or
|
|
53
|
+
in a separate contract with Yoti) for use of the Yoti Age or
|
|
54
|
+
Yoti Auth solutions. The User may grant access to the SDK to its
|
|
55
|
+
employees or contractors under the direct control of the User
|
|
56
|
+
("**User Personnel**"), as required for the purpose provided that
|
|
57
|
+
the User:
|
|
58
|
+
- (a) procures that User Personnel are made aware of and adhere
|
|
59
|
+
to these Terms;
|
|
60
|
+
- (b) is liable to the Provider for the acts or omissions of
|
|
61
|
+
User Personnel; and
|
|
62
|
+
- (c) shall cease to make the SDK available to any User Personnel
|
|
63
|
+
on that party ceasing to be employed or engaged by the User.
|
|
64
|
+
2. The User shall:
|
|
65
|
+
- (a) not sell, sub-license, assign, hold on trust or novate the
|
|
66
|
+
benefit or burden of these Terms in whole or in part;
|
|
67
|
+
- (b) not allow the SDK to become the subject of any charge, lien
|
|
68
|
+
or encumbrance; and
|
|
69
|
+
- (c) do its best to prevent unauthorised copying of the SDK.
|
|
70
|
+
4. **Maintenance Releases**
|
|
71
|
+
1. The Provider will make available to the User all Maintenance
|
|
72
|
+
Releases generally made available to its customers. Under these
|
|
73
|
+
Terms the Provider offers no support function for the SDK but the
|
|
74
|
+
User is encouraged to report any issues with the SDK by writing
|
|
75
|
+
to us at <sdksupport@yoti.com>. Any comments, suggestions for
|
|
76
|
+
enhancements or modifications ("Feedback") relating to the SDK or
|
|
77
|
+
associated materials is provided on a non-confidential basis and
|
|
78
|
+
the Provider may use the Feedback at its discretion and for any
|
|
79
|
+
purpose, including to improve the Provider's products or
|
|
80
|
+
services.
|
|
81
|
+
5. **User's Obligations**
|
|
82
|
+
1. The User represents, warrants and undertakes that it will use
|
|
83
|
+
the SDK in compliance with all applicable laws and shall not:
|
|
84
|
+
(a) resell, sublicense, lease or otherwise make the SDK available
|
|
85
|
+
to any third party; (b) gain unauthorised access to, or disrupt
|
|
86
|
+
the integrity or performance of the SDK; (c) except under clause
|
|
87
|
+
5.2 below, modify, alter, amend, copy, translate or create
|
|
88
|
+
derivative works based on the SDK or attempt to discover the
|
|
89
|
+
source code or underlying ideas or algorithms thereof; (d) reverse
|
|
90
|
+
engineer, decompile or disassemble the SDK; (e) use the SDK to
|
|
91
|
+
build a competitive product or service to the Yoti Platform or
|
|
92
|
+
copy its features or user interface; (f) use the SDK to do
|
|
93
|
+
product evaluation or benchmarking intended for publication;
|
|
94
|
+
(g) use the SDK in any manner to improve, train or feed results
|
|
95
|
+
into a machine learning tool; (h) use the face images captured by
|
|
96
|
+
the SDK for any purpose whatsoever other than to make use of the
|
|
97
|
+
Yoti Age or Yoti Auth solutions; (i) act or omit to act in any
|
|
98
|
+
way that damages the Provider's business or reputation; and
|
|
99
|
+
(j) use the Provider's logos except to use the SDK in good faith
|
|
100
|
+
and in accordance with the Provider's branding guidelines.
|
|
101
|
+
2. If local law allows you to decompile the SDK to make the SDK
|
|
102
|
+
interoperable with other software, you shall first ask us in
|
|
103
|
+
writing to provide you with the information.
|
|
104
|
+
6. **Intellectual Property Rights**
|
|
105
|
+
1. The User acknowledges that all Intellectual Property Rights in
|
|
106
|
+
the SDK shall be owned by the Provider, and neither the User nor
|
|
107
|
+
any of its Affiliates have any rights other than to use the SDK
|
|
108
|
+
in accordance with these Terms. If the User breaches clause 5
|
|
109
|
+
then in consideration for the licence in these Terms it hereby
|
|
110
|
+
assigns (including a present assignment of future copyright) on
|
|
111
|
+
creation to the Provider with full title guarantee all
|
|
112
|
+
Intellectual Property Rights arising from any modifications,
|
|
113
|
+
amendments or improvements to the SDK. The User shall execute
|
|
114
|
+
promptly any document or do any act at its own cost required by
|
|
115
|
+
the Provider to complete or formalise this assignment.
|
|
116
|
+
2. The User agrees that it will not, and will procure that its
|
|
117
|
+
Affiliates will not, do anything which could infringe the
|
|
118
|
+
Intellectual Property Rights of the Provider. Any and all rights
|
|
119
|
+
not expressly granted under these Terms shall be reserved by the
|
|
120
|
+
Provider. The User shall ensure that no copyright notices are
|
|
121
|
+
removed from the SDK and that any copies of the SDK shall
|
|
122
|
+
replicate the copyright notices.
|
|
123
|
+
7. **Limitation and Exclusions of Liability**
|
|
124
|
+
**THE USER'S ATTENTION IS PARTICULARLY DRAWN TO THIS CLAUSE**
|
|
125
|
+
1. The Provider licenses the SDK to the User on an "as is" basis.
|
|
126
|
+
Except as expressly provided herein, the Provider hereby
|
|
127
|
+
disclaims any and all representations, warranties, conditions or
|
|
128
|
+
terms of any kind, whether implied, statutory or otherwise, to
|
|
129
|
+
the fullest extent permitted by law, including but not limited to
|
|
130
|
+
that the SDK is suitable for a particular purpose or is of
|
|
131
|
+
satisfactory quality. The Provider does not warrant that the use
|
|
132
|
+
of the SDK will be uninterrupted or error-free.
|
|
133
|
+
2. Nothing in these Terms shall limit or exclude either party's
|
|
134
|
+
liability for: (a) death or personal injury caused by its
|
|
135
|
+
negligence; (b) fraud or fraudulent misrepresentation; or (c) any
|
|
136
|
+
liability which cannot be limited or excluded by applicable law.
|
|
137
|
+
3. Subject to clause _ii_, the Provider shall not be liable to the
|
|
138
|
+
User, whether in contract, tort (including negligence) or for
|
|
139
|
+
breach of statutory duty arising under or in connection with
|
|
140
|
+
these Terms for any loss of profit, revenue or data or any
|
|
141
|
+
indirect, consequential or incidental loss.
|
|
142
|
+
4. Subject to clause _ii_ the maximum aggregate liability of the
|
|
143
|
+
Provider to the User (including for all User's Affiliates or
|
|
144
|
+
User's Personnel), whether in contract, tort (including
|
|
145
|
+
negligence) or for breach of statutory duty shall be capped at
|
|
146
|
+
£100.
|
|
147
|
+
5. The User shall indemnify on demand and hold harmless the Provider
|
|
148
|
+
and its directors, employees and shareholders from and against
|
|
149
|
+
any and all losses, claims, damages, costs, expenses (including
|
|
150
|
+
reasonable legal costs and expenses) and liabilities suffered or
|
|
151
|
+
incurred, directly or indirectly, as a result of or in connection
|
|
152
|
+
with a breach of these Terms by the User, the User's Affiliates
|
|
153
|
+
or the User's Personnel.
|
|
154
|
+
8. **Term and Termination**
|
|
155
|
+
1. These Terms will commence when User accepts these Terms and
|
|
156
|
+
continue until terminated in accordance with these Terms. Either
|
|
157
|
+
party may terminate these Terms at any time without cause by
|
|
158
|
+
giving the other party no less than 5 Business Days' written
|
|
159
|
+
notice, and the Provider may terminate immediately if: (a) the
|
|
160
|
+
User is in breach of these Terms; (b) becomes a competitor of the
|
|
161
|
+
Provider in the Provider's reasonable opinion; or (c) the Yoti
|
|
162
|
+
Org T&Cs are terminated for any reason by either party.
|
|
163
|
+
2. Any provision of these Terms that is intended to continue in
|
|
164
|
+
force after termination shall remain in full force and effect,
|
|
165
|
+
including without limitation clauses 5, 6, 7, 8 and 9.
|
|
166
|
+
3. Termination of these Terms shall not affect any rights of the
|
|
167
|
+
parties that have accrued up to the date of termination. On
|
|
168
|
+
termination of these Terms for any reason, the User shall
|
|
169
|
+
immediately cease to use the SDK, and shall procure that any of
|
|
170
|
+
its Affiliates and the User Personnel shall cease to use the SDK,
|
|
171
|
+
and shall permanently delete all copies of the SDK then in its
|
|
172
|
+
possession, custody or control.
|
|
173
|
+
9. **General**
|
|
174
|
+
1. No failure or delay by a party to exercise any right or remedy
|
|
175
|
+
provided under the Terms or by law shall constitute a waiver of
|
|
176
|
+
that or any other right or remedy.
|
|
177
|
+
2. These Terms and the Yoti Org T&Cs contain the entire agreement
|
|
178
|
+
between the parties relating to the SDK and supersede all prior
|
|
179
|
+
agreements between the parties relating to the SDK. Each party
|
|
180
|
+
acknowledges that, in entering into these Terms, it does not rely
|
|
181
|
+
on any representation or warranty (whether it was made negligently
|
|
182
|
+
or innocently) of any person. Nothing excludes liability for
|
|
183
|
+
fraud.
|
|
184
|
+
3. If any provision or part-provision of these Terms is or becomes
|
|
185
|
+
invalid, illegal or unenforceable, it shall be deemed modified to
|
|
186
|
+
the minimum extent necessary to make it valid, legal and
|
|
187
|
+
enforceable. If such modification is not possible, the relevant
|
|
188
|
+
provision or part-provision shall be deemed deleted.
|
|
189
|
+
4. A person who is not a party to these Terms shall not have any
|
|
190
|
+
rights under the Contracts (Rights of Third Parties) Act 1999 to
|
|
191
|
+
enforce any term of these Terms.
|
|
192
|
+
5. Neither party shall be in breach of these Terms nor liable for
|
|
193
|
+
delay in performing, or failure to perform, any of its obligations
|
|
194
|
+
under these Terms if such delay or failure results from events,
|
|
195
|
+
circumstances or causes beyond its reasonable control, and the
|
|
196
|
+
affected party shall be entitled to a reasonable extension of the
|
|
197
|
+
time for performing such obligations.
|
|
198
|
+
6. Any notice or other communication given to a party under or in
|
|
199
|
+
connection with these Terms may be by email or post to the address
|
|
200
|
+
provided.
|
|
201
|
+
7. The Provider may at any time assign, transfer, mortgage, charge,
|
|
202
|
+
subcontract or deal in any other manner with all or any of its
|
|
203
|
+
rights under these Terms and may subcontract or delegate in any
|
|
204
|
+
manner any or all of its obligations under these Terms to any
|
|
205
|
+
third party. The User shall not, without the prior written consent
|
|
206
|
+
of the Provider, assign, transfer, mortgage, charge, subcontract,
|
|
207
|
+
declare a trust over or deal in any other manner with any or all
|
|
208
|
+
of its rights or obligations under these Terms, other than as set
|
|
209
|
+
out herein.
|
|
210
|
+
8. The User agrees that the Provider may, at the reasonable request
|
|
211
|
+
of the Provider, inspect and have access to such of the User's
|
|
212
|
+
personnel, facilities and books and records, for the purposes of
|
|
213
|
+
ensuring that the User is complying with these Terms.
|
|
214
|
+
9. These Terms shall be governed by the laws of England. The parties
|
|
215
|
+
irrevocably agree that the courts of England and Wales shall have
|
|
216
|
+
exclusive jurisdiction to settle any dispute or claim that arises
|
|
217
|
+
out of or in connection with these Terms or its subject matter or
|
|
218
|
+
formation (including non-contractual disputes or claims).
|
package/README.md
CHANGED
|
@@ -24,12 +24,12 @@ The package depends on the following peer dependencies
|
|
|
24
24
|
|
|
25
25
|
| Browser | Versions |
|
|
26
26
|
| ------- | ------------------- |
|
|
27
|
-
| and_chr |
|
|
28
|
-
| chrome |
|
|
29
|
-
| edge |
|
|
30
|
-
| firefox |
|
|
31
|
-
| ios_saf |
|
|
32
|
-
| safari |
|
|
27
|
+
| and_chr | 145 |
|
|
28
|
+
| chrome | 145,144,143,142 |
|
|
29
|
+
| edge | 145,144 |
|
|
30
|
+
| firefox | 147,146,145,144 |
|
|
31
|
+
| ios_saf | 26.3,26.2,26.1 |
|
|
32
|
+
| safari | 26.3,26.2,26.1,26.0 |
|
|
33
33
|
|
|
34
34
|
</browserSupportTable>
|
|
35
35
|
|
|
@@ -141,7 +141,7 @@ The CSS custom properties must be defined using the `:root` CSS selector. Here i
|
|
|
141
141
|
| showGetHelpButton | Boolean | `true` | - | Show the Get Help button. |
|
|
142
142
|
| autoSessionReload | Boolean | `true` | - | Automatically renews sessions after they expire. |
|
|
143
143
|
| userRetryError | Boolean | `true` | - | Gives the possibility to users to retry several times when an error occurs. |
|
|
144
|
-
| returnPreviewImage | Boolean | `false` | - | Provide the image captured (`base64PreviewImage`) in the `onSuccess` callback.
|
|
144
|
+
| returnPreviewImage | Boolean | `false` | - | Provide the image captured (`base64PreviewImage`) in the `onSuccess` callback. Please note that the preview image is not signed, so it should only be used for user feedback. For applications that need to store or use the actual image, we recommend setting `encryptImage` to false. |
|
|
145
145
|
| encryptImage | Boolean | `true` | - | Encrypt the image inside the payload argument on the `onSuccess` callback when it runs the secure mode. |
|
|
146
146
|
| allowBackgroundFaces | Boolean | `false` | - | Allows faces to be present in the background when the image is being captured. The Face Capture will return a cropped image with the main face when set to `true`. If `multiframe` is `true`, this field will be ignored and treated as `false`. Note: This feature is designed for retail terminals and is unsuitable for online users' face capture. |
|
|
147
147
|
| faceSelectionMethod | String `center/area` | `center` | - | Defines where the main face can be placed, in the center or anywhere in the image. Note: This feature is designed for retail terminals and unsuitable for online user's face capture. It is recommend to enable `allowBackgroundFaces` when `faceSelectionMethod` is set to `area`. |
|
|
@@ -193,7 +193,8 @@ Current languages supported:
|
|
|
193
193
|
- `ro-RO`: Romanian
|
|
194
194
|
- `ru-RU`: Russian
|
|
195
195
|
- `sk-SK`: Slovak
|
|
196
|
-
- `sr-RS`: Serbian (
|
|
196
|
+
- `sr-RS`: Serbian (Cyrillic script)
|
|
197
|
+
- `sr-Latn-RS`: Serbian (Latin script)
|
|
197
198
|
- `sv-SE`: Swedish
|
|
198
199
|
- `th-TH`: Thai
|
|
199
200
|
- `tl-PH`: Tagalog
|
|
@@ -216,21 +217,21 @@ A mechanism used for the property `language` to avoid issues when the value pass
|
|
|
216
217
|
|
|
217
218
|
#### Error codes
|
|
218
219
|
|
|
219
|
-
| Error code | Description
|
|
220
|
-
| ------------------------------ |
|
|
221
|
-
| `NO_CAMERA` | No camera detected on the user’s device.
|
|
222
|
-
| `GENERIC_CAMERA_ERROR` | Undefined camera error. The reasons can be [various](https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia) and inconsistent across browsers.
|
|
223
|
-
| `UNSUPPORTED_BROWSER` | The user’s browser is not supported. This could be because the API needed for the camera interaction is missing. `Note: Older Non-Safari browsers on iOS fall into this category.`
|
|
224
|
-
| `NO_CAMERA_PERMISSION` | The user rejected the camera permission.
|
|
225
|
-
| `OVERCONSTRAINED` | The camera constraints are not compatible with available camera devices. `Note: One recovery option could be to use hd resolution.`
|
|
226
|
-
| `FACE_DETECTION_INIT_ERROR` | The face detection has failed to initialise. This usually means the required model assets are missing from the host application.
|
|
227
|
-
| `INTERNAL_ERROR` | This can be due to a programming error, or the user using an old unsupported browser.
|
|
228
|
-
| `CAPTURE_LOAD_ERROR` | The secure module could not be loaded. This usually means your token is not updated, or there is an error on the module provider.
|
|
229
|
-
| `VIDEO_STREAM_INTERRUPTED` | The camera stream has stopped unexpectedly.
|
|
230
|
-
| `SECURE_SESSION_EXPIRED` | The secure session has expired (the token expire field is older than the current time).
|
|
231
|
-
| `EXCEEDED_TIME_TO_LOAD` | The module is taking
|
|
232
|
-
| `VERSION_NO_LONGER_AVAILABLE` | The requested Face Capture secure module is no longer available. Note that the FCM will log a warning in the console if the module was deprecated.
|
|
233
|
-
| `INVALID_SECURE_CLIENT_SDK_ID` | The client SDK ID has a wrong format, it isn't included on the internal product mapping or there is a mismatch between the SDK from the JWT and the one related to the internal product contained in the BE request.
|
|
220
|
+
| Error code | Description |
|
|
221
|
+
| ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
222
|
+
| `NO_CAMERA` | No camera detected on the user’s device. |
|
|
223
|
+
| `GENERIC_CAMERA_ERROR` | Undefined camera error. The reasons can be [various](https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia) and inconsistent across browsers. |
|
|
224
|
+
| `UNSUPPORTED_BROWSER` | The user’s browser is not supported. This could be because the API needed for the camera interaction is missing. `Note: Older Non-Safari browsers on iOS fall into this category.` |
|
|
225
|
+
| `NO_CAMERA_PERMISSION` | The user rejected the camera permission. |
|
|
226
|
+
| `OVERCONSTRAINED` | The camera constraints are not compatible with available camera devices. `Note: One recovery option could be to use hd resolution.` |
|
|
227
|
+
| `FACE_DETECTION_INIT_ERROR` | The face detection has failed to initialise. This usually means the required model assets are missing from the host application. |
|
|
228
|
+
| `INTERNAL_ERROR` | This can be due to a programming error, or the user using an old unsupported browser. |
|
|
229
|
+
| `CAPTURE_LOAD_ERROR` | The secure module could not be loaded. This usually means your token is not updated, or there is an error on the module provider. |
|
|
230
|
+
| `VIDEO_STREAM_INTERRUPTED` | The camera stream has stopped unexpectedly. |
|
|
231
|
+
| `SECURE_SESSION_EXPIRED` | The secure session has expired (the token expire field is older than the current time). |
|
|
232
|
+
| `EXCEEDED_TIME_TO_LOAD` | The module is taking longer than the time set in the FaceCapture component to load. _This error does not prevent the module from continuing to load_. It alerts the integrator so they can decide to give additional reassurance to their users. The timeout value can be changed by updating the `loadTimeout` option, which defaults to 60 seconds (60000ms). |
|
|
233
|
+
| `VERSION_NO_LONGER_AVAILABLE` | The requested Face Capture secure module is no longer available. Note that the FCM will log a warning in the console if the module was deprecated. |
|
|
234
|
+
| `INVALID_SECURE_CLIENT_SDK_ID` | The client SDK ID has a wrong format, it isn't included on the internal product mapping or there is a mismatch between the SDK from the JWT and the one related to the internal product contained in the BE request. |
|
|
234
235
|
|
|
235
236
|
The error codes can be imported as follow:
|
|
236
237
|
|
package/index.d.ts
CHANGED
|
@@ -149,6 +149,8 @@ declare module '@getyoti/react-face-capture' {
|
|
|
149
149
|
IT_IT = 'it-IT',
|
|
150
150
|
JA = 'ja',
|
|
151
151
|
JA_JP = 'ja-JP',
|
|
152
|
+
KA = 'ka',
|
|
153
|
+
KA_GE = 'ka-GE',
|
|
152
154
|
KO = 'ko',
|
|
153
155
|
KO_KR = 'ko-KR',
|
|
154
156
|
LT = 'lt',
|
|
@@ -174,8 +176,12 @@ declare module '@getyoti/react-face-capture' {
|
|
|
174
176
|
SK_SK = 'sk-SK',
|
|
175
177
|
SR = 'sr',
|
|
176
178
|
SR_RS = 'sr-RS',
|
|
179
|
+
SR_LATN = 'sr-Latn',
|
|
180
|
+
SR_LATN_RS = 'sr-Latn-RS',
|
|
177
181
|
SV = 'sv',
|
|
178
182
|
SV_SE = 'sv-SE',
|
|
183
|
+
TA = 'ta',
|
|
184
|
+
TA_SG = 'ta-SG',
|
|
179
185
|
TH = 'th',
|
|
180
186
|
TH_TH = 'th-TH',
|
|
181
187
|
TL = 'tl',
|
|
@@ -190,6 +196,7 @@ declare module '@getyoti/react-face-capture' {
|
|
|
190
196
|
VI_VN = 'vi-VN',
|
|
191
197
|
ZH = 'zh',
|
|
192
198
|
ZH_CN = 'zh-CN',
|
|
199
|
+
ZH_SG = 'zh-SG',
|
|
193
200
|
}
|
|
194
201
|
|
|
195
202
|
/**
|
|
@@ -260,8 +267,8 @@ declare module '@getyoti/react-face-capture' {
|
|
|
260
267
|
/** The language code to set the language of the feedback messages. (default: en) */
|
|
261
268
|
language?: LANGUAGE_CODE;
|
|
262
269
|
/** Determines the politeness setting of the live region used to read out prompts for screen reader users. (default: polite)
|
|
263
|
-
|
|
264
|
-
|
|
270
|
+
* @deprecated will be remove in next major release
|
|
271
|
+
*/
|
|
265
272
|
a11yLiveRegionMode?: A11Y_LIVE_REGION_MODE;
|
|
266
273
|
/** Show the initial help guidance. (default: true) */
|
|
267
274
|
showInitialGuidance?: boolean;
|