Submit

Submit a new claim

Claim Type

• D = Damage

• L = Loss

• T = Damage and total loss

Claim Status

• 4 = Incomplete Document: New claim submitted

• 0 = Processing: Claim info and documents verified

• 1 = Paid: Claim Approved

• 2 = Rejected: Claim Denied

• 3 = Cancelled: Claim Withdrawn by claimer

Check Submitted Claim Status

Every claims will need some time to process, so we have provided several method to check status.

• By API: Claimer can retrieve claim information by send request to api/claim/query API.

• By email: XpressCover will send an email to claimer when there is a changes in claim. Changes included status updated and admin request extra document.

• By callback: XpressCover will be sent to the defined callback URL via HTTP POST when there is a changes in claim. Changes included status updated and admin request extra document. Trigger callback only claimer has define a callback URl in claim/submit API.

Endpoint

/api/claim/submit

Request

Parameters

Name	Mandatory	Description	Type	Default
claim_type		Claim type. e.g.: D, L, or T	String
user		User's username	String
consignment_note		Consignment note. Must exists in declarations with approved status	String
incident_date		Incident date. Future date is not allow. Format: yyyymmdd	Date
claimer_name		Claimer's name	String (100)
claimer_contact_person		Claimer's contact person name	String (100)
claimer_contact_no		Claimer's contact number	String (20)
claimer_email		Claimer's email. To received email from XpressCover	String (100)
desire_claim_amt		Claim amount	Decimal (11, 2)
claim_item		Item's description	String (100)
callback_url		Callback URL	String (150)

Example

{
    "claim_type": "D",
    "user": "abc.api",
    "consignment_note": "CN0000000001",
    "incident_date": "20250218",
    "claimer_name": "Testing 1",
    "claimer_contact_person": "Testing 1",
    "claimer_contact_no": "60123456789",
    "claimer_email": "[email protected]",
    "desire_claim_amt": 1000,
    "claim_item": "testing item 123",
    "callback_url": "https://clientendpoint/claim/callback"
}

Response

Successful Response Parameters

Name	Description	Type
status	API response status SUCCESS	String
claim	Claim information	Claim Model

Example

{
    "status": "SUCCESS",
    "claim": {
        "claims_id": 1,
        "user": "abc.api",
        "claim_type": "D",
        "consignment_note": "CN0000000001",
        "claimer_name": "Testing 1",
        "claimer_contact_person": "Testing 1",
        "claimer_contact_no": "60123456789",
        "claimer_email": "[email protected]",
        "incident_date": "2025-02-18 00:00:00",
        "police_rpt_no": "",
        "claim_item": "testing item 123",
        "desire_claim_amt": 102,
        "claims_status": 4,
        "access_code": "1968573",
        "submitted_at": "2025-02-19 18:21:49",
        "claim_documents": [],
        "callback_url": "https://clientendpoint/path/callback"
    }
}

Error Response Parameters

Name	Description	Type
status	API response status ERROR	String
err_code	Error code	Integer
err_msg	Error message	String
errors	Extra Error Information	null or array

Example

{
    "status": "ERROR",
    "err_code": 4001,
    "err_msg": "The Consignment Note not found",
    "errors": null
}