ShopeeSliderWebTask

Shopee slider captcha is a common image challenge. The user has to drag a small puzzle piece to the correct position on the background image.

ShopeeSliderWebTask supports two modes:

Regular slider — drag horizontally (returns end coordinates).
Undetermined trajectory (typeCaptcha = "rotate") — drag along an arbitrary path (returns point).

1a. Create task — Regular slider

Request

POST https://api.omocaptcha.com/v2/createTask

Parameter	Type	Required	Description
`clientKey`	`String`	✅	Client API key
`task.type`	`String`	✅	Captcha service class name (`ShopeeSliderWebTask`)
`task.imageBase64s`	`Array of String`	✅	Array of 2 base64 strings: [mask image, background image]

Code samples

curl -X POST https://api.omocaptcha.com/v2/createTask \
  -H "Content-Type: application/json" \
  -d '{
    "clientKey": "OMO_API_KEY",
    "task": {
      "type": "ShopeeSliderWebTask",
      "imageBase64s": [
        "BASE64_MASK_BODY_HERE",
        "BASE64_BACKGROUND_BODY_HERE"
      ]
    }
  }'

const axios = require('axios');

const { data } = await axios.post('https://api.omocaptcha.com/v2/createTask', {
  clientKey: 'OMO_API_KEY',
  task: {
    type: 'ShopeeSliderWebTask',
    imageBase64s: [
      'BASE64_MASK_BODY_HERE',
      'BASE64_BACKGROUND_BODY_HERE',
    ],
  },
});

console.log(data);

import requests

resp = requests.post('https://api.omocaptcha.com/v2/createTask', json={
    'clientKey': 'OMO_API_KEY',
    'task': {
        'type': 'ShopeeSliderWebTask',
        'imageBase64s': [
            'BASE64_MASK_BODY_HERE',
            'BASE64_BACKGROUND_BODY_HERE',
        ],
    },
})

print(resp.json())

<?php
$ch = curl_init('https://api.omocaptcha.com/v2/createTask');
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
    'clientKey' => 'OMO_API_KEY',
    'task' => [
        'type' => 'ShopeeSliderWebTask',
        'imageBase64s' => [
            'BASE64_MASK_BODY_HERE',
            'BASE64_BACKGROUND_BODY_HERE',
        ],
    ],
]));

$response = curl_exec($ch);
curl_close($ch);
echo $response;

Response

Success:

{
  "errorId": 0,
  "taskId": "49f9f60a-c809-4af0-93c0-0409b72e67e0"
}

The server returns errorId = 0 and taskId on success.

1b. Create task — Undetermined trajectory

Used when the captcha requires dragging along an arbitrary path (not restricted to horizontal). Add typeCaptcha = "rotate".

Example of Shopee undetermined-trajectory captcha

Request

POST https://api.omocaptcha.com/v2/createTask

Parameter	Type	Required	Description
`clientKey`	`String`	✅	Client API key
`task.type`	`String`	✅	Captcha service class name (`ShopeeSliderWebTask`)
`task.typeCaptcha`	`String`	✅	Captcha type, value: `rotate`
`task.imageBase64s`	`Array of String`	✅	Array of 2 base64 strings: [mask image, background image]

Code samples

curl -X POST https://api.omocaptcha.com/v2/createTask \
  -H "Content-Type: application/json" \
  -d '{
    "clientKey": "OMO_API_KEY",
    "task": {
      "type": "ShopeeSliderWebTask",
      "typeCaptcha": "rotate",
      "imageBase64s": [
        "BASE64_MASK_BODY_HERE",
        "BASE64_BACKGROUND_BODY_HERE"
      ]
    }
  }'

const axios = require('axios');

const { data } = await axios.post('https://api.omocaptcha.com/v2/createTask', {
  clientKey: 'OMO_API_KEY',
  task: {
    type: 'ShopeeSliderWebTask',
    typeCaptcha: 'rotate',
    imageBase64s: [
      'BASE64_MASK_BODY_HERE',
      'BASE64_BACKGROUND_BODY_HERE',
    ],
  },
});

