Enterprise API
Bearer-token API for automated supplier, contract and archive PDF checks. MVP documents the contract; production sale waits for approval.
Authentication
Authorization: Bearer API_KEY
Endpoints
POST /api/v1/checks
GET /api/v1/checks/{request_id}
GET /api/v1/checks/{request_id}/report
404 not_found
422 validation_error
POST /api/v1/checks
Submit a PDF check
Errors
- 400 invalid_file: The file is not a readable PDF or cannot be accessed.
- 401 unauthorized: API key is missing, invalid, or revoked.
- 413 file_too_large: The uploaded file exceeds the current size limit.
- 422 validation_error: Invalid checks parameter, or file and file_url were both missing or both provided.
- 429 rate_limited: The request rate is above the allowed plan limit.
- 500 engine_error: The checking engine could not complete the request.
GET /api/v1/checks/{request_id}
Get task status and summary
Errors
- 401 unauthorized: API key is missing, invalid, or revoked.
- 404 not_found: The request_id does not exist or does not belong to the current account.
- 422 validation_error: The request_id format is invalid.
- 429 rate_limited: Status polling is too frequent.
- 500 engine_error: Status lookup or result loading failed.
GET /api/v1/checks/{request_id}/report
Get a JSON or PDF report link
Errors
- 401 unauthorized: API key is missing, invalid, or revoked.
- 404 not_found: The request_id does not exist, the report is not generated, or the report expired.
- 422 validation_error: The request_id or format parameter is invalid.
- 429 rate_limited: Report download is too frequent.
- 500 engine_error: Report generation or loading failed.
GET /api/v1/usage
Get API quota and usage
Errors
- 401 unauthorized: API key is missing, invalid, or revoked.
- 404 not_found: The account or plan does not exist.
- 422 validation_error: The query parameter format is invalid.
- 429 rate_limited: Usage lookup is too frequent.
- 500 engine_error: Usage statistics could not be loaded.
POST /api/v1/webhooks/test
Test an enterprise webhook
Errors
- 401 unauthorized: API key is missing, invalid, or revoked.
- 404 not_found: The webhook configuration does not exist.
- 422 validation_error: The webhook_url or event type is invalid.
- 429 rate_limited: Webhook test is too frequent.
- 500 engine_error: Webhook test delivery failed.
Example submit
POST /api/v1/checks
checks=structure,pdfa,metadata
→ 202 {"request_id":"chk_...","status":"queued"}