Register MPIN
This API allows a logged-in user to register an MPIN for the first time, which can then be used for quick login instead of entering the full password.
🔑Header Parameters
| Header | Type | Description | Example |
|---|---|---|---|
| Content-type | string | Specifies the format of the request body. | application/json |
| Authorization | string | The access token used for authentication. | {{access_token}} |
| x-api-key | string | The API key for identifying the application. | {{x-api-key}} |
📦Request Body Schema
| Field | Type | Required | Description | Example/ENUM |
|---|---|---|---|---|
| mpin | string | Yes | The 4 to 6 digit numeric PIN the user wishes to set. | 1234 |
| mobile_udid | string | No | The unique device identifier of the user's mobile. Used for mobile login<=50 characters | A1B2C3D4E5F6 |
- mpin: Should be a 4 to 6 digit number (e.g.,
1234,987654). - mobile_udid: A string representing the device's UDID , used for identifying the user's device when using MPIN for login. This field is optional.
🟢Success Response : 200 OK
| Field | Type | Description | Example |
|---|---|---|---|
| status | string | Status of the request. | "success" |
| code | string | Response code indicating the result. | "s-101" |
| message | string | A message giving further details. | "MPIN/Fingerprint Registered Successfully." |
Register MPIN vs Set MPIN
✅ Register MPIN
- Used for first-time MPIN registration
- Requires an authenticated user session
🔄 Set MPIN
- Used to reset a forgotten MPIN
- Requires OTP verification and a valid
forgot_password_token