console.log(data);

import requests

resp = requests.post('https://api.omocaptcha.com/v2/createTask', json={
    'clientKey': 'OMO_API_KEY',
    'task': {
        'type': 'ShopeeSliderWebTask',
        'typeCaptcha': 'rotate',
        'imageBase64s': [
            'BASE64_MASK_BODY_HERE',
            'BASE64_BACKGROUND_BODY_HERE',
        ],
    },
})

print(resp.json())

<?php
$ch = curl_init('https://api.omocaptcha.com/v2/createTask');
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
    'clientKey' => 'OMO_API_KEY',
    'task' => [
        'type' => 'ShopeeSliderWebTask',
        'typeCaptcha' => 'rotate',
        'imageBase64s' => [
            'BASE64_MASK_BODY_HERE',
            'BASE64_BACKGROUND_BODY_HERE',
        ],
    ],
]));

$response = curl_exec($ch);
curl_close($ch);
echo $response;

Response

Success:

{
  "errorId": 0,
  "taskId": "49f9f60a-c809-4af0-93c0-0409b72e67e0"
}

Failure:

{
  "errorId": 1,
  "errorCode": "",
  "errorDescription": ""
}

The server returns errorId = 1 and the corresponding errorCode. See the Error codes list.

2a. Get task result — Regular slider

Request

POST https://api.omocaptcha.com/v2/getTaskResult

{
  "clientKey": "OMO_API_KEY",
  "taskId": "49f9f60a-c809-4af0-93c0-0409b72e67e0"
}

Response

Success:

{
  "errorId": 0,
  "status": "ready",
  "solution": {
    "end": {
      "x": 150,
      "y": 42
    }
  }
}

Field	Type	Description
`solution.end.x`	Number	X coordinate to drag the puzzle piece to (px)
`solution.end.y`	Number	Y coordinate to drag the puzzle piece to (px)

2b. Get task result — Undetermined trajectory

Request

POST https://api.omocaptcha.com/v2/getTaskResult

{
  "clientKey": "OMO_API_KEY",
  "taskId": "49f9f60a-c809-4af0-93c0-0409b72e67e0"
}

Response

Success:

{
  "errorId": 0,
  "status": "ready",
  "solution": {
    "point": {
      "x": 153,
      "y": 78
    }
  }
}

Field	Type	Description
`solution.point.x`	Number	X target coordinate to move the puzzle piece to (px)
`solution.point.y`	Number	Y target coordinate to move the puzzle piece to (px)

Coordinates are in the pixel space of the uploaded background image. Combine the starting position of the puzzle piece with the returned coordinate to compute the path, then simulate the drag gesture (mousedown → mousemove → mouseup) along a natural trajectory.

Processing:

{
  "errorId": 0,
  "status": "processing",
  "errorCode": "",
  "errorDescription": ""
}

The server returns errorId = 0 and status = processing. Wait 2 seconds then retry. Failure:

{
  "errorId": 1,
  "errorCode": "ERROR_JOB_STATUS",
  "errorDescription": "Job failed",
  "status": "fail",
  "solution": {}
}

The server returns errorId = 1. See details at Error codes.

API Reference

Guides

1a. Create task — Regular slider

Request

Code samples

Response

1b. Create task — Undetermined trajectory

Request

Code samples

Response

2a. Get task result — Regular slider

Request

Response

2b. Get task result — Undetermined trajectory

Request

Response

​1a. Create task — Regular slider

​Request

​Code samples

​Response

​1b. Create task — Undetermined trajectory

​Request

​Code samples

​Response

​2a. Get task result — Regular slider

​Request

​Response

​2b. Get task result — Undetermined trajectory

​Request

​Response

1a. Create task — Regular slider

Request

Code samples

Response

1b. Create task — Undetermined trajectory

Request

Code samples

Response

2a. Get task result — Regular slider

Request

Response

2b. Get task result — Undetermined trajectory

Request

Response