Standard error format & HTTP status codes: see the Error Codes guide.
- Retryable: 500, 502, 503, 504
- Not retryable: 400, 401, 403, 404, 409, 422
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Authentication Errors:
Authentication Errors:
Partner ──Any request (missing/invalid key)──> API
<── 401 Unauthorized { "detail": "Invalid API key" }
Action: Verify key, check expiration, re-onboard if needed
Validation Errors:
Partner ──POST /v2/onboard (invalid body)──> API
<── 422 { "errors": { "name": ["required"] } }
Action: Fix request payload per error details
Processing Failures:
Partner ──GET /v2/documents/{id}/status──> API
<── 200 OK { "status": "Failed", "errorMessage": "..." }
Action: Check error, fix document, re-submit
Attempt 1: Immediate
Attempt 2: Wait 1s
Attempt 3: Wait 5s
Attempt 4: Wait 30s
Max retries: 4
| Failure Point | Symptom | Recovery |
|---|---|---|
| Upload failed mid-transfer | No documentId returned | Retry full submission |
| Processing stuck | Status stays Processing for >30 min | Poll again; contact support if >1 hour |
| Partial item failure | Some items ProcessedWithError | Fetch results for successful items; re-submit for failed controls (Coming Soon via Re-analysis) |
| All items failed | Status = Failed | Check errorMessage; fix document; submit again |