The Claim Callback API is provided by our partner, serving as the means by which Qoala shares the latest status of the claim instance. Through this callback API, Qoala will share policy information such as claim_number, status, etc. Qoala's system supports several methods of authorization, including HMAC_SHA256, MD5, Bearer, and Basic Auth. Qoala can also support a new authorization method if needed. Qoala will notify the partner when the claim status is updated, either approved or rejected, through this callback API.
Callback API is not a mandatory flow in terms of claim creation; however, it is useful for partners who want to get up-to-date status of the claim.
Callback URL
Each partner can configure a callback URL for claim status webhook. This notification webhook will be triggered every time there is any change in claim status. Please refer to Claim Status section for each status details.
POST {partner-url-path}
partner-url-path = URL from partner to receive webhook notification
The configuration can be done through at the time of onboarding.
Webhook Signature
Partners can optionally verify the authenticity of notifications sent by Qoala by the header x-api-key
Example:
x-api-key: 6ffbb59b2300aae63f272406069a9788598b792a944a07aba816edb039989a39
Webhook Request
Each time a status is updated then a request with the following details will be made against the specified Callback URL [partner-url-path]
Headers
The following are the details of the request headers of the webhook
Header | Expected Value |
---|---|
x-api-key | Refer to Signature section |
Content-Type | application/json |
Body
The following are the details of the request body of the webhook
Object Fields | Type | Required | Description |
---|---|---|---|
claim_number | string | Yes | unique identifier for claim created by qoala system |
policy_number | string | No | policy number generated by qoala |
status | string | Yes | claim status |
Webhook Response
HTTP response status code from partner will be tracked and
- HTTP status code 200 will be acknowledged by Qoala as notification successfully received. No retry will be done.
- Other HTTP status code will be marked as failed and will be retried. Request will be retried up to 8 times with exponential backoff interval.