Verify Code¶

Verify a verification code.

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/verify

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
Authorization	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.

Request Parameters (Body)¶

Name	Required/Optional	Data Type	Description
code	Required	String	The verification code to be verified.

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.
31410	The verification code has expired.
31429	The current email has attempted to verify the verification code too many times.
31430	The verification code is incorrect.

Sample¶

Request Sample¶

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

method: POST

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

requestBody:
{"code": "your_code"}

Return Sample¶

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