Settle a claim
Workforce module
POST/lost-found-claims/{id}/settlelostFoundClaims.settle
Returns the item to the verified claimant, or rejects the claim with a reason. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.
- Requires the capability safety.incident.close.
- OAuth scopes: safety.
- Send an Idempotency-Key header. A replay with the same key returns the original response.
- Error statuses: 400, 401, 404, 409, 422, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the lost found claim. |
Request body: SettleClaimRequest
| Field | Type | Required | Description |
|---|---|---|---|
| returned | boolean | Yes | Returned (true) or rejected (false). |
| note | string | No | Note; required to reject.Constraints: length 1 to 500 |
{
"returned": true,
"note": "ID matched."
}Response 200: LostFoundClaim
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the lost found claim. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Person who created the row; null for seed, platform or system writes. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Person who last updated the row; null for seed, platform or system writes. |
| lost_found_item_id | string (uuid) | Yes | Identifier of the item claimed. |
| claimant_name | string | Yes | Claimant.Constraints: length 1 to 200 |
| claimant_contact | string | Yes | Claimant phone or email.Constraints: length 1 to 200 |
| proof_description | string | Yes | How they proved it.Constraints: length 1 to 1000 |
| recorded_by_membership_id | string (uuid) | null | Yes | Identifier of the member who took the claim. |
| decided_by_membership_id | string (uuid) | null | Yes | Identifier of the member who settled it. |
| decided_at | string (date-time) | null | Yes | When it was settled. |
| returned | boolean | null | Yes | True when returned, false when rejected. |
| decision_note | string | null | Yes | Why rejected, or a return note.Constraints: length 1 to 500 |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"lost_found_item_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"claimant_name": "Riley Park",
"claimant_contact": "+1 305 555 0142",
"proof_description": "Named the card inside.",
"recorded_by_membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"decided_by_membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"decided_at": "2026-10-08T14:30:00Z",
"returned": true,
"decision_note": "ID matched."
}Code samples
curl -X POST "$XOS_BASE_URL/lost-found-claims/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/settle" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"returned":true,"note":"ID matched."}'const { data } = await xos.lostFoundClaims.settle("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
"returned": true,
"note": "ID matched."
});response = xos.lost_found_claims.settle("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"returned": True, "note": "ID matched."})xos lost-found-claims settle 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"returned":true,"note":"ID matched."}'