Skip to main content

Verify TOTP

This API call verifies the TOTP (Time-Based One-Time Password) entered by the user after login, enabling TOTP as a second-factor authentication.

🔑Header Parameters

HeaderTypeDescriptionExample
Content-typestringThe content type of the request body.application/json
AuthorizationstringBearer token for user authentication.Bearer {{access_token}}
x-api-keystringThe API key provided by SynapseWave.{{x-api-key}}

📦Request Body Schema

FieldTypeRequiredDescriptionExample/ENUM
second_authstringYesThe TOTP value entered by the user from their authenticator app."123456"

🟢Success Response - 200 Ok

FieldTypeDescriptionExample/ENUM
statusstringIndicates the status of the API Call"success"
codestringResponse code indicating the result of the request"s-101"
messagestringConfirmation message indicating the TOTP has been successfully verified."TOTP Verified successfully"
datastringContains details related to the TOTP verification process.See below

📝Data Object Field Info

FieldTypeDescriptionExample
userIDstringUnique Client Code (UCC) assigned to the user"UCC123456"
post/authentication/v1/user/verifytotp