Sending Email Verification Code
Function
This API is used to send an email verification code.
Debugging
You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.
URI
POST https://{hostURL}/v4/user/email-verify-code
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Auth-Token | Yes | String | Definition User token. Obtain a token by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token. Constraints Mandatory. Range 1–100,000 characters. Default Value N/A. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| | No | String | Definition Email address. Range 1–1,000 characters. |
| verify_code | No | String | Definition Verification code. Range 1–1,000 characters. |
Response Parameters
Status code: 201
| Parameter | Type | Description |
|---|---|---|
| result | String | Definition Result of sending an email verification code. Range 1–1,000 characters. |
Status code: 401
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Definition Error code. |
| error_msg | String | Definition Error message. |
Example Requests
POST https://{endpoint}/v4/user/email-verify-code
{
"email" : "11@email.com"
} Example Responses
Status code: 201
OK
{
"result" : "Verification Code Sent"
} Status code: 401
Unauthorized
{
"error_code" : "DEV.00000003",
"error_msg" : "Authentication information expired."
} Status Codes
| Status Code | Description |
|---|---|
| 201 | OK |
| 401 | Unauthorized |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.