API Reference · v1

API Keys

Create and manage API keys for authenticating requests. Each key has a scope, optional IP restrictions, and an expiry. The full key is shown only once on creation — store it securely.

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

Get Started Free
POST Auth

Create API Key

/v1/api-keys

Create a new API key. The full key value is returned only in this response — it cannot be retrieved again. Copy and store it securely (e.g. in an environment variable).

Request Body

namestring*

Human-readable label (e.g. "Production", "FoxGuard Widget")

scope"full" | "verify" | "lists" | "read-only"opt

Permission scope. full = all endpoints, verify = email verification only, lists = list management only, read-only = GET requests only.

ipRestrictionsstring[]opt

Allowlist of IP addresses. Empty array means no IP restriction.

expiresInDaysnumber | nullopt

Days until the key expires (1–365). null = never expires.

1curl -X POST "https://api.verifox.ai/v1/api-keys" \2  -H "X-API-Key: vfx_your_api_key" \3  -H "Content-Type: application/json" \4  -d '{"name": "Production Key", "scope": "full", "ipRestrictions": [], "expiresInDays": null}'
200 - Response
1{2  "id": "key_abc123",3  "name": "Production Key",4  "prefix": "vfx_prod",5  "key": "vfx_prod_sk_live_abc123...",6  "scope": "full",7  "ipRestrictions": [],8  "expiresAt": null,9  "createdAt": "2026-03-31T10:30:00Z",10  "warning": "Store this key securely — it will not be shown again."11}
GET Auth

List API Keys

/v1/api-keys

Return all API keys for the authenticated account. The full key value is never returned — only the prefix and metadata.

1curl -X GET "https://api.verifox.ai/v1/api-keys" \2  -H "X-API-Key: vfx_your_api_key"
200 - Response
1[2  {3    "id": "key_abc123",4    "name": "Production Key",5    "prefix": "vfx_prod",6    "scope": "full",7    "ipRestrictions": [],8    "expiresAt": null,9    "lastUsedAt": "2026-03-31T09:00:00Z",10    "createdAt": "2026-03-01T10:00:00Z",11    "isRevoked": false12  }13]
GET Auth

Key Usage Analytics

/v1/api-keys/analytics

Retrieve call history and daily usage breakdown for all API keys over a given period.

Query Parameters

daysnumberopt

Lookback period in days (1–90).

1curl -X GET "https://api.verifox.ai/v1/api-keys/analytics?days=30" \2  -H "X-API-Key: vfx_your_api_key"
200 - Response
1{2  "totalCalls": 15230,3  "dailyUsage": [4    { "date": "2026-03-31", "count": 520 },5    { "date": "2026-03-30", "count": 480 }6  ],7  "keys": [8    {9      "keyId": "key_abc123",10      "name": "Production Key",11      "prefix": "vfx_prod",12      "isRevoked": false,13      "totalCalls": 15230,14      "dailyUsage": [{ "date": "2026-03-31", "count": 520 }]15    }16  ]17}
DELETE Auth

Revoke Key

/v1/api-keys/:id

Permanently revoke an API key. Any requests using this key will immediately return 401 Unauthorized. This action cannot be undone.

Path Parameters

idstring*

API key ID (from list or create response)

1curl -X DELETE "https://api.verifox.ai/v1/api-keys/key_abc123" \2  -H "X-API-Key: vfx_your_api_key"
204 - Response
1(204 No Content)