Skip to content
Security Settings

Set Authenticator Two-Factor Verification

Turns the Client's third-party authenticator (TOTP) two-factor verification on or off. Once it is on, verifying the trade password during trade unlock may return need_totp_two_factors: true; then call Submit Authenticator Code for Trade Unlock.

  • To turn it on: pass YES in totp_2fa_auth and the code currently shown in the Client's authenticator in verify_code to confirm the binding.
  • To turn it off: pass NO in totp_2fa_auth. verify_code is not needed.

Both actions require the Client to pass SMS verification of the bound mobile number first. Put the credential returned by that check in verify_credentials (send the code with POST /v1/auth/send_code and check it with POST /v1/member/check_mobile, both with type = totp). If the credential has expired, business code 403046 is returned; in the turn-on flow, have the Client complete SMS verification again. If the code is wrong, show message and let the Client enter it again. On success, refresh the two-factor verification settings shown to the Client.

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

POSThttps://api.lbkrs.com/v1/account/totp/setting

Request body application/json

totp_2fa_authstringrequired

Target state:

  • YES - Turn on authenticator two-factor verification
  • NO - Turn off authenticator two-factor verification
Values
YES
NO
verify_credentialsstringrequired

Verification credential obtained after the SMS code check passes. It expires after a period of time

verify_codestring

Current 6-digit code shown in the authenticator. Required when totp_2fa_auth is YES

Responses

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

No business fields

No nested fields

HTTP 400The service rejected the request because a business rule or input validation failed. Review the business codes and correct the request before retrying.
codeintegerrequired

Business status code, 0 indicates success

messagestringrequired

Human-readable result or error message.

Whale Docs