SEND OTP (Password TOTP)
Sends one time password (OTP) to the registered mobile number of the user. This API supports flow such as Forgot Passwords and for Registering Time-Based OTP (TOTP) for 2FA.
🔑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 for identifying the client application. | x-api-key |
📦 Request Body Schema
| Fields | Type | Required | ENUM/Example | Description |
|---|---|---|---|---|
| user_id | String | Yes | "UCC123456" | Unique client code (UCC) provided to the user. |
| api_key | String | Yes | "abc123xyz" | API key provided to user by Synapsewave |
| source | String | Yes | "WEBAPI", "MOBILEAPI" | Platform making the request; WEBAPI for browsers and MOBILEAPI for apps |
🟢Success Response - 200 OK
Content-type: application/json
| Field | Type | Description | Example |
|---|---|---|---|
| Status | String | Status of the API Call (Default: Success) | "success" |
| Code | String | Code representing the response type | "s-101" |
| Message | String | Human readable message | "OTP sent to reset Password." |
Next Step
Pass the OTP received on the user's mobile number to the Verify OTP API to obtain a forgot_password_token.
You can then use the returned token with either:
- Set Password to reset the user's password.
- Register TOTP to configure two-factor authentication.