FunCaptcha

Create a task through the createTask method, and then get the result through the getTaskResult method

This object is used to identify the Funcaptcha

Task Type

Task Type	Description	Price	Price(USD)	VIP7 Price(USD)
FuncaptchaTaskProxyless	Funcaptcha solution, using server built-in proxy	16 POINTS	$1.6/1k	$1.3/1k

Create Task

Create a task through the createTask method

Request host： https://api.ez-captcha.com

Request api： https://api.ez-captcha.com/createTask

Request format：POST application/json

Request Parameters

Parameters	Type	Required	Description
clientKey	string	true	Account client key, which can be found in the personal center
type	string	true	Task type: FuncaptchaTaskProxyless
websiteURL	string	true	Website url using Funcaptcha, usually a fixed value
websiteKey	string	true	Funcaptcha site key, a fixed value
data	string	false	Additional parameter that may be required by FunCaptcha implementation. Use this property to send "blob" value as a stringified array. See example how it may look like. `{"\blob\":\"HERE_COMES_THE_blob_VALUE\"}`
funcaptchaApiJSSubdomain	string	false	A special subdomain of `funcaptcha.com`, from which the JS captcha widget should be loaded. Most FunCaptcha installations work from shared domains.

Request Example

POST https://api.ez-captcha.com/createTask
Content-Type: application/json

{
  "clientKey": "7e5ffc29e3354a19991002f2a19978bb696679",
  "task": {
    "websiteURL": "https://signup.live.com/signup2",
    "websiteKey": "B7D8911C-5CC8-A9A3-35B0-554ACEE604DA",
    "type": "FuncaptchaTaskProxyless"
  }
}

Response Example

{
    "errorId": 0,
    "errorCode": "",
    "errorDescription": "",
    "taskId": "61138bb6-19fb-11ec-a9c8-0242ac110006" // Please record this ID
}

Get Result

Use the getTaskResult method to get the recognition result

Request host： https://api.ez-captcha.com

Request api： https://api.ez-captcha.com/getTaskResult

Request format：POST application/json

Depending on system health, you will get results in 10s to 20s

Request Example

POST https://api.ez-captcha.com/getTaskResult
Content-Type: application/json
 
{
    "clientKey":"YOUR_API_KEY",
    "taskId": "TASKID OF CREATETASK" //TaskID created by createTask api
}

Response Data

Parameter	Type	Description
errorId	Integer	Error message: 0 - no error, 1 - error
errorCode	string	Error code, click here to view all error list
errorDescription	string	Detailed error description
status	string	processing - task is in progress, please try again in 1 seconds ready - task is complete, find the result in the solution parameter
solution	Object	The recognition result will be different for different types of captcha. For Funcaptcha, the result is token in the object.
solution.token	string	Recognition result: token value, used for POST or simulate d submission to the target website. It is recommended to use immediately

Response Example

{
    "errorId": 0,
    "solution": {
        "token": "03AGdBq25SxXT-pmSeBXjzScW-EiocHwwpwqtk1QXlJnGnU......"
    },
    "status": "ready"
}

Response Description

Successful recognition: when errorId is equal to 0 and status is equal to ready, the result is in the solution.
Identifying: When errorId is 0 and status is processing, please try again after 1 seconds.
An error occurred: when the errorId is greater than 0, please understand the error information according to the errorDescription All error descriptions