Change MPIN
This API allows the user to change their MPIN (Mobile Personal Identification Number). It is useful when the MPIN has expired or the user decides to change it. This API cannot be used if the user has forgotten their existing MPIN.
🔑Header Parameters
| Header | Type | Description | Example |
|---|---|---|---|
| Content-type | string | Specifies the format of the request body. | application/json |
| x-api-key | string | The API key provided by SynapseWave for authentication. | x-api-key |
📦Request Body Schema
| Field | Type | Required | Description | Example/ENUM |
|---|---|---|---|---|
| user_id | string | Yes | Unique client code(UCC) assigned to the user. | user123 |
| old_mpin | integer | Yes | The existing MPIN (between 4 and 6 digits) that the user wants to change | 1234 |
| new_mpin | integer | Yes | The new MPIN (between 4 and 6 digits) that the user wants to set. | 5678 |
| api_key | string | Yes | The API key provided by SynapseWave for authentication. | api-key |
| source | string | Yes | The application from which the user has logged in. Can be WEBAPI or MOBILEAPI. | WEBAPI, MOBILEAPI |
🟢Success Response - 200 Ok
If the MPIN Change is successful, the response will contain the following.
| Field | Type | Description | Example |
|---|---|---|---|
| status | string | Status of the request, typically "success". | "success" |
| code | string | Response code indicating the result of the request. | "s-101" |
| message | string | A message confirming the MPIN change. | "MPIN changed successfully." |
put
/authentication/v1/user/mpin