Skip to main content

Set Password

This API allows users to set a new password for their login, after successfully validating the OTP (One-Time Password).

🔑Header Parameters

HeadersTypeRequiredDescriptionExample
Content-typestringYesThe media type of the request bodyapplication/json
x-api-keystringYesAPI key provided for authenticationx-api-key

📦 Request Body Schema

FieldTypeRequiredDescriptionExample
user_idstringYesUnique Client Code assigned to the user"UCC123456"
new_passwordstringYesThe new password to be set by the user"Mysecure@123"
otpstringYesTemporary OTP token generated during the OTP verification step"456789"
api_keystringYesAPI key provided by synapsewave"apikey_from_synapse"
sourcestringYesPlatform used - WEBAPI for browser based and MobileAPI for App based."WEBAPI"

🟢Success Response

FieldTypeDescriptionExample
statusstringIndicates the status of API Call."success"
codestringInternal Response code."s-101"
messagestringUser-friendly message."Password changed Successfully"
put/authentication/v1/user/password/reset