Claims
One claim with evidence, payouts and timeline
GET/claims/{claimId}
Scope claims.read
One claim with evidence, payouts and timeline
Request
Path parameters
| Name | In | Type | Description |
|---|---|---|---|
claimIdRequired | path | string | Pattern ^(?:QD-CLM-[A-F0-9]{24}|QDCLM[A-Z0-9]{3,31})$ |
Response
| Status | Meaning |
|---|---|
200 | The claim |
The body is { "status": "success", "data": … }. Fields of data (ClaimResult):
| Field | Type | Description |
|---|---|---|
claimRequired | Claim | A parcel claim. Internal liability findings and staff names are never returned. |
Errors
Errors use the error envelope { "status": "error", "message", "code"?, "details"? }.
| Status | When |
|---|---|
401 | Missing, invalid, expired or revoked API key. The API key is missing, invalid, expired or revoked. |
403 | The key lacks the scope, or the operation needs a LIVE key. The key lacks the scope, or this call needs a LIVE key (LIVE_KEY_REQUIRED), or the Business owner is not verified (SENDER_VERIFICATION_REQUIRED). |
404 | Not found for this Business and environment. IDs from another Business or environment are always 404. Not found for this Business and environment. IDs from another Business or the other environment are always 404. |
429 | Too many requests. See the RateLimit headers. Too many requests. Wait for Retry-After, then retry with the same idempotency key. |