API Authentication

All DeepTagger API requests require authentication using an API key.

Getting an API Key

1. Log in to deeptagger.com
2. Go to Settings → API Keys
3. Click Generate New API Key
4. Copy and save the key securely

Keep it secret!

API keys provide full access to your account. Never share them publicly or commit them to version control.

Using the API Key

Include your API key in the x-api-key header with every request:

curl -X POST https://deeptagger.com/api/v1/extract_data \
  -H "x-api-key: YOUR_API_KEY" \
  -F "fo_id=fo_1759714105892" \
  -F "file=@document.pdf"

Authentication Errors

401 Unauthorized

Cause: Missing or invalid API key

Response:

{
  "status": "error",
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or missing API key"
  }
}

Solution: Verify your API key is correct and included in the request.

403 Forbidden

Cause: Valid API key but insufficient permissions

Solution: Check your account permissions or contact support.

Security Best Practices

• ✅ Store keys in environment variables
• ✅ Use HTTPS for all requests
• ✅ Rotate keys periodically
• ✅ Create separate keys for different environments
• ❌ Never hardcode keys in source code
• ❌ Don't share keys via email or chat
• ❌ Don't commit keys to version control

Revoking Keys

To revoke a compromised key:

1. Go to Settings → API Keys
2. Find the key in the list
3. Click Revoke or Delete
4. Generate a new key for your applications