getSoftID

getSoftID returns your developer ID (softID) and your accumulated developer revenue share (in CNY). When other people use your software or extension, include this ID in their createTask requests and you earn a share of what they spend. Rules and withdrawals: Developer revenue share.

POSThttps://api.yescaptcha.com/getSoftIDGlobal endpointCopy

POSThttps://cn.yescaptcha.com/getSoftIDChina endpointCopy

Request fields

Field	Type	Required	Description
clientKey	string	Yes	Your own (the developer’s) account key

{ "clientKey": "YOUR_CLIENT_KEY" }

Response

{ "errorId": 0, "softID": 3, "balance": 0.004 }

Field	Type	Description
softID	integer	Your developer ID
balance	number	Accumulated developer revenue share in CNY

How to use it

In the createTask requests sent by your software’s users, add the top-level field softID (next to clientKey and task; it is case-sensitive):

{
  "clientKey": "THE_USERS_CLIENT_KEY",
  "task": {
    "type": "ImageToTextTaskOcrBase",
    "body": "BASE64_IMAGE"
  },
  "softID": 3
}

clientKey is the user’s own key, and the points are charged to the user; softID is your developer ID.