Record a claim

Módulo Workforce

POST/lost-found-items/{id}/claimlostFoundItems.claim

Records a claim on a held item with the claimant's name, contact and proof. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.

Requiere la capacidad safety.incident.write.
Alcances de OAuth: safety.
Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
Estados de error: 400, 401, 404, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

lostFoundItems.claim: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the lost found item.

Cuerpo de la solicitud: LostItemClaimRequest

lostFoundItems.claim: LostItemClaimRequest
Campo	Tipo	Obligatorio	Descripción
claimant_name	string	Sí	Claimant.Restricciones: length 1 to 200
claimant_contact	string	Sí	Phone or email.Restricciones: length 3 to 200
proof_description	string	Sí	Proof.Restricciones: length 1 to 1000

{
  "claimant_name": "Riley Park",
  "claimant_contact": "+1 305 555 0142",
  "proof_description": "Named the card inside."
}

Respuesta 201: LostFoundClaim

lostFoundItems.claim: LostFoundClaim
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the lost found claim.
org_id	string (uuid)	Sí	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Sí	When the row was created.
created_by	string (uuid) \| null	Sí	Person who created the row; null for seed, platform or system writes.
updated_at	string (date-time)	Sí	When the row was last updated.
updated_by	string (uuid) \| null	Sí	Person who last updated the row; null for seed, platform or system writes.
lost_found_item_id	string (uuid)	Sí	Identifier of the item claimed.
claimant_name	string	Sí	Claimant.Restricciones: length 1 to 200
claimant_contact	string	Sí	Claimant phone or email.Restricciones: length 1 to 200
proof_description	string	Sí	How they proved it.Restricciones: length 1 to 1000
recorded_by_membership_id	string (uuid) \| null	Sí	Identifier of the member who took the claim.
decided_by_membership_id	string (uuid) \| null	Sí	Identifier of the member who settled it.
decided_at	string (date-time) \| null	Sí	When it was settled.
returned	boolean \| null	Sí	True when returned, false when rejected.
decision_note	string \| null	Sí	Why rejected, or a return note.Restricciones: 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."
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/lost-found-items/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/claim" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"claimant_name":"Riley Park","claimant_contact":"+1 305 555 0142","proof_description":"Named the card inside."}'

const { data } = await xos.lostFoundItems.claim("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "claimant_name": "Riley Park",
    "claimant_contact": "+1 305 555 0142",
    "proof_description": "Named the card inside."
  });

response = xos.lost_found_items.claim("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"claimant_name": "Riley Park", "claimant_contact": "+1 305 555 0142", "proof_description": "Named the card inside."})

xos lost-found-items claim 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"claimant_name":"Riley Park","claimant_contact":"+1 305 555 0142","proof_description":"Named the card inside."}'