Versions Compared

Version Old Version 2 New Version 3
Changes made by

potkl

potkl

Saved on

Key

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

...

Parameter

Type

Required

Description

clientKey

string

yes

Your client key

type

string

yes

CloudFlareTurnstileTask

websiteURL

string

yes

website url, usually a fixed value.

websiteKey

string

yes

website key, usually a fixed value.

rqData

Object

optional

Turnstile extra data (Document)

rqData.mode

string

optional

The value of the data-action attribute of the Turnstile element if it exists.

rqData.metadataAction

string

optional

The value of the data-action attribute of the Turnstile element if it exists.

rqData.metadataCdata

string

optional

The value of the data-action attribute of the Turnstile element if it exists.

Request Example

Code Block
POST https://api.ez-captcha.com/createTask

Content-Type: application/json

{
    "clientKey": "cc9c18d3e263515c2c072b36a7125eecc078618f",
    "task": {
        "websiteURL": "https://xxx.com",
        "type": "CloudFlareTurnstileTask",
        "websiteKey": "xxxx",
        "rqData":{                     //optional
            "mode":"flexible",
            "metadataAction":"signup",
            "metadataCdata":""
        },
    }
}

Reponse Example

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

...