Set Fingerprint
This API allows a user to set up fingerprint authentication for login. Before setting the fingerprint, the user must successfully verify an OTP (One-Time Password).
🛣️Path Parameter
| Parameter | Type | Required | Description |
|---|
| tenantID | string | Yes | Unique ID of the tenant |
| 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 | OTP Received by the user | "456789" |
| 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 | "message": "Fingerprint set successfully" |