DocsAPI ReferenceErrors
API Errors Reference
Standard JSON error formats and complete HTTP response status code specifications.
Standard JSON Error Response
All failed requests return a consistent JSON payload containing a human-readable error summary and optional validation details:
json/error-response.json
{"error": "validation failed","details": "text must be between 10 and 5000 characters"}
HTTP Status Code Catalog
Comprehensive reference of HTTP status codes returned by the VeriLens API gateway:
| HTTP Status | Meaning | Common Trigger Scenarios |
|---|---|---|
| 200 OK | Success | Request processed successfully. |
| 201 Created | Resource Created | User registration or API key generation succeeded. |
| 400 Bad Request | Invalid Request | Malformed JSON, payload > 16 KB, or field validation error. |
| 401 Unauthorized | Authentication Required | Missing/invalid token, invalid credentials, or expired refresh token. |
| 402 Payment Required | Insufficient Credits | Attempting /predict/deep with a credit balance of 0. |
| 403 Forbidden | Access Denied | API key attempting to access JWT-restricted routes (e.g. /api-keys). |
| 404 Not Found | Not Found | Resource does not exist or user does not own the requested check ID. |
| 409 Conflict | Conflict | Email already registered or exceeded max 10 active API keys. |
| 429 Too Many Requests | Rate Limit Exceeded | Exceeded token bucket limit (1 req/sec) or account locked. |
| 500 Internal Error | Server Error | Unexpected internal server failure. |
| 503 Service Unavailable | Downstream Outage | IndoBERT model service or web crawler unreachable. |
