Versions Compared

Key

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

...

Info

The gt, challenge and geetestApiServerSubdomain parameters are most often found inside the initGeetest JavaScript function.

Parameter

Type

Required

Value

type

String

yes

GeeTestTaskProxyless

websiteURL

String

yes

Address of the page on which the captcha is

ricognized

recognized

gt

String

yes

The GeeTest identifier key for the domain. Static value, rarely updated.

challenge

String

yes

A dynamic key.
Each time our API is called, we need to get a new key value. If the captcha is loaded on the page, then the challenge value is no longer valid and you will get ERROR_TOKEN_EXPIRED error.

Warning

You will be charged for tasks with ERROR_TOKEN_EXPIRED error!

It is necessary to examine the requests and find the one in which this value is returned and, before each creation of the recognition task, execute this request and parse the challenge from it.

geetestApiServerSubdomain

String

no

Optional parameter. May be required for some sites.

geetestGetLib

String

no

Optional parameter. May be required for some sites.
Send JSON as a string.

userAgent

String

no

Browser User-Agent used to recognize captcha.

Request example

Address: https://api.capmonster.cloud/createTask

...

Use the getTaskResult method to get the result of GeeTest recognition. Depending on the system load, you will receive a response after a time in the range from 10 s to 30 s.

Property

Type

Description

challenge

String

All three parameters are required when submitting the form on the target site.

validate

String

seccode

String

Example:

Code Block
{
    "errorId":0,
    "status":"ready",
    "solution":
    {
        "challenge":"0f759dd1ea6c4wc76cedc2991039ca4f23",
        "validate":"6275e26419211d1f526e674d97110e15",
        "seccode":"510cd9735583edcb158601067195a5eb|jordan"
    }
}

...