Skip to content

Send Verify Code

  • Endpoint Path: /api/v2/common/send-verify-code
  • Method: POST
  • Request: application/json

Headers Optional Parameter

Parameter NamePublic Mode (Required)Private Mode (Required)

Body Params

Parameter NameTypeRequiredDescription
typeStringrequiredSending type: email, sms
useTypeNumberrequiredPurpose type: 1. New account verification / 2. Existing account verification / 3. Fill-in-the-blank verification / 4. Identity verification / 5. Others
templateIdNumberrequiredTemplate ID
accountStringoptionalEmail or phone number (Not required for useType with 4, required for other types)
countryCodeNumberoptionalFor phone number usage only, required when used, international area code

Request Description

  • useType
    • 1 New account verification: can be requested even if not logged in, but the account must not exist in the database. For example, new registration, change of binding, etc.
    • 2 Existing account verification: Can be requested even if you are not logged in, but the account must exist in the database. For example, verification code login, password reset, etc.
    • 3 Fill-in-the-blank verification: Can only be requested when logged in, and the corresponding email or mobile phone number of the account must be blank. For example, set the account email or cell phone number binding, etc.
    • 4 Authentication: It can be requested only at login, no account parameter is needed, the system will use the email or mobile phone number of the current login account to send the verification code. For example, pre-verification for changing important information, etc.
    • 5 Send directly by account.
  • There is a limit on interface, only one verification code can be sent in 1 minute, and five in 10 minutes. If there is other limit on interface, it is determined by the associated plug-in.


    "code": 0,
    "message": "ok",
    "data": null

Released under the Apache-2.0 License