Authentication

All HirePlus API requests require authentication via an API key passed in the x-api-key header.

Getting Your API Key

1. Sign in to your Dashboard
2. Navigate to Settings → API Keys
3. Click Create API Key and give it a descriptive name
4. Copy and securely store your key — it won't be shown again

Using Your API Key

Include the key in every request (base URL: https://hireplus.ai/api/v1):

export HIREPLUS_BASE_URL="https://$(HIREPLUS_DOMAIN)/api/v1"

curl -X POST $HIREPLUS_BASE_URL/analyses \
  -H "x-api-key: hp_abc123..."

Key Format

API keys follow the format:

hp_<random-string>

Security Best Practices

• Never expose API keys in client-side code or public repositories
• Rotate keys regularly from the Dashboard
• Use environment variables to store keys in your application:

# .env
HIREPLUS_API_KEY=hp_abc123...

const response = await fetch('https://your-app.com/api/v1/analyses', {
  method: 'POST',
  headers: {
    'x-api-key': process.env.HIREPLUS_API_KEY!,
  },
  body: formData,
});

API Key Permissions

Each API key inherits the permissions of the account that created it. All plans (Free through Business) have access to all API endpoints. The plan tier determines your monthly call cap and per-call credit cost.

Revoking Keys

You can revoke any API key immediately from Settings → API Keys. Revoked keys return a 401 Unauthorized response.