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.

1curl -X GET "https://api.verifox.ai/v1/credits/balance" \2  -H "X-API-Key: vfx_your_api_key"
200 - Response
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.

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

Usage Statistics

/v1/credits/stats

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).

1curl -X GET "https://api.verifox.ai/v1/credits/stats?days=14" \2  -H "X-API-Key: vfx_your_api_key"
200 - Response
1{2  "totalUsed": 150,3  "dailyUsage": [4    { "date": "2026-03-31", "count": 12 },5    { "date": "2026-03-30", "count": 9 }6  ],7  "byType": {8    "email_verify": 100,9    "email_find": 5010  }11}