Get Captcha Image Interface

Used for human-machine verification to initialize a graphical captcha. Before sending SMS or email verification codes, human-machine verification must be completed first to distinguish whether it is a real user. The interface interaction flow is as follows:

Request Description

GET https://{your_domain}/api/v2/sdk/captcha

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 Parameters

None

Response Example

Success Example:
HTTP/1.1 200 OK
Content-Type: application/json
{
    "captchaId": null,
    "projectCode": null,
    "captchaOriginalPath": null,
    "captchaFontType": null,
    "captchaFontSize": null,
    "secretKey": "yMXC583dP4R7uhmq",
    "originalImageBase64": "iVBORw0KGgoAAAANSUhEUgAAATYABj/WRVk78AAAAASUVORK5CYII=",
    "point": null,
    "jigsawImageBase64": "iVBORw0KGgoAAAANSUhEUgADcAAAAASUVORK5CYII=",
    "wordList": null,
    "pointList": null,
    "pointJson": null,
    "token": "389c21b32a8e4eba9a6d75b71150bfd1",
    "result": false,
    "captchaVerification": null
}
Error Example:
HTTP/1.1 400 Bad Request
{
    "error_code": "SDK.COMMON.1001",
    "error_msg": "Parameter X-client-id cannot be left blank."
}

Return Parameters

Parameter Name	Chinese Name	Type	Description
captchaId	Captcha ID	String	Captcha ID
projectCode		String
captchaOriginalPath		String
captchaFontType		String
captchaFontSize		String
secretKey		String
originalImageBase64	Original Image Base64	String	Original Image Base64
point	Slider Selection Coordinates	String	Slider Selection Coordinates
jigsawImageBase64	Slider Image Base64	String	Slider Image Base64
wordList	Selection Text	String	Selection Text
pointList	Selection Coordinates	String	Selection Coordinates
pointJson	Point Coordinates (Base64 Encrypted Transmission)	String	Point Coordinates (Base64 Encrypted Transmission)
token	Token (Unique Identifier for Each Captcha Request)	String	Token (Unique Identifier for Each Captcha Request)
result	Verification Result	String	Verification Result
captchaVerification	Backend Secondary Verification Parameter	String	Backend Secondary Verification Parameter