Account & API Keys

Manage your account information, credits, and API keys programmatically.

Get Account Info

GET/v1/account

Retrieve your account details, credit balance, and usage statistics.

Response
{
  "success": true,
  "data": {
    "account": {
      "user_id": "user_a1b2c3d4e5f60718293a4b5c",
      "email": "user@example.com",
      "name": "John Doe",
      "plan": "professional",
      "status": "active",
      "created_at": "2025-06-15T10:00:00Z",
      "is_admin": false
    },
    "credits": {
      "balance": 24500,
      "used_this_month": 500,
      "monthly_allowance": 25000,
      "next_reset": "2026-03-01T00:00:00.000Z"
    },
    "usage": {
      "current_month": {
        "jobs_count": 12,
        "emails_verified": 4500,
        "emails_valid": 3800,
        "emails_invalid": 450,
        "emails_risky": 180,
        "emails_unknown": 70
      },
      "period": { "start": "2026-02-01", "end": "2026-02-28" }
    },
    "api_keys": [
      {
        "key_id": "key_1a2b3c4d5e6f7a8b",
        "name": "Production",
        "status": "active",
        "created_at": "2025-06-15T10:00:00Z",
        "last_used_at": "2026-02-03T14:30:00Z",
        "key_preview": "ev_****cdEf"
      }
    ],
    "recent_jobs": [
      {
        "job_id": "9f8f6d2e-4c1b-4f6e-9a3b-2d1e5c7a8b90",
        "status": "completed",
        "total_emails": 1000,
        "processed_emails": 1000,
        "progress_percent": 100,
        "created_at": "2026-02-03T14:30:00Z",
        "completed_at": "2026-02-03T14:35:42Z"
      }
    ],
    "rate_limits": {
      "requests_per_minute": 300,
      "concurrent_requests": 20,
      "enforced": false
    }
  }
}

monthly_allowancereflects your plan's credit grant: 100 (Free), 5,000 (Starter), 25,000 (Professional), 100,000 (Business), 500,000 (Enterprise).

List API Keys

GET/v1/api-keys

List all API keys associated with your account.

Response
{
  "success": true,
  "data": {
    "api_keys": [
      {
        "key_id": "key_1a2b3c4d5e6f7a8b",
        "name": "Production",
        "status": "active",
        "created_at": "2025-06-15T10:00:00Z",
        "last_used_at": "2026-02-03T14:30:00Z",
        "key_preview": "ev_****cdEf"
      },
      {
        "key_id": "key_9f8e7d6c5b4a3f2e",
        "name": "Development",
        "status": "active",
        "created_at": "2025-07-01T12:00:00Z",
        "last_used_at": null,
        "key_preview": "ev_****Xy12"
      }
    ]
  }
}

Create API Key

POST/v1/api-keys

Request Body

ParameterTypeRequiredDescription
namestringYesA name to identify this key

Important: The full API key is only shown once in the response. Store it securely.

Response
HTTP/1.1 201 Created

{
  "success": true,
  "data": {
    "api_key": {
      "key": "ev_aB3dE5fG7hJ9kL1mN3pQ5rS7tU9vW1xY",
      "key_id": "key_2b3c4d5e6f7a8b9c",
      "name": "Mobile App",
      "created_at": "2026-02-03T15:00:00Z",
      "warning": "Save this API key now. You will not be able to see it again."
    }
  }
}

Revoke API Key

DELETE/v1/api-keys/{key_id}

Permanently revoke an API key. This action cannot be undone.

Response
{
  "success": true,
  "data": {
    "message": "API key revoked successfully",
    "key_id": "key_2b3c4d5e6f7a8b9c"
  }
}

Credit Balance

Monitor your credit usage to ensure uninterrupted service.

Credit Consumption

  • 1 credit: Single email verification (cache miss)
  • 0.5 credits: Cached result (within 24 hours)
  • 1 credit: Each email in batch verification
  • Free: Job status checks, account info