Verify TOTP
This API verifies a TOTP value entered by the user after they have registered TOTP via the Register TOTP flow. Calling this successfully enables TOTP as an active second-factor method for the user's account.
| Header | Type | Description | Example |
|---|
| Content-type | string | The content type of the request body. | application/json |
Authorization | string | Bearer token for user authentication. | Bearer {{access_token}} |
x-api-key | string | The API key provided by SynapseWave. | {{x-api-key}} |
📦Request Body Schema
| Field | Type | Required | Description | Example/ENUM |
|---|
second_auth | string | Yes | The TOTP value entered by the user from their authenticator app. | "123456" |
🟢Success Response - 200 Ok
| Field | Type | Description | Example/ENUM |
|---|
| status | string | Indicates the status of the API Call | "success" |
| code | string | Response code indicating the result of the request | "s-101" |
| message | string | Confirmation message indicating the TOTP has been successfully verified. | "TOTP Verified successfully" |
| data | string | Contains details related to the TOTP verification process. | See below |
📝Data Object Field Info
| Field | Type | Description | Example |
|---|
| userId | string | Unique Client Code (UCC) assigned to the user | "UCC123456" |