Skip to content
Identity Verification

Get Human Verification Configuration

Returns the human verification configuration required before sending an SMS or email verification code. The client uses it to initialize Tencent Cloud Captcha or Google reCAPTCHA Enterprise, then puts the verification result in captcha of POST /v1/auth/send_code or POST /v1/auth/email/send_code.

Pass common in type to get the configuration for every scene. When sending a code, take the AppId for the scene that matches type in that request from tencent_ids:

  • sms - reset_trade_password, set_trade_password, trade_auth_2fa, totp, and change_mobile (whether the code is sent by SMS or email)
  • email - change_email, bind_email, and verify_email

google_key is the encrypted site key. Decrypt it by reversing the card_id encryption described in “Verify Account-Opening ID Number”: Base64-decode it to get {"rd":"...","k":"..."}, use the MD5 hexadecimal string of rd as the AES key and IV, and decrypt k with AES-CBC.

When tencent_switch or google_switch is true, the server has turned off human verification for that provider. Do not show the verification widget; send an empty object for that provider in captcha.

If sending a code returns 401017 or 401074, get this configuration again and complete human verification again before resending.

This configuration is used by the same features as sending SMS and email verification codes.

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

GEThttps://api.lbkrs.com/v2/auth/captcha

Parameters

typestringqueryRequired

Verification scene type. Pass common to get the configuration for all scenes:

  • common - General
  • sms - SMS verification code scene
  • email - Email verification code scene

commonsmsemail

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get Human Verification Configuration” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
captchaobject

Human verification configuration

Child attributes
tencent_idsobject

Tencent Cloud Captcha AppIds indexed by scene type (common, sms, email)

tencent_switchboolean

Whether human verification with Tencent Cloud Captcha is turned off. When true, do not show the widget and send {"tencent": {}}

google_keystring

Encrypted Google reCAPTCHA Enterprise site key. See the operation description for decryption

google_switchboolean

Whether human verification with Google reCAPTCHA Enterprise is turned off. When true, send {"google": {}}

Whale Docs