Set Password
This API allows the user to set a new password after successfully verifying the OTP. It is the final step in the Forgot Password flow.
| Headers | Type | Required | Description | Example |
|---|
| Content-type | string | Yes | The media type of the request body | application/json |
| x-api-key | string | Yes | API key provided for authentication | x-api-key |
📦 Request Body Schema
| Field | Type | Required | Description | Example |
|---|
| user_id | string | Yes | Unique Client Code assigned to the user | "UCC123456" |
| new_password | string | Yes | The new password to be set by the user | "Mysecure@123" |
| otp | string | Yes | Temporary OTP token generated from Verify OTP API | "{{forgot_password_token}}" |
| api_key | string | Yes | API key provided by synapsewave | "apikey_from_synapse" |
| source | string | Yes | Platform used - WEBAPI for browser based and MobileAPI for App based. | "WEBAPI" |
🟢Success Response
| Field | Type | Description | Example |
|---|
| status | string | Indicates the status of API Call. | "success" |
| code | string | Internal Response code. | "s-101" |
| message | string | User-friendly message. | "Password changed Successfully" |