User Authentication Error Codes-Error Codes-User Authentication Kit-Security-System

This topic describes error codes specific to the user authentication service. It helps you locate and handle authentication exceptions.

NOTE

This topic describes only module-specific error codes. For details about universal error codes, see Universal Error Codes.

12500001 Authentication Failed

Error Message

Authentication failed.

Description

The user authentication failed, indicating that the authentication credential provided by the user does not match the credential registered on the device. This is a common authentication result, indicating that the user entered incorrect information or used an unregistered credential.

Possible Causes

The password, face, or fingerprint entered by the user does not match the registered credential.
The user uses an unregistered credential for authentication.
The biometric feature collection quality is poor, resulting in a comparison failure (for example, insufficient light for face recognition or incomplete fingerprint pressing).

Solution

It is recommended that the user be prompted to try authentication again.
If the biometric authentication fails, you can prompt the user to adjust the operation (for example, improve the illumination or press the fingerprint sensor correctly).
If the authentication fails for multiple times, prompt the user to check whether the corresponding credential has been registered or switch to another authentication mode.
Record the number of failures. When the number reaches the threshold, prompt the user that the lock mechanism may be triggered.

12500002 Common Error Code of the Identity Authentication System

Error Message

General operation error.

Description

An unrecoverable internal error occurred in the authentication system. This is a common error code, indicating that the system is abnormal and you cannot rectify the fault by adjusting parameters or operations.

Possible Causes

An error occurred when the NAPI layer parsed parameters. An exception occurred during parameter transfer.
The process of the user authentication service is not started or is terminated unexpectedly.
The proxy client of the IPC fails to write data, and the data transfer is abnormal.
The stub server of the IPC fails to parse data, and the data receiving is abnormal.
The driver service fails to be obtained, and the underlying driver service is unavailable.
The system resources are insufficient, and the memory allocation fails.

Solution

The internal system service is abnormal. You are advised to call the API again.
If the failure persists after multiple retries, you are advised to restart the device.

12500003 Authentication Canceled

Error Message

Authentication canceled.

Description

The authentication operation is canceled, indicating that the user proactively or passively terminates the authentication process.

Possible Causes

The user taps the cancel button or back button to proactively cancel the authentication.
The application calls the cancel API to proactively cancel the authentication.
The subsequent authentication request is preferentially completed, causing the previous authentication request to be forcibly canceled.

Solution

Determine whether to initiate the authentication again based on the user intent.
If the authentication is canceled due to system preemption, you are advised to initiate the authentication request again later.
Do not initiate multiple authentication requests at the same time to avoid preemption.

12500004 Authentication Timed Out

Error Message

Authentication timeout.

Description

The authentication operation times out. The authentication process is automatically terminated because the user failed to complete the interaction within the specified time.

Possible Causes

The user stays on the authentication page for too long and does not enter the password or perform biometric authentication in a timely manner.
During face authentication, the user does not look at the camera lens, and therefore valid face images cannot be captured for a long time.

Solution

Prompt the user to initiate the authentication again and pay attention to the operation time limit.
Prompt the user to respond in a timely manner during authentication, for example, look at the camera lens during face authentication.
Prompt the user to enter the password before timeout for password authentication.

12500005 Unsupported Authentication Type

Error Message

The authentication type is not supported.

Description

The current device or system does not support the requested authentication mode.

Possible Causes

The input authentication mode parameter is invalid. For example, the authType parameter passed when the getAvailableStatus API is called is not within the supported range (such as PIN, FACE, and FINGERPRINT).
The device does not support the authentication mode. For example, fingerprint authentication is initiated on a device that has no fingerprint sensor.

Solution

Check whether the input authentication mode parameter is correct. Ensure that the parameter value is supported.
Before initiating authentication, call getAvailableStatus to check whether the device supports the specified authentication mode. If the device does not support a certain authentication mode, you are advised to use another supported authentication mode.

12500006 Unsupported Authentication Trust Level

Error Message

The authentication trust level is not supported.

Description

The current authentication mode cannot meet the requested security level.

Possible Causes

When the getAvailableStatus or getUserAuthInstance API is called, the value of the input parameter authTrustLevel is not within the valid range. The value should be ATL1(10000), ATL2(20000), ATL3(30000), or ATL4(40000).
The authentication capability of the current device cannot reach the specified authentication trust level. For example, face authentication of the ATL4 level is initiated on a 2D face authentication device.
The security level of the credential registered by the user is lower than the requested authentication trust level. For example, a 4-digit PIN can only reach the ATL3 level and cannot meet the ATL4 requirement.

Solution

Check whether the value of the input parameter authTrustLevel is within the valid range (ATL1 to ATL4).
If the parameter value is within the valid range, the current device may not support the authentication trust level. In this case, you are advised to reduce the authentication level.
Call the getAvailableStatus API to check whether the device supports the specified authentication trust level.
If a service requires a high security level, you can use an authentication mode that supports a higher level (for example, using PIN instead of face authentication).
For details about the level range supported by each authentication mode, see Principles for Classifying Biometric Authentication Trust Levels.

