IDaaS Open Platform
Customer Identity (CIAM)

Get Graphical Captcha

This document introduces the content related to the initialization graphical captcha interface used for human-machine verification. Before sending SMS or email verification codes, human-machine verification must be completed 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 Headers

Parameter Name Chinese Name Required Type Example
X-operating-sys-version Calling Client Operating System Version Yes String windows10.1.1
X-device-fingerprint Calling Client Device Fingerprint Yes String 156aysdna213sc50
X-device-ip Calling Client 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)
X-L Used for Internationalization Language Setting No String zh
X-client-id Application Authorization ID Yes String nTo1eRIub60vPb54WeE6aojPwYwImtl4
content-type Content Format Type Yes String application/json

# Request Example

None

# 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": "IDAAS.SDK.PARAM.0001",
    "error_msg": " Device information is incomplete"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

# Response 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 Point Selection Coordinates String Slider Point Selection Coordinates
jigsawImageBase64 Slider Image Base64 String Slider Image Base64
wordList Point Selection Text String Point Selection Text
pointList Point Selection Coordinates String Point 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

# Error Codes

Status Code Error Code Error Message Action
400 IDAAS.SDK.PARAM.0001 Device information is incomplete Please check if the input device information is complete
Device information is incomplete
400 IDAAS.SDK.PARAM.0002 clientId cannot be empty Please check if the input clientId is empty
clientId cannot be empty
400 IDAAS.SDK.PARAM.0003 The app is not registered, please register the app first Please check if the input clientId is correct
The app is not registered, please register the app first
400 IDAAS.SDK.COM.0002 System busy, please try again later Please retry or contact Zhuyun staff
System busy, please try again later

Verify Graphic Captcha