Retrieve captcha credits

GET/tiktok/captchas/credits

Retrieve the rate limits for the provided API key.

This route is deprecated as CAPTCHAs are no longer billed for usage.

Responses

200Ok

Response Attributes

code*number (double)
messagestring
credits*number (double)
||
Request
Response200

Complete whirl captcha

POST/tiktok/captchas/whirl

The whirl captcha requires two images: the outer image and the inner image.

Example Image

Usage

The solution to the whirl captcha is an angle from 0-360. To use it in the GUI, it must be converted to a slider distance:

px = ((sidebar_length - icon_length) * angle) / 360

  • sidebar_length is the width of .captcha_verify_slide--slidebar
  • icon_length is the width of .secsdk-captcha-drag-icon

Request Body

Required
outerImage*string (binary)

The outer image file

innerImage*string (binary)

The inner image file

Responses

200Ok

Response Attributes

response*object
cached*boolean
code*number (double)
messagestring
||
Request
Response200

Complete shapes captcha

POST/tiktok/captchas/shapes

The shapes captcha requires just one image.

Example Image

Usage

The solution to the shapes captcha are two points that need to be clicked. To use it in the GUI, convert the proportions to pixel values based on the image size.

The points are returned as x and y proportions (0-1) of the width and height of the source image. The captcha image selector is .captcha-verify-image

Request Body

Required
shapesCaptchaImage*string (binary)

The uploaded image file

Responses

200Ok

Response Attributes

response*object
cached*boolean
code*number (double)
messagestring
||
Request
Response200

Complete puzzle captcha

POST/tiktok/captchas/puzzle

The puzzle captcha requires two images

Example Image

Usage

The solution to the puzzle captcha is the distance to move the slider to fit the puzzle piece into the background.

The backgroundImage is the full background image with the missing piece. The pieceImage is the small puzzle piece that needs to be fit into the background.

The captcha image selectors are:

  • Background: .captcha-verify-image
  • Piece: #captcha-verify-image ~ div.cap-absolute > img

The solution is the x proportion (0-1) of the width of the background image where the piece fits. It is 1:1 with the slider distance proportion.

Request Body

Required
backgroundImage*string (binary)

The uploaded background image file

pieceImage*string (binary)

The uploaded puzzle piece image file

Responses

200Ok

Response Attributes

response*object
cached*boolean
code*number (double)
messagestring
||
Request
Response200

Complete icon captcha

POST/tiktok/captchas/icons

The icons captcha requires just one image & a prompt string.

Example Image

Usage

The prompt is the text prompt provided by TikTok. The Icon captcha solution is provided as a list of points, where each point marks a location on the image that needs to be clicked. These points are expressed as ratios relative to the image's width and height. A point of (0.0, 0.0) corresponds to the image’s upper-left corner, while (1.0, 1.0) represents the lower-right corner. For reference, (0.5, 0.5) sits at the exact center.

The captcha image selector is .captcha-verify-image

Query Parameters

prompt*string

Request Body

Required
captchaImage*string (binary)

The uploaded image file

Responses

200Ok

Response Attributes

response*object
cached*boolean
code*number (double)
messagestring
||
Request
Response200