12500007 Authentication Service Is Busy

Error Message

Authentication service is busy.

Description

The authentication service is busy processing other requests and cannot respond to the current authentication request. The system authentication service is temporarily unavailable.

Possible Causes

The authentication service is processing the authentication requests of other applications, and resources are occupied.
The system is performing other authentication-related operations (such as device unlocking) and cannot respond to new authentication requests.
The authentication service cannot respond to requests during startup.

Solution

If the service is busy, you are advised to initiate the authentication request again later.
Avoid frequently initiating authentication requests within a short period of time. You can increase the request interval.

12500008 Parameter Verification Failed

Error Message

The parameter is out of range.

Description

The parameter value is out of the valid range, indicating that the input parameter value is not within the valid range of the API description.

Possible Causes

The parameter value is out of the valid range. For example, the value of reuseDuration exceeds the value of MAX_ALLOWABLE_REUSE_DURATION (300,000 ms).
The value of a numeric parameter is a negative number or zero, but the API requires a positive integer.
The length of a string parameter exceeds the upper limit. For example, the value of title exceeds 500 characters, or the value of navigationButtonText exceeds 60 characters.
The array parameter is empty, but the API requires that the parameter be not empty. For example, the authType list is empty.
The length of a Uint8Array parameter exceeds the upper limit. For example, the value of challenge exceeds 32 bytes, or the value of authToken exceeds 1024 bytes.

Solution

Check the valid value range of each parameter in the parameter description in the API document, correct the parameter, and initiate the request again.
Ensure that the value of the numeric parameter is within the valid range and meet the type requirements.
Ensure that the length of the string parameter does not exceed the limit and the content meets the requirements.
Ensure that the array parameter is not empty and the elements are valid.
Ensure that the length of the binary data parameter is within the valid range.

12500009 Authentication Locked

Error Message

Authentication is locked out.

Description

The specified authentication mode has been locked, indicating that the anti-brute force mechanism is triggered due to consecutive authentication failures. As a result, the authentication function is temporarily unavailable.

Possible Causes

The user frequently attempts to use incorrect authentication credentials, and the system starts the protection mechanism to prevent brute-force attacks.

Solution

Notify the user that the authentication is locked and they can continue the authentication only after the lock is released.
You can call the getAuthLockState API to query the current lock status, including the remaining lock time and remaining attempts.
If the lock is temporary, notify the user to try again after the lock duration expires.
If the lock is permanent, notify the user that they can continue using biometric authentication only after unlocking it with a password.
Advise the user to authenticate with the correct credentials after the lock is released to avoid triggering the lock again.

12500010 Credential Not Enrolled

Error Message

The type of credential has not been enrolled.

Description

The user has not enrolled the specified type of authentication credential, indicating that the credential data corresponding to the requested authentication mode is not registered on the device.

Possible Causes

When the getAvailableStatus API of the userAuth module is called to check the authentication capability, the value of authType is FACE or FINGERPRINT, but the user has not enrolled the face or fingerprint credential on the device.
When the start API is called to initiate authentication, the credential corresponding to the requested authentication mode is not enrolled. For example, the user initiates fingerprint authentication but has not enrolled a fingerprint.
The credential that the user has enrolled has been deleted. For example, the user deletes the enrolled face or fingerprint in the settings.
The new user account has not enrolled any authentication credential.

Solution

Check whether the user has enrolled the credential of this type.
If the user has not enrolled the credential, guide the user to enroll the credential (face, fingerprint, or PIN) in the system settings.
You can call the getEnrolledState API to query the credential enrollment status.
If the user refuses to enroll the credential, you are advised to switch to another enrolled authentication mode.
Notify the user that the authentication function can be used only after the credential is enrolled.

12500011 Switched to Custom Authentication

Error Message

Switched to the custom authentication process.

Description

The user cancels the system authentication and uses a custom authentication of the application.

Possible Causes

The user taps the navigation button (specified by the navigationButtonText parameter) on the authentication widget page. The current system authentication operation is canceled and the user uses the custom authentication mode of the application.

Solution

After receiving this error code, the application needs to display the custom authentication page for the user to complete authentication.

12500013 Password Expired

Error Message

Operation failed because of PIN expired.

Description

The password has expired due to security policy requirements.

Possible Causes

The system lock screen password has expired, which is usually caused by enterprise security policies or system settings (for example, requiring periodic password updates).
When a user initiates password authentication, fingerprint authentication, or face authentication, the system detects that the lock screen password has expired.
After the password expires, biometric (fingerprint and face) authentication cannot be used because they rely on the password as an alternate unlock method.

Solution

Notify the user that the password has expired and the authentication function can be used only after the password is changed.
Guide the user to update the password in the system settings.
After updating the password, the user can initiate an authentication request again.
In an enterprise environment, the user may need to contact the administrator to understand the password update requirements.
Remind the user to periodically update the password to avoid impact caused by password expiration.