Get Balance API | Solverify

Check your Solverify API account balance with the getBalance endpoint. This request returns the available credit associated with your API key without creating a CAPTCHA task.

Use POST /getBalance before submitting tasks to monitor available credit, display balance information in your application, or avoid task failures caused by insufficient funds.

The API key must be provided as clientKey in the JSON request body.

Request Body

{
  "clientKey": "YOUR_API_KEY"
}

Field	Type	Required	Description
`clientKey`	string	Yes	Your Solverify API key. Keep this value private and only send it from trusted server-side code.

Success Response

A successful balance request returns errorId: 0 and the current account balance:

{
  "errorId": 0,
  "balance": 5.1225,
  "errorCode": null,
  "errorDescription": null
}

Response Fields

Field	Type	Description
`errorId`	number	`0` indicates that the request succeeded.
`balance`	number	Current balance available for the supplied API key.
`errorCode`	string or null	Machine-readable error code when the request fails.
`errorDescription`	string or null	Human-readable information about the error.

Get Balance Code Examples

Replace YOUR_API_KEY with your Solverify API key. API keys should not be exposed in browser-side JavaScript or committed to source control.

curl --request POST \
  --url https://solver.solverify.net/getBalance \
  --header "Content-Type: application/json" \
  --data '{"clientKey":"YOUR_API_KEY"}'

Possible Get Balance Errors

Error code	Description
`ERROR_INVALID_REQUEST`	The request body is missing required fields or contains invalid JSON.
`ERROR_INVALID_KEY`	The supplied Solverify API key is invalid.
`ERROR_USER_NOT_FOUND`	The API key exists, but its associated account could not be found.

Always inspect errorId before using the balance value. When errorId is not 0, use errorCode and errorDescription to identify the problem.

For every supported API error, see Solverify API Error Codes.

When Should You Check Your Balance?

Check the Solverify account balance:

Before starting a large batch of CAPTCHA tasks.
Before increasing task concurrency.
When displaying account credit in an internal dashboard.
After adding funds to confirm the updated balance.
When task creation fails because of insufficient funds.

Avoid requesting the balance before every task. For high-volume applications, cache the result briefly and refresh it at a reasonable interval.

Frequently Asked Questions

Does `getBalance` create a CAPTCHA task?

No. The endpoint only retrieves the current balance associated with the supplied API key.

Why is the balance missing from the response?

Inspect errorId, errorCode, and errorDescription. The API key may be missing, invalid, or associated with an unavailable account.