Resellers API Reference
Introduction
Requirements
- CAPTCHAs.IO Reseller Account - Register and create an account at https://app.captchas.io/reseller/onboard/ .
- Paddle.com - Paddle.com is free to join and a very convenient payment solution.
Features
- Pay as you go payment scheme.
- Unlimited daily solving.
- Supports image, reCAPTCHA, and audio captchas.
-
Base price rate:
- reCAPTCHA: $1 per 1000 solves
- Image: $0.5 per 1000 solves
- Audio: $0.7 per 1000 solves
Scheme
- HTTP
RecognitionImage, Audio, & reCAPTCHA
Parameters
| Name | Description |
|---|---|
file *
(the captcha file) |
The CAPTCHA file uploaded to the server for recognition. @/path/to/the/image/captcha.png |
key *
(reseller key) |
Your reseller key found in the dashboard. rs-4b9bc8bc-5d6510a6273f61.44790017 |
| Code | Description |
| 200 | successful operation OK|0.0142|f84D4Q88 |
Parameters
| Name | Description |
|---|---|
key *
(reseller key) |
Your reseller key found in the dashboard. rs-4b9bc8bc-5d6510a6273f61.44790017 |
googlekey *
(google sitekey) |
The Google reCAPTCHA data-sitekey value. 6LdEiHEUAAAAAAyyS8r6mz1WvWmHBm1_dU-cRTu_ |
pageurl *
(page URL) |
The page URL of the website containing the reCAPTCHA. https://www.emeraldchat.com/ |
version *
(reCAPTCHA Version) |
The reCAPTCHA version. Possible values v2, v3 & invisible. v2 |
min_score *
(minimum score) |
The reCAPTCHA minimum score. 0.5 - Default: 0.1 ... 0.3 ... 0.5 ... 0.9 0.5 |
| Code | Description |
| 200 | successful operation OK|4.7185|b351e6b6 b351e6b6 is the captcha_id which should used for recaptcha_result requests. See below...
|
Parameters
| Name | Description |
|---|---|
key *
(reseller key) |
Your reseller key found in the dashboard. rs-4b9bc8bc-5d6510a6273f61.44790017 |
captcha_id *
(task captcha ID) |
The CAPTCHA ID taken from recaptcha_task response as seen above. b351e6b6 |
| Code | Description |
| 200 | successful operation OK|13.4451|03AOLTBLTZISIAe1of3o_2b2COkiAe-G5dEXvmtzXBuuSQYR926bGk-pSCOBr67VsdRYfy-S7Gz3CDZ8hl1jwAq-UssoSnLFJ9EXrMMAC5XRBkxlhi5X_wJ8Qzafq1ZRUDl7JT4cwtzy1exkPhWMnpJE7lI2JJnhx_pz_8MpDdbIGLTcvQsrqNvcIHEirbQJ951f18J-lRxJ0oViuiJtMyOZJQm4uf3IMv_kdynRTi18mht3qeC47enq24FAixuXtMB-Gw-p7pA1UawpsJe2n7z9qd_foViX88sBvabSNPeGXfjdpPYOArTChgJUj7yJ_jKCp-yYzsk1sEVxtE39cikAmOYIxxYmtO8XXYJrvL2J6KqlVjePXXZE3JVgPqXMX00Cm5L0qFtQkUXrgFuPddem8Jr3W9lrW6KA |
Parameters
| Name | Description |
|---|---|
file *
(audio captcha file) |
The audio CAPTCHA file uploaded to the server for recognition. @/path/to/the/audio/captcha.wav |
key *
(reseller key) |
Your reseller key found in the dashboard. rs-4b9bc8bc-5d6510a6273f61.44790017 |
| Code | Description |
| 200 | successful operation OK|0.4152|10984756734 |
PaymentsCreate and Pay Orders
This payment API uses Paddle.com as payment processor. You may use your own payment processors.
Parameters
| Name | Description |
|---|---|
key *
(reseller key) |
Your reseller key found in the dashboard. rs-4b9bc8bc-5d6510a6273f61.44790017 |
order_id *
(the order ID)
|
Order ID taken from create_order endpoint. J0IUHJVZ |
Responses
| Code | Description |
| 200 | successful operation https://pay.captchas.io/resellers/J0IUHJVZ Payment URL for customer to pay.
|
Parameters
| Name | Description |
|---|---|
key *
(reseller key) |
Reseller key found in the dashboard. rs-4b9bc8bc-5d6510a6273f61.44790017 |
user_id *
(user ID)
|
User ID found in `users` table. usr-7b4ac9dc-9j6210k6f7sf35.781w0017 |
product_name *
(name of the product)
|
Custom product name. Company Package #1 |
price *
(the price)
|
Custom product price. 48.50 |
currency *
(the currency)
|
Custom product price currency. USD |
image_url *
(product image URL)
|
Product's custom image URL. https://example.com/image/product/a.png |
payment_method *
(the payment method)
|
Payment method of order. We have Paddle.com only at the moment. Soon we can have PayPal and etc... paddle |
Responses
| Code | Description |
| 200 | successful operation https://pay.captchas.io/resellers/J0IUHJVZ |
Users Creation, Updating, Listing, & Statistics
Parameters
| Name | Description |
|---|---|
|
key *
(reseller key)
|
Your reseller key found in the dashboard. rs-4b9bc8bc-5d6510a6273f61.44790017 |
Responses
| Code | Description |
| 200 |
successful operation 327.51 |
Parameters
| Name | Description |
|---|---|
|
key *
(reseller key)
|
Your reseller key found in the dashboard. rs-4b9bc8bc-5d6510a6273f61.44790017 |
|
user_id *
(user ID)
|
User ID found in `users` table. usr-7b4ac9dc-9j6210k6f7sf35.781w0017 |
Responses
| Code | Description |
| 200 |
successful operation 34.51 |
Parameters
| Name | Description |
|---|---|
|
key *
(reseller key)
|
Your reseller key found in the dashboard. rs-4b9bc8bc-5d6510a6273f61.44790017 |
|
email *
(email address)
|
User's email address. user@example.com |
|
password *
(user password)
|
User's password in text format. MyPassword123 |
|
name *
(user name)
|
User's complete name in text format. My Name User |
|
ip *
(IP address)
|
User's unique IP address. 11.6.32.1 |
Responses
| Code | Description |
| 200 |
successful operation |
Parameters
| Name | Description |
|---|---|
|
key *
(reseller key)
|
Your reseller key found in the dashboard. rs-4b9bc8bc-5d6510a6273f61.44790017 |
|
user_id *
(user ID)
|
User's ID found in database. usr-7b4ac9dc-9j6210k6f7sf35.781w0017 |
|
password *
(user password)
|
User's password in text format. MyPassword123 |
|
name *
(user name)
|
User's complete name in text format. My Name User |
|
credits *
(user credits)
|
User's account credit balance. 563.2 |
Responses
| Code | Description |
| 200 |
successful operation |
Parameters
| Name | Description |
|---|---|
|
key *
(reseller key)
|
Your reseller key found in the dashboard. rs-4b9bc8bc-5d6510a6273f61.44790017 |
Responses
| Code | Description |
| 200 |
successful operation
[
{
"total": 2
},
{
"id": "usr-5d81h7a48bdbg1.347h4081",
"email": "user1@example.com",
"credits": 12.45,
"name": "Example User1",
"key": "5d81h7a48bdbg1.347h4081"
},
{
"id": "usr-1c81h4a49bdbg1.843h4081",
"email": "user2@example.com",
"credits": 562.45,
"name": "Example User2",
"key": "1c81h4a49bdbg1.843h4081"
}
]
|
Parameters
| Name | Description |
|---|---|
|
key *
(reseller key)
|
Your reseller key found in the dashboard. rs-4b9bc8bc-5d6510a6273f61.44790017 |
|
user_key *
(user API key)
|
The user's API key. 5d81h7a48bdbg1.347h4081 |
Responses
| Code | Description |
| 200 |
successful operation
[
{
"id": "usr-5d81h7a48bdbg1.347h4081",
"email": "user1@example.com",
"password": "MyPassword123",
"credits": 12.45,
"name": "Example User1",
"key": "5d81h7a48bdbg1.347h4081"
}
]
|