# getSoftID

> POST /getSoftID returns your developer ID (softID) and accumulated revenue share. Put the softID in the createTask requests your software sends for other users to earn a share.

Source: https://docs.yescaptcha.com/en/api/get-soft-id/ · Last verified: 2026-10-15

`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](https://docs.yescaptcha.com/en/account/developer/).

- POST `https://api.yescaptcha.com/getSoftID` (Global endpoint)
- POST `https://cn.yescaptcha.com/getSoftID` (China endpoint)

## Request fields

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

```json
{ "clientKey": "YOUR_CLIENT_KEY" }
```

## Response

```json
{ "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):

```json
{
  "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.
