Skip to main content
Version: 3.x


Starts SOTER biometric authentication. For the verification procedure, see description.

resultJSON description

This data is the JSON data obtained in the device's TEE by combining the incoming challenge parameter and other security information in the TEE. The fields are described as follows.

rawThe challenge factor passed in by the caller
fid(Supported only on Android) The ID of the biometric information for the current biometric recognition and authentication (for example, for fingerprint recognition, this field indicates the ID of fingerprint information in this device).
counterA parameter of the anti-replay feature
tee_nTEE name (for example, Qualcomm or trustonic)
tee_vTEE version
fp_nThe provider of the fingerprints and related logic modules (such as the FPC)
fp_vThe version of the fingerprints and related modules
cpu_idThe unique device ID
uidApp ID, which is similar to the UID defined on Android.



(option: Option) => Promise<SuccessCallbackResult>



challengestringYesChallenge factor, which is the key recognition information of a string used for signing that is prepared by the caller for the current biometric authentication. It serves as a part of resultJSON to help the caller recognize this request. For example, if the user is requested to authorize and confirm an order, the order number can be entered in this parameter.
requestAuthModes("fingerPrint" | "facial" | "speech")[]YesAccepted biometric authentication methods in the request
authContentstringNoVerification description, i.e. the hint in a dialog box displayed on the UI during recognition.
complete(res: any) => voidNoThe callback function used when the API call completed (always executed whether the call succeeds or fails)
fail(res: any) => voidNoThe callback function for a failed API call
success(res: Result) => voidNoThe callback function for a successful API call


authModestringBiometric authentication method
resultJSONstringThe device security information (for example, the name and version of the Trusted Execution Environment (TEE), and anti-replay parameters) obtained in the TEE and information for this authentication (for example, the fingerprint ID. It is supported only on Android).
resultJSONSignaturestringThe signature (SHA-256 with RSA/PSS, saltlen=20) on resultJSON generated using the SOTER security key
errCodenumberError code
errMsgstringError message


fingerPrintFingerprint recognition
facialFace recognition
speechVoiceprint recognition (not supported)

API Support

APIWeChat Mini-ProgramH5React Native

Sample Code

requestAuthModes: ['fingerPrint'],
challenge: '123456',
authContent: 'Unlock with your fingerprint',
success: function (res) { }
"tee_n":"TEE Name",
"tee_v":"TEE Version",
"fp_n":"Fingerprint Sensor Name",
"fp_v":"Fingerprint Sensor Version",
"cpu_id":"CPU Id",

API Support

APIWeChat Mini-ProgramH5React Native