Getting Started

Authentication

All API requests require authentication using an API key. Include your API key in the request header.

API Key Header

Include your API key in the X-API-Key header with every request.

bash
curl -X POST https://your-domain.com/api/mrz/scan \
  -H "X-API-Key: ds_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{"imageUrl": "https://..."}'

Get your API key: Sign up at Dashboard to generate your API key.

Error Responses

If authentication fails, you will receive one of these error responses:

401Missing API Key
json
{ "error": "API key is required" }
401Invalid API Key
json
{ "error": "Invalid or inactive API key" }

Security Best Practices

  • Never expose your API key in client-side code or public repositories
  • Use environment variables to store your API key
  • Rotate your API keys periodically
  • Monitor your usage in the dashboard for suspicious activity