Skip to content
Security Settings

Toggle SMS Two-Factor Verification

Turns the Client's SMS two-factor verification on or off. It maps to the SMS verification item in the two-factor verification settings. Choose action from the Client's current state: pass close if it is on, or open if it is off.

Before calling, send an SMS verification code to the Client's bound mobile number (the send-code operation is outside the scope of this document), then put the code the Client enters in code. On success the setting changes immediately, so fetch the Client settings again to refresh the toggle. On failure, show message and let the Client request or enter a new code.

For the SMS second-factor step during trade unlock, see Submit SMS Verification for Trade Unlock.

When you call this operation through WhaleCore requestService(), you do not need to set requiresTradeToken to true.

POSThttps://api.lbkrs.com/v1/member/2fa/switch

Request body application/json

actionstringrequired

Target state:

  • open - Turn on SMS two-factor verification
  • close - Turn off SMS two-factor verification
Values
open
close
codestring

SMS verification code received by the Client. Required when verification is completed with an SMS code

Responses

HTTP 200The request succeeded. The response body contains the result of the “Toggle SMS Two-Factor Verification” operation.
Standard response envelopecodemessagedata
dataobjectdata structure

No business fields

No nested fields

Whale Docs