API Reference · v1

Credits & Balance

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

Base URLapi.verifox.ai/v1AuthX-API-Key headerRate limit60 req/minFormatJSON over HTTPSLatency~380ms

Get Started Free
GET Auth

Get Balance

/v1/credits/balance

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

Try it

Credentials

This endpoint requires an API key. Enter one above to run it — create a key if you don't have one. Your key is used only for this request and is never stored.

1curl -X GET "https://api.verifox.ai/v1/credits/balance" \2  -H "X-API-Key: vfx_your_api_key"
1{2  "balance": 4850,3  "used": 150,4  "total": 5000,5  "flagged": false,6  "fraudWarning": null7}
GET Auth

Transaction History

/v1/credits/transactions

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.

Try it

Credentials

This endpoint requires an API key. Enter one above to run it — create a key if you don't have one. Your key is used only for this request and is never stored.

1curl -X GET "https://api.verifox.ai/v1/credits/transactions?limit=20&offset=0" \2  -H "X-API-Key: vfx_your_api_key"
1{2  "data": [3    {4      "id": "txn_abc",5      "type": "email_verify",6      "amount": -1,7      "description": "Email verification: john@example.com [valid]",8      "balanceAfter": 4849,9      "createdAt": "2026-03-31T10:30:00Z"10    },11    {12      "id": "txn_xyz",13      "type": "purchase",14      "amount": 5000,15      "description": "Top-up: Starter Plan",16      "balanceAfter": 5000,17      "createdAt": "2026-03-01T08:00:00Z"18    }19  ],20  "pagination": {21    "limit": 20,22    "offset": 023  }24}
GET Auth

Usage Statistics

/v1/credits/stats

Aggregated usage statistics for charts and dashboards — headline counts for the window, their percentage change against the preceding window, and four parallel daily series (one point per day, oldest first).

Query Parameters

daysnumberopt

Lookback window (1–90 days).

Try it

Credentials

This endpoint requires an API key. Enter one above to run it — create a key if you don't have one. Your key is used only for this request and is never stored.

1curl -X GET "https://api.verifox.ai/v1/credits/stats?days=14" \2  -H "X-API-Key: vfx_your_api_key"
1{2  "emailsVerified": 150,3  "validRate": 62,4  "apiCalls": 48,5  "emailsChange": 100,6  "validRateChange": 0,7  "apiCallsChange": 12,8  "creditsDailyUsage": [9    { "date": "2026-03-30", "count": 9 },10    { "date": "2026-03-31", "count": 12 }11  ],12  "emailsDailyUsage": [13    { "date": "2026-03-30", "count": 9 },14    { "date": "2026-03-31", "count": 12 }15  ],16  "validityDailyRate": [17    { "date": "2026-03-30", "count": 58 },18    { "date": "2026-03-31", "count": 62 }19  ],20  "apiCallsDailyUsage": [21    { "date": "2026-03-30", "count": 3 },22    { "date": "2026-03-31", "count": 5 }23  ]24}