Get Claim Action Items

GET https://api.xclaim.xcover-staging.com/partners/{partnerCode}/claims/{claimUuid}/action-items

Retrieve pending action items for a claim. Call this endpoint to determine what action is needed to progress the claim.

Currently supports document_request action items, which represent documents that need to be uploaded or re-uploaded. The pendingActions array will be empty for claims with no outstanding actions or for action types not yet supported.

Access: This endpoint requires the partner-action-items-access attribute to be enabled for your partner account. Contact your CSE to request access.

Path Parameters

Name

Type

Description

partnerCode*

String

Your partner code, eg. XYZ999

claimId*

String

UUID of the claim, eg. 9176cdbc-75c8-6q90-5462-9dd72223g201

Headers

Name

Type

Description Á

Authorization*

String

Bearer {{JWT token}}

{
  "data": {
    "claimId": "9826cebc-75c8-4a21-8472-9dd72223a201",
    "claimReference": "KGLNQ-LUUGY-CLA",
    "statusCategory": "Action Required",
    "pendingActions": [
      {
        "actionType": "document_request",
        "sectionFieldId": "96d4187c-bd99-45f5-b42f-146c4d00318f",
        "sectionFieldName": "proof_of_damage",
        "sectionFieldLabel": "Proof of Damage",
        "requestTypeName": "reupload_required",
        "requestTypeLabel": "Reupload Required",
        "reasons": ["Image is blurry, please provide a clearer photo"],
        "createdAt": "2026-02-20T10:00:00+00:00"
      },
      {
        "actionType": "document_request",
        "sectionFieldId": "2daf60e3-cd8c-4b7b-806e-9ad561e8ef6f",
        "sectionFieldName": "invoice",
        "sectionFieldLabel": "Invoice",
        "requestTypeName": "new_document_requested",
        "requestTypeLabel": "New Document Requested",
        "reasons": ["Original purchase receipt required"],
        "createdAt": "2026-02-20T10:00:00+00:00"
      }
    ],
    "meta": {
      "totalPendingActions": 2,
      "actionTypes": ["document_request"]
    }
  }
}

When the claim has no pending actions (e.g. all documents have been provided or the claim is not in

{
  "data": {
    "claimId": "9826cebc-75c8-4a21-8472-9dd72223a201",
    "claimReference": "KGLNQ-LUUGY-CLA",
    "statusCategory": "Under Assessment",
    "pendingActions": [],
    "meta": {
      "totalPendingActions": 0,
      "actionTypes": []
    }
  }
}

When the partner does not have the action items access attribute enabled.

{
  "type": "exception",
  "message": "Partner does not have access to action items"
}

When using a partner code that does not match the authenticated user

{
  "type": "exception",
  "message": "This action is unauthorized."
}

When the claim UUID does not exist.

{
  "type": "exception",
  "message": "Resource not found."
}

PreviousDelete File NextWebhooks

Last updated 3 months ago

Was this helpful?