IDaaS Open Platform
Employee Identity (EIAM)

Send Email Verification Code API

API

This document introduces the content related to calling the send email verification code API. Before calling the email verification code API, human-machine verification must be completed through a graphical captcha. For details, please refer to Obtaining Graphical Captcha.

# Request Description

POST https://{your_domain}/api/v2/sdk/email/send

Content-Type: application/json

# Request Header Parameters

Parameter Name Chinese Name Required Type Example
X-operating-sys-version Caller Operating System Version Yes String windows10.1.1
X-device-fingerprint Caller Device Fingerprint Yes String 156aysdna213sc50
X-device-ip Caller IP No String 192.168.1.2
X-agent User-Agent Information Yes String Mozilla/5.0 (iPhone; CPU iPhone OS 13_3 like Mac OS X) AppleWebKit/605.1.15(KHTML, like Gecko)
Mobile/15E148/HuaWei-AnyOffice/2.6.1802.0010/com.huawei.cloudlink.workplace
X-L For Internationalization Language Setting No String zh
X-client-id Application Authorization ID Yes String nTo1eRIub60vPb54WeE6aojPwYwImtl4

# Request Body Example

{
    "email": "xczczx@bamboocloud.cn",
    "type": "REGISTER_EMS",
    "captcha_token":"71dd26999e314f9abb0c635336976635---{\"x\":237.0,\"y\":5.0}"
}
1
2
3
4
5

# Request Parameters

Parameter Name Chinese Name Required Type Description
email Email Yes String Email
type Send Scenario Yes String Scenario Type
  • LOGIN_EMS: Login with Email + Verification Code API
  • REGISTER_EMS: Social Account Registration and Binding Phone Number or Email API, Email + Email Verification Code Registration API
  • MFA_AUTH_EMS: Secondary Authentication with Email + Verification Code API
  • FORGET_PWD_EMS: Retrieve Password via Email API
  • CHANGE_PWD_EMS: Force Password Change via Email for Expired Password API, Change Password via Email API
  • BIND_EMAIL_EMS: Bind Phone Number or Email after Social Account Login API
  • UPDATE_EMAIL_EMS: Update Personal Email API
    • captcha_token CAPTCHA Token Yes String CAPTCHA Verification Pass Token
    To obtain the verification code, please refer to Get CAPTCHA

    # Response Example

    Success example:
HTTP/1.1 200 OK
Error example:
HTTP/1.1 400 Bad Request
{
    "error_code": "SDK.COMMON.1001",
    "error_msg": "Parameter X-client-id cannot be left blank."
}
    1
    2
    3
    4
    5
    6
    7
    8

    # Response Parameters

    None

    Get Mobile by state_token