API Reference
Interactive OpenAPI 3.1 reference. Click any endpoint to inspect the schema, copy a snippet, or run the request against the live API with your own key.
Base URL & versioning
Every endpoint lives under the versioned base URL. The machine-readable OpenAPI 3.1 specification is available for download; the interactive console below renders it in full.
https://api.claimscan.io/v1- OpenAPI spec:
https://api.claimscan.io/v1/openapi.json
Authentication
Every request carries an API key as a Bearer token. Keys come in live and test environments and carry a space-separated list of scopes (e.g. analyze, account:read). Each endpoint advertises the scope it requires.
Authorization: Bearer csk_live_EXAMPLE_EXAMPLE_EXAMEndpoints
| Method | Path | Scope | Description |
|---|---|---|---|
GET | /v1/ping | — | Latency / liveness probe. |
GET | /v1/auth/whoami | — | Identity behind the current API key: key id, environment, scopes, tenant and plan. |
GET | /v1/account | account:read | Tenant plan and current billing period. |
GET | /v1/account/usage | account:read | Analyses consumed in the current billing period. |
POST | /v1/analyze | analyze | Analyse one image — returns a forensic verdict, a confidence score and an ordered list of findings. |
Idempotency
Send an Idempotency-Key header (any client-chosen string ≤ 255 chars) on every POST. A retried request with the same key returns the original result; a different body under the same key returns 409.
Error catalog
400— Invalid request (missing / malformed image).401— Missing or invalid API key.402— Monthly quota exhausted (quota_exceeded).403— Key lacks the required scope (insufficient_scope).409— Idempotency-Key reused with a different body.413— Image larger than the upload limit.422— Decoded image > 100 MP (decompression-bomb guard).429— Rate limit exceeded — RateLimit-* headers carry the budget.
Rate limits
Per API key per minute, by plan. Exceeding the budget returns 429 with RateLimit-* headers.
| Plan | Requests / minute |
|---|---|
| Free | 10 |
| Solo | 30 |
| Starter | 60 |
| Growth | 300 |
| Enterprise | 1000 |
Interactive console
The full, always-current reference with a try-it console loads directly below this section from the live OpenAPI specification.