Set Fingerprint

This API allows a user to set up fingerprint authentication for login. The temporary token returned by Verify OTP must be passed as the otp field in this request.

🛣️Path Parameter

Parameter	Type	Required	Description
tenantID	string	Yes	Unique ID of the tenant

🔑Header Parameters

Header	Type	Description	Example
Content-type	string	Specifies request format	application/json
x-api-key	string	API Key provided by the synapsewave	x-api-key

📦 Request Body Schema

Field	Type	Required	Description	Example
user_id	string	Yes	Unique Client Code (UCC) assigned to the user.	"UCC123456"
group_Id	string	Yes	The group to which the user belongs	"Group001"
type	string	Yes	Action type flag to set fingerprint	"SET_FINGERPRINT"
udid	string	Yes	Unique DeviceIdentifier (UDID) of the user's mobile.	"A1BC3D4E576"
otp	string	Yes	Temporary token returned by the Verify OTP API	"{{forgot_password_token}}"
api_key	string	Yes	API key provided by synapsewave	"apikey_123456"
source	string	Yes	Source of the request. Use "WEBAPI" for browser or "MOBILEAPI" for mobile	"MOBILEAPI"

🟢Success Response - 200 Ok

Field	Type	Description	Example
status	boolean	true if the API call was successful.	"true"
result	array of objects	Contains additional response details if present	Refer below

📦 Result Object Fields

Field	Type	Description	Example
Valid	string	Validity status; null if not applicable	null
sMPIN	string	Encrypted MPIN string stored against the device	"GXAvzXx++xw="
nMPINInvalidAttempt	integer	Count of invalid MPIN/fingerprint attempts made	0
ExpiryDaysRem	integer	Number of days remaining before the MPIN/fingerprint setup expires	17
nMPINSkipped	integer	Count of times the MPIN setup was skipped by the user	0
sUDID	string	Device UDID against which the fingerprint is registered	"5c340bd7-5bd3-4aaf-9d03-b26626b16858"