APICredits & Balance
VerifoxVerifoxAPI

Base URLapi.verifox.ai

AuthX-API-Key

Versionv1

Credits & Balance

/v1/credits3 endpoints

Check your Fox Credits balance, view the transaction history for every deduction and top-up, and pull usage statistics for dashboard charts.

GET/v1/credits/balanceAuth

Get Balance

Return the current Fox Credits balance, total credits ever added, credits used, and any fraud warning flag on the account.

No parameters

curl -X GET "https://api.verifox.ai/v1/credits/balance" \
  -H "X-API-Key: vfx_your_api_key"
Response
{
  "balance": 4850,
  "used": 150,
  "total": 5000,
  "flagged": false,
  "fraudWarning": null
}
GET/v1/credits/transactionsAuth

Transaction History

Paginated list of every credit transaction — deductions for API calls and top-ups from purchases. Most recent first.

Query Parameters

limitnumberopt

Results per page (max 100).

offsetnumberopt

Number of records to skip for pagination.

curl -X GET "https://api.verifox.ai/v1/credits/transactions?limit=20&offset=0" \
  -H "X-API-Key: vfx_your_api_key"
Response
[
  {
    "id": "txn_abc",
    "type": "email_verify",
    "amount": -1,
    "description": "Email verification: john@example.com [valid]",
    "balanceAfter": 4849,
    "createdAt": "2026-03-31T10:30:00Z"
  },
  {
    "id": "txn_xyz",
    "type": "purchase",
    "amount": 5000,
    "description": "Top-up: Starter Plan",
    "balanceAfter": 5000,
    "createdAt": "2026-03-01T08:00:00Z"
  }
]
GET/v1/credits/statsAuth

Usage Statistics

Aggregated credit usage statistics for charts and dashboards — total used, daily breakdown, and usage by endpoint type.

Query Parameters

daysnumberopt

Lookback window (1–90 days).

curl -X GET "https://api.verifox.ai/v1/credits/stats?days=14" \
  -H "X-API-Key: vfx_your_api_key"
Response
{
  "totalUsed": 150,
  "dailyUsage": [
    { "date": "2026-03-31", "count": 12 },
    { "date": "2026-03-30", "count": 9 }
  ],
  "byType": {
    "email_verify": 100,
    "email_find": 50
  }
}