Errors & Status Codes
Predictable JSON error responses and machine-readable error codes.
| HTTP Status | Error Code | Description |
|---|---|---|
| 401 | AUTH_KEY_MISSING | Authorization header or x-api-key was not provided. |
| 401 | AUTH_KEY_INVALID | API key is invalid, malformed, or has been revoked. |
| 403 | INSUFFICIENT_SCOPE | API key does not have the required permission scope for this action. |
| 403 | API_ACCESS_REQUIRES_PAID_PLAN | REST API access is available on paid plans (Pro and Business). Upgrade to use the API. |
| 429 | RATE_LIMIT_EXCEEDED | Request limit exceeded (30 req/min for Pro, 60 req/min for Business). Implement exponential backoff. |
| 402 | CREDIT_QUOTA_EXHAUSTED | Workspace QR Credits are at zero. Top up or wait for next billing cycle. |
| 404 | NOT_FOUND | Requested QR code or document was not found in this workspace. |
| 400 | BAD_REQUEST | Required parameters (e.g. targetUrl) missing or invalid format. |