Verify Captcha

This document introduces the API for verifying the graphic captcha after sliding the slider.

Request Description

Request Headers

Parameter Name	Chinese Name	Required	Type	Example
X-operating-sys-version	Caller client OS version	Yes	String	windows10.1.1
X-device-fingerprint	Caller client device fingerprint	Yes	String	156aysdna213sc50
X-device-ip	Caller 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

Used for sending SMS verification code scenario

{
	"point_json": "{\"x\":237.0,\"y\":5.0}",
	"token": "71dd26999e314f9abb0c635336976635",
	"sender": "15200000000"
}

Used for sending email verification code scenario

{
	"point_json": "{\"x\":237.0,\"y\":5.0}",
	"token": "71dd26999e314f9abb0c635336976635",
	"sender": "15200000000@163.com"
}

Request Parameters

Parameter Name	Chinese Name	Required	Type	Description
point_json	Coordinate information	Yes	String	Coordinate information, y-axis fixed value 5.0 For coordinate information, seeJS, VUE Puzzle Captcha Demo
token	Captcha identity token	Yes	String	Token returned by Get Captcha
sender	Sender	Yes	String	Sender (mobile number, email)

Response Example

Success Example

HTTP/1.1 200 OK

{
    "captcha_token":"71dd26999e314f9abb0c635336976635---{\"x\":237.0,\"y\":5.0}"
}

Error Example

HTTP/1.1 400 Bad Request

{
    "error_code": "IDAAS.SDK.CAPTCHA.0002",
    "error_msg": "Graphic verification code verification failed"
}

Response Parameters

Parameter Name	Chinese Name	Type	Description
captcha_token	Captcha verification pass token	String	Token after successful captcha verification

Error Codes

Status Code	Error Codes	Chinese Error Message	English Error Message	Resolution
400	IDAAS.SDK.PARAM.0001	设备信息不完整	Device information is incomplete	Please check whether the input device information is complete
400	IDAAS.SDK.PARAM.0002	clientId不能为空	clientId cannot be empty	Please check whether the input clientId is empty
400	IDAAS.SDK.PARAM.0003	应用未注册，请先注册应用	The app is not registered, please register the app first	Please check whether the input clientId is correct
400	IDAAS.SDK.PARAM.0004	坐标信息不能为空	Point json cannot be empty	Please check whether the input coordinate information is empty
400	IDAAS.SDK.PARAM.0005	图形验证码身份令牌不能为空	Token cannot be empty	Please check whether the input captcha identity token is empty
400	IDAAS.SDK.PARAM.0006	发送方不能为空	Sender cannot be empty	Please check whether the input sender is empty
400	IDAAS.SDK.CAPTCHA.0002	图形验证码校验失败	Graphic verification code verification failed	Please check whether the input items are correct and call again