Send Verification Code¶

Send a verification code to a user’s email.

Prerequisites¶

The user has logged in to Application Portal and entered an OU. You can log in to Application Portal through the Log In API and select the OU through the Choose Organization API.

Request Format¶

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

Request Parameters (URI)¶

Name	Location(Path/Query)	Required/Optional	Data Type	Description
type	Query	Required	String	User authentication type. Only supports the value `mfa`, which means two-factor authentication.

Request Parameters (Header)¶

Name

Required/Optional

Data Type

Description

accessToken

Required

String

The access token generated after the user logs in and selects the OU, represented by Bearer Token, is in the form of Bearer {your token}. You can call the Log In or Refresh Access Token API to obtain the access token.

locale

Optional

String

Specifies the language in which to return the list information. The following values are supported:

en_US: English

zh_CN: Chinese

es_ES: Spanish

ja_JP: Japanese

de_DE: German

pl_PL: Polish

By default, the list information in English en_US is returned.

Response Parameters¶

Name	Data Type	Description
success	Boolean	Whether the verification code was sent successfully. `true` means it was sent successfully, `false` means it failed to be sent.

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
  }
}