Authentication

Learn how to authenticate your requests to the DocScanner API using an API key.

The DocScanner API uses API key authentication. Each request must include your API key in thex-api-key header.

You can generate and manage your API keys from the Dashboard or the Subscription page after activating a plan.

curl -X POST "/api/v1/documents/upload_files" \
  -H "x-api-key: YOUR_API_KEY_HERE" \
  -F "files[]=@/path/to/file1.pdf" \
  -F "files[]=@/path/to/file2.jpg" \
  -F "files[]=@/path/to/file3.png"

Keeping Your API Key Secure

• Never expose your API key in frontend or client-side code
• Store keys securely using environment variables
• Rotate your API keys if you believe they have been compromised
• Do not share your key publicly or commit it to version control

Authentication Errors

{
    "status": 401,
    "message": "API key required for API access",
    "result": null
}