APIAPI Keys

API Keys

/v1/api-keys·4 endpoints

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.

POST/v1/api-keysAuth

Create API Key

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

Parameter	Type	Required	Description
`name`	`string`	Required	Human-readable label (e.g. "Production", "FoxGuard Widget")
`scope`	`"full" \| "verify" \| "lists" \| "read-only"`	Optional · "full"	Permission scope. full = all endpoints, verify = email verification only, lists = list management only, read-only = GET requests only.
`ipRestrictions`	`string[]`	Optional · []	Allowlist of IP addresses. Empty array means no IP restriction.
`expiresInDays`	`number \| null`	Optional · null	Days until the key expires (1–365). null = never expires.

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.

Request

curl -X POST "https://api.verifox.ai/v1/api-keys" \
  -H "X-API-Key: vfx_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"name": "Production Key", "scope": "full", "ipRestrictions": [], "expiresInDays": null}'

Response

{
  "id": "key_abc123",
  "name": "Production Key",
  "prefix": "vfx_prod",
  "key": "vfx_prod_sk_live_abc123...",
  "scope": "full",
  "ipRestrictions": [],
  "expiresAt": null,
  "createdAt": "2026-03-31T10:30:00Z",
  "warning": "Store this key securely — it will not be shown again."
}

GET/v1/api-keysAuth

List API Keys

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

No parameters

Request

curl -X GET "https://api.verifox.ai/v1/api-keys" \
  -H "X-API-Key: vfx_your_api_key"

Response

[
  {
    "id": "key_abc123",
    "name": "Production Key",
    "prefix": "vfx_prod",
    "scope": "full",
    "ipRestrictions": [],
    "expiresAt": null,
    "lastUsedAt": "2026-03-31T09:00:00Z",
    "createdAt": "2026-03-01T10:00:00Z",
    "isRevoked": false
  }
]

GET/v1/api-keys/analyticsAuth

Key Usage Analytics

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

Query Parameters

Parameter	Type	Required	Description
`days`	`number`	Optional · 30	Lookback period in days (1–90).

daysnumberopt

Lookback period in days (1–90).

Request

curl -X GET "https://api.verifox.ai/v1/api-keys/analytics?days=30" \
  -H "X-API-Key: vfx_your_api_key"

Response

{
  "totalCalls": 15230,
  "dailyUsage": [
    { "date": "2026-03-31", "count": 520 },
    { "date": "2026-03-30", "count": 480 }
  ],
  "keys": [
    {
      "keyId": "key_abc123",
      "name": "Production Key",
      "prefix": "vfx_prod",
      "isRevoked": false,
      "totalCalls": 15230,
      "dailyUsage": [{ "date": "2026-03-31", "count": 520 }]
    }
  ]
}

DELETE/v1/api-keys/:idAuth

Revoke Key

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

Path Parameters

Parameter	Type	Required	Description
`id`	`string`	Required	API key ID (from list or create response)

idstring*

API key ID (from list or create response)

Request

curl -X DELETE "https://api.verifox.ai/v1/api-keys/key_abc123" \
  -H "X-API-Key: vfx_your_api_key"

Response

(204 No Content)