Send Verification Code¶

Send a verification code to a user’s email.

Operation Permissions¶

The user has logged in to Application Portal.

Request Format¶

POST https://{apigw-address}/app-portal-service/v2.3/verificationCode/send

Request Parameters (URI)¶

Name	Mandatory/Optional	Data Type	Description
type	Mandatory	String	The type of user authentication, supporting mfa for two-factor authentication.

Request Parameters (Header)¶

Name

Mandatory/Optional

Data Type

Description

accessToken

Mandatory

String

The access token (or bearer token). The format of the parameter’s string is Bearer {your token}. Refer to Log In or Refresh Access Token to learn how to get the access token.

locale

Optional

String

Language code. If unspecified, it is set to English by default.

en_US for English

zh_CN for Simplified Chinese

es_ES for Spanish

ja_JP for Japanese

de_DE for German

pl_PL for Polish

Response Parameters¶

Name	Data Type	Description
success	Boolean	The result of sending a verification code. true for “successfully sent” false for “failed to send”

Error Codes¶

Error Code	Description
31400	Required parameters are missing.
31429	The current IP address has attempted to send a verification code too many times. It has attempted to send a verification code to the target email too many times.

Sample¶

Request Sample¶

url: https://{apigw-address}/app-portal-service/v2.3/verificationCode/send?type=mfa

method: POST

headers: {"accessToken":"Bearer your_token"}

Return Sample¶

{
  "code": 0,
  "message": "OK",
  "data": {
    "success":true
  }
}