SEND OTP
Sends one time passoword (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.
📦 Request Body Schema
| Fields | Type | Required | ENUM/Example | Description |
|---|
| user_id | String | Yes | "UCC123456" | Unqiue 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 - 200K
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." |
🔴 Error Response - 400 Bad Request
| Field | Type | Description | Example |
|---|
| status | string | Status of the API call Default Error | "error" |
| code | string | Error code indicating the failure | "e-101" |
| message | string | Specific message explaining why the requested resource was not found | "Error Message" |