Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

falseoption

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

falseoption

A special subdomain of funcaptchaarkoselabs.com, from which the JS captcha widget should be loaded. Most FunCaptcha installations work from shared domains.

Request Example

Code Block
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"
  }
}

Request Example (Full Paramaters)

Code Block
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",
    "data": "{\"blob\": \"zovhMwTRjCpfcVNl.I9rn5oNdZetyte0643eFqqSN3K8u+kdF/0VP9UCqRtUxAjg8ULXcPw8xyOSVWdm0LPfbSXgjWNgGjZjeE1wuiJvhG9BPGIZkXMQQhA8mYf9E8X6WdvyscLq53RNPO2575GJ86nUOOQOAgjTmLI9NPpPfBaBwRVqaYxFVtp03H+fEDgsqvc6Jy2pviPMHi/5v2jE46AoM0GG+4qjGD+jUZaibttCxTiYnWzYmnHG1bp2SiFVDArttDciqcBC2st9eeNioC0D7Ym0ONt2dCJk6LIQaLlqg1ieTEw9t4Y6lQsfUzH/bMNjOPapqYVmH0IuVSt/v8uPu5zqIZ/8OweXEU92b2BBzEXw6IK11Y0cwLZWldPIx1B1NqajlG3LfMEoe8Y3dayXKkASymacvX6tXKKkeZDUs8Zz7SZ4OldU5hdNn7RVsomMseG2l2pGzmVTXSFL8s2EavAl7GTTKDdzSX1qeBDHVbfQ3/9vkKwGdQ5J3+tQjtw1fP00c1AL5/fMIL+Io9odEyaOgqnK0pdg7UN+67LUcIo8T86F76nn9Pqjle5hywsZjmaKJALg2Sd7pA+l1e64/HrW7AdT+ZTfM7Q2Oc/Et/6hY6eOZiG21Ny3CSg==\"}"
  }
}

Response Example

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

...