• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# User Authentication Error Codes
2
3<!--Kit: User Authentication Kit-->
4<!--Subsystem: UserIAM-->
5<!--Owner: @WALL_EYE-->
6<!--SE: @lichangting518-->
7<!--TSE: @jane_lz-->
8
9> **NOTE**
10>
11> This topic describes only module-specific error codes. For details about universal error codes, see [Universal Error Codes](../errorcode-universal.md).
12
13## 12500001 Authentication Failed
14
15**Error Message**
16
17Authentication failed.
18
19**Possible Causes**
20
21The credential does not match the credential enrolled.
22
23**Solution**
24
25Initiate authentication again.
26
27## 12500002 General Operation Error
28
29**Error Message**
30
31General operation error.
32
33**Possible Causes**
34
351. An error occurs when the NAPI layer parses parameters.
362. The process of the user authentication service is not started.
373. The proxy client fails to write data over IPC.
384. The stub server fails to parse data over IPC.
395. The driver service is not obtained.
40
41**Solution**
42
43Call the API again later or restart the device.
44
45## 12500003 Authentication Canceled
46
47**Error Message**
48
49Authentication canceled.
50
51**Possible Causes**
52
53The authentication operation has been canceled.
54
55**Solution**
56
57Initiate authentication again.
58
59## 12500004 Authentication Timed Out
60
61**Error Message**
62
63Authentication timeout.
64
65**Possible Causes**
66
67The authentication is not complete within the specified time.
68
69**Solution**
70
71Initiate authentication again.
72
73## 12500005 Unsupported Authentication Type
74
75**Error Message**
76
77The authentication type is not supported.
78
79**Possible Causes**
80
811. The input authentication type parameter is not supported. For example, if the authentication type passed in **getAvailableStatus** of the **userAuth** module is not **FACE** or **FINGERPRINT**, error code 12500005 is returned.
822. The device does not support the authentication type. For example, if fingerprint authentication is initiated on a device that has no fingerprint sensor, error code 12500005 is returned.
83
84**Solution**
85
86Check the authentication type parameter and call the API again.
87
88## 12500006 Unsupported Authentication Trust Level
89
90**Error Message**
91
92The authentication trust level is not supported.
93
94**Possible Causes**
95
961. The **authTrustLevel** value in **getAvailableStatus** or **getAuthInstance** of the **userAuth** module is not in the range [ATL1, ATL2, ATL3, ATL4].
972. The device does not support the authentication trust level. For example, if facial authentication for payment is initiated on a device that has only 2D cameras, error code 12500006 is returned.
98
99**Solution**
100
101Check that the **authTrustLevel** passed in is within the value range, and the device supports the specified authentication trust level.
102
103## 12500007 Authentication Service Unavailable
104
105**Error Message**
106
107Authentication service is busy.
108
109**Possible Causes**
110
111Another authentication is initiated when the current authentication has not been finished yet.
112
113**Solution**
114
115Initiate authentication again later.
116
117## 12500008 Parameter Verification Failed
118
119**Error Message**
120
121The parameter is out of range.
122
123**Description**
124
125Parameter verification failed.
126
127**Possible Causes**
128
129Parameter error.
130
131**Solution**
132
133Check the API parameters and initiate the request again.
134
135## 12500009 Authentication Locked
136
137**Error Message**
138
139Authentication is locked out.
140
141**Possible Causes**
142
143The number of authentication failures exceeds the limit.
144
145**Solution**
146
147Initiate authentication later.
148
149## 12500010 Credential Not Enrolled
150
151**Error Message**
152
153The type of credential has not been enrolled.
154
155**Possible Causes**
156
157The **authType** parameter set in **getAvailableStatus** of the **userAuth** module is **FACE**, but no facial credential is enrolled in the device. **start()** is called to initiate facial authentication, but no facial credential is enrolled in the device.
158
159**Solution**
160
161Check that the related type of credential has been enrolled in the device.
162
163## 12500011 Switched to Custom Authentication
164
165**Error Message**
166
167Switched to the custom authentication process.
168
169**Possible Causes**
170
171The authentication is canceled by the user, who tapped the authentication widget button to apply custom authentication.
172
173**Solution**
174
175Initiate authentication again.
176
177## 12500013 Password Expired
178
179**Error Message**
180
181Operation failed because of PIN expired.
182
183**Possible Causes**
184
185The authentication fails because the system lock screen password has expired. The error code 12500013 is returned if the lock screen password has expired when a PIN, fingerprint, or facial authentication is initiated.
186
187**Solution**
188
189Initiate an authentication again after the user sets a new lock screen password.
190
191<!--Del-->
192## 12500015 AuthToken Integrity Check Failed
193
194**Error Message**
195
196Operation failed because of authToken integrity check failed.
197
198**Possible Causes**
199
200The authentication token is invalid.
201
202**Solution**
203
204Initiate authentication again and issue a valid token.
205
206## 12500016 AuthToken Has Expired
207
208**Error Message**
209
210Operation failed because of authToken has expired.
211
212**Possible Causes**
213
214The authentication token has expired. The interval between the time when the AuthToken is issued and the time when the verification is initiated exceeds the AuthToken validity period passed in.
215
216**Solution**
217
218Initiate authentication again and issue a valid token.
219
220## 12500017 Authentication Result Reuse Failed
221
222**Error Message**
223
224Failed to reuse authtication result.
225
226**Description**
227
228Failed to reuse the identity authentication result.
229
230**Possible Causes**
231
2321. The authentication type does not match the specified type.
2332. The authentication result has expired (the maximum reuse duration is 5 minutes).
234
235**Solution**
236
237Initiate an authentication request to obtain a valid authentication token with the use's manual authentication.
238
239## 12700001 Facial Authentication Service Unavailable
240
241**Error Message**
242
243The service is unavailable.
244
245**Possible Causes**
246
2471. The facial authentication service is not started when **setSurfaceId()** of the **faceAuth** module is called.
2482. The proxy client fails to write data over IPC.
2493. The stub server fails to parse data over IPC.
2504. An error occurs when the facial authentication driver is invoked.
251
252**Solution**
253
254Call the API again later or restart the device.
255<!--DelEnd-->
256