Employee Identity (EIAM)

Verify Graphical Captcha Interface

Interface

After sliding the graphical captcha slider, call the verify graphical captcha interface.

# Request Description

POST https://{your_domain}/api/v2/sdk/captcha/verify

Content-Type: application/json

# Request Header Parameters

Parameter Name Chinese Name Required Type Example
X-operating-sys-version Caller OS 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

#For sending SMS verification code scenario
{
  "point_json": "{\"x\":237.0,\"y\":5.0}",
  "token": "71dd26999e314f9abb0c635336976635",
  "sender":"15201657315"
}
#For sending email verification code scenario
{
  "point_json": "{\"x\":237.0,\"y\":5.0}",
  "token": "71dd26999e314f9abb0c635336976635",
  "sender":"zhangsan@qq.com"
}
1
2
3
4
5
6
7
8
9
10
11
12

# Request Parameters

Parameter Name Chinese Name Required Type Description
point_json Coordinate Information Yes String Coordinate information, y-axis fixed value 5.0
Refer to JS, VUE Puzzle Captcha DEMO for obtaining coordinate information
token Token returned from obtaining graphical captcha Yes String Token returned from obtaining graphical captcha
sender Sender Yes String Sender (phone number, email)

# Response Example

Success Example:
HTTP/1.1 200 OK
Content-Type: application/json
{
    "captcha_token":"71dd26999e314f9abb0c635336976635---{\"x\":237.0,\"y\":5.0}"
}
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
9
10
11
12

# Response Parameters

Parameter Name Chinese Name Type Description
captcha_token Graphical Captcha Verification Success Token String Token for successful graphical captcha verification