Skip to main content
Image

API Endpoints

Exploring with publicly accessible API references

API Endpoints

The public display includes all endpoints and provides sample requests and responses. Additionally, you will find developer documentation related to consuming the API, and executing key business flows with the API.

Private Motor

Description
This API endpoint performs premium calculation and business validation on the provided information to determine if it can be processed as a straight-through transaction.

 

Path
POST /quotes/premiums


Request

Parameter Description Passed in Required
x-Partner-Id Unique identifier of the client making the API call HTTP Header Yes
x-Transaction-Id Unique ID for the request message HTTP Header Yes
Policy Full Policy Information Request body Yes

Response

Parameter Description Passed in
status SUCCESS / WARNING / ERROR Response body
messages Any detailed message for WARNING or ERROR results Response body
premium Calculated price / premium Response body
excess Excess section details Response body

Sample

Sample Request Sample Response
{
"country": "HKG",
"product": "PRIVATE MOTOR",
"inceptionDate": "2023-02-20",
"effectiveDate": "2023-02-20",
"expiryDate": "2024-02-19",
"risks": [
{
"riskNumber": "1",
"attachmentDate": "2022-10-20",
"privateMotor": {
"vehicle": {
"id": "en_HK-TOYO21AU-3",
"make": "TOYO",
"makeDescription": "Toyota",
"model": "COROLLA",
"modelDescription": "COROLLA",
"vehicleDescription": "MY2020 Sedan 4dr CVT FWD 1.5i [OI]",
"body": "SEDAN",
"category": "AG",
"yearManufactured": 2021,
"vehicleType": "PV",
"vehicleEffectiveDate": "2022-07-12",
"vehicleUse": "VP",
"registrationNumber": "TBD",
"engineNumber": "TBD",
"chassisNumber": "TBD",
"cubicCapacity": 1497,
"seatCapacity": 5,
"averageRetailPrice": 161587,
"goodRetailPrice": 176743,
"isSuperCar": false,
"sumInsured": 1000000,
"cover": "CO",
"mainDriverAge": "36",
"leastYearsDrivingExperience": "E3",
"mostDemeritPointsLost": "D1"
},
"noClaimDiscount": {
"percentage": 20,
"previousInsurer": "ABC Corp",
"previousPolicy": "ABC123"
},
"drivers": [
{
"driverType": "ID",
"driverName": "Test Driver",
"driverDateOfBirth": "1980-01-01",
"yearsLicensed": "E3",
"occupation": "000A",
"driverId": "ABC123",
"driverIdType": "HKID",
"demeritPoints": "D1"
},
{
"driverType": "ND",
"driverName": "Test Driver",
"driverDateOfBirth": "1980-01-01",
"yearsLicensed": "E3",
"occupation": "000A",
"driverId": "ABC123",
"driverIdType": "HKID",
"demeritPoints": "D1"
}
],
"optionalExtensions": {
"guangdongProvinceExtension": false,
"thirdPartyPropertyDamageLimitIncrease": "TPX1",
"accidentalDamageTPPDExcessAdjustment": "XP01"
},
"coverNoteAndCI": {
"coverNoteEffectiveDate": "2022-09-15T20:20:39+00:00",
"coverNoteExpiry": 30
}
}
}
],
"questions": {
"withClaimsPast3Years": false,
"claimDetails": []
}
} 		{
"status": "SUCCESS",
"messageHeader": {
"partnerId": "10000581",
"transactionId": "test2"
},
"premium": {
"annualPremium": 37100,
"premiumDue": 37100,
"gst": 0,
"totalDue": 38250.1,
"totalDiscount": 50,
"totalLoading": 0,
"charges": [
{
"chargeDescription": "IA LEVY",
"value": 37.1
},
{
"chargeDescription": "MIB FEE",
"value": 1113
}
]
},
"excess": [
{
"section": "Section 1",
"excessDetails": [
{
"excessType": "Accidental Damage Excess",
"excessAmount": 6600
},
{
"excessType": "Theft Excess",
"excessAmount": 4000
},
{
"excessType": "Young Driver Excess",
"excessAmount": 5750
},
{
"excessType": "Inexperienced Driver Excess",
"excessAmount": 5750
},
{
"excessType": "Unnamed Driver Excess",
"excessAmount": 5750
},
{
"excessType": "Parking Excess",
"excessAmount": 2000
}
]
},
{
"section": "Section 2",
"excessDetails": [
{
"excessType": "Young Driver Excess",
"excessAmount": 5750
},
{
"excessType": "Inexperienced Driver Excess",
"excessAmount": 5750
},
{
"excessType": "Third Party Property Damage Excess",
"excessAmount": 6600
}
]
}
]
}

Description
This API endpoint allows a partner to save a quotation to with QBE that can be retrieved or converted to a policy later within 30-60 days, depending on the product.

 

Path
POST /quotes


Request

Parameter Description Passed in Required
x-Partner-Id Unique identifier of the client making the API call HTTP Header Yes
x-Transaction-Id Unique ID for the request message HTTP Header Yes
Policy Full quote Information Request body Yes
suppressCustDocsFlag boolean to determine if customer documents will be sent to client (default: false) URL No

Response

Parameter Description Passed in
status SUCCESS / WARNING / ERROR Response body
messages Any detailed message for WARNING or ERROR results Response body
quoteNumber Unique quote number allocated by QBE Response body
quoteStatus ISSUED / ISSUED WITH REFERRAL Response body

Sample

Sample Request Sample Response
{
"country": "HKG",
"product": "PRIVATE MOTOR",
"inceptionDate": "2023-02-20",
"effectiveDate": "2023-02-20",
"expiryDate": "2024-02-19",
"client": {
"clientKey": "",
"clientAddress": {
"floorNumber": "",
"buildingName": "Oceania Mansion",
"streetName": "456 Nathan Road",
"district": "Mongkok",
"city": "Hong Kong",
"province": "",
"country": "HKG",
"postcode": ""
},
"email": "[email protected]",
"phone": "12345678",
"fullName": "Test User",
"HKID": "457349853",
"birthDate": "1980-01-01",
"gender": "MALE",
"nationality": "HKG"
},
"risks": [
{
"riskNumber": "1",
"attachmentDate": "2022-10-20",
"privateMotor": {
"vehicle": {
"id": "en_HK-TOYO21AU-3",
"make": "TOYO",
"makeDescription": "Toyota",
"model": "COROLLA",
"modelDescription": "COROLLA",
"vehicleDescription": "MY2020 Sedan 4dr CVT FWD 1.5i [OI]",
"body": "SEDAN",
"category": "AG",
"yearManufactured": 2021,
"vehicleType": "PV",
"vehicleEffectiveDate": "2022-07-12",
"vehicleUse": "VP",
"registrationNumber": "TBD",
"engineNumber": "TBD",
"chassisNumber": "TBD",
"cubicCapacity": 1497,
"seatCapacity": 5,
"averageRetailPrice": 161587,
"goodRetailPrice": 176743,
"isSuperCar": false,
"sumInsured": 1000000,
"cover": "CO",
"mainDriverAge": "36",
"leastYearsDrivingExperience": "E3",
"mostDemeritPointsLost": "D1"
},
"noClaimDiscount": {
"percentage": 20,
"previousInsurer": "ABC Corp",
"previousPolicy": "ABC123"
},
"drivers": [
{
"driverType": "ID",
"driverName": "Test Driver",
"driverDateOfBirth": "1980-01-01",
"yearsLicensed": "E3",
"occupation": "000A",
"driverId": "ABC123",
"driverIdType": "HKID",
"demeritPoints": "D1"
},
{
"driverType": "ND",
"driverName": "Test Driver",
"driverDateOfBirth": "1980-01-01",
"yearsLicensed": "E3",
"occupation": "000A",
"driverId": "ABC123",
"driverIdType": "HKID",
"demeritPoints": "D1"
}
],
"optionalExtensions": {
"guangdongProvinceExtension": false,
"thirdPartyPropertyDamageLimitIncrease": "TPX1",
"accidentalDamageTPPDExcessAdjustment": "XP01"
},
"coverNoteAndCI": {
"coverNoteEffectiveDate": "2022-09-15T20:20:39+00:00",
"coverNoteExpiry": 30
}
}
}
],
"questions": {
"withClaimsPast3Years": false,
"claimDetails": []
}
} 		{
"status": "SUCCESS",
"messageHeader": {
"partnerId": "10000581",
"transactionId": "testHC"
},
"quoteNumber": "00537459",
"quoteStatus": "SAVED QUOTE"
}

Description
This API endpoint allows a partner to officially bind a policy with QBE. The transaction will send the policy documents to the indicated insured’s e-mail address.

 

Path
POST /policies


Request

Parameter Description Passed in Required
x-Partner-Id Unique identifier of the client making the API call HTTP Header Yes
x-Transaction-Id Unique ID for the request message HTTP Header Yes
Policy Full Policy Information Request body Yes
suppressCustDocsFlag boolean to determine if customer documents will be sent to client (default: false) URL No

Response

Parameter Description Passed in
status SUCCESS / WARNING / ERROR Response body
messages Any detailed message for WARNING or ERROR results Response body
policyNumber Unique policy number allocated by QBE Response body
policyStatus INFORCED NEW BUSINESS / REFERRED Response body

Sample

Sample Request Sample Response
{
"country": "HKG",
"product": "PRIVATE MOTOR",
"inceptionDate": "2023-11-20",
"effectiveDate": "2023-11-20",
"expiryDate": "2024-11-19",
"client": {
"clientKey": "",
"clientAddress": {
"floorNumber": "",
"buildingName": "Oceania Mansion",
"streetName": "456 Nathan Road",
"district": "Mongkok",
"city": "Hong Kong",
"province": "",
"country": "HKG",
"postcode": ""
},
"email": "[email protected]",
"phone": "12345678",
"fullName": "David Liongson",
"HKID": "457349853",
"birthDate": "1980-01-01",
"gender": "MALE",
"nationality": "HKG"
},
"risks": [
{
"riskNumber": "1",
"attachmentDate": "2022-10-20",
"privateMotor": {
"vehicle": {
"id": "en_HK-TOYO21AU-3",
"make": "TOYO",
"makeDescription": "Toyota",
"model": "COROLLA",
"modelDescription": "COROLLA",
"vehicleDescription": "MY2020 Sedan 4dr CVT FWD 1.5i [OI]",
"body": "SEDAN",
"category": "AG",
"yearManufactured": 2021,
"vehicleType": "PV",
"vehicleEffectiveDate": "2022-07-12",
"vehicleUse": "VP",
"registrationNumber": "TBD",
"engineNumber": "765432",
"chassisNumber": "1111111",
"cubicCapacity": 1497,
"seatCapacity": 5,
"averageRetailPrice": 161587,
"goodRetailPrice": 176743,
"isSuperCar": false,
"sumInsured": 1000000,
"cover": "CO",
"mainDriverAge": "36",
"leastYearsDrivingExperience": "E3",
"mostDemeritPointsLost": "D1"
},
"noClaimDiscount": {
"percentage": 20,
"previousInsurer": "ABC Corp",
"previousPolicy": "ABC123"
},
"drivers": [
{
"driverType": "ID",
"driverName": "David Liongson",
"driverDateOfBirth": "1980-01-01",
"yearsLicensed": "E3",
"occupation": "000A",
"driverId": "ABC123",
"driverIdType": "HKID",
"demeritPoints": "D1"
},
{
"driverType": "ND",
"driverName": "David Liongson",
"driverDateOfBirth": "1980-01-01",
"yearsLicensed": "E3",
"occupation": "000A",
"driverId": "ABC123",
"driverIdType": "HKID",
"demeritPoints": "D1"
}
],
"optionalExtensions": {
"guangdongProvinceExtension": false,
"thirdPartyPropertyDamageLimitIncrease": "TPX1",
"accidentalDamageTPPDExcessAdjustment": "XP01"
},
"coverNoteAndCI": {
"coverNoteEffectiveDate": "2022-09-15T20:20:39+00:00",
"coverNoteExpiry": 30
}
}
}
],
"questions": {
"withClaimsPast3Years": false,
"claimDetails": [],
"isVehicleAltered": false,
"isVehicleForHire": false,
"hasDriverOffencePoints": false,
"hasDriverBeenDisqualified": false,
"hasRefusedPolicy": false,
"isDriverNotFit": false
}
} 		{
"status": "SUCCESS",
"action": "quoteUpdate",
"messageHeader": {
"partnerId": "05110014",
"transactionId": "issuePolicy-110820230802"
},
"policyNumber": "V0514932",
"policyStatus": "INFORCED NEW BUSINESS"
}

Description
This API endpoint allows a partner to officially bind a Motor policy cover note with QBE while the vehicle registration is still pending. The transaction will send the cover note documents to the indicated insured’s e-mail address. Only applicable for Hong Kong.

 

Path
POST /covernotes


Request

Parameter Description Passed in Required
x-Partner-Id Unique identifier of the client making the API call HTTP Header Yes
x-Transaction-Id Unique ID for the request message HTTP Header Yes
Policy Full quote Information Request body Yes
suppressCustDocsFlag boolean to determine if customer documents will be sent to client (default: false) URL No

Response

Parameter Description Passed in
status SUCCESS / WARNING / ERROR Response body
messages Any detailed message for WARNING or ERROR results Response body
policyNumber Unique quote number allocated by QBE Response body
policyStatus ISSUED COVER NOTE Response body

Sample

Sample Request Sample Response
{
"country": "HKG",
"product": "PRIVATE MOTOR",
"inceptionDate": "2023-11-20",
"effectiveDate": "2023-11-20",
"expiryDate": "2024-11-19",
"client": {
"clientKey": "",
"clientAddress": {
"floorNumber": "",
"buildingName": "Oceania Mansion",
"streetName": "456 Nathan Road",
"district": "Mongkok",
"city": "Hong Kong",
"province": "",
"country": "HKG",
"postcode": ""
},
"email": "[email protected]",
"phone": "12345678",
"fullName": "David Liongson",
"HKID": "457349853",
"birthDate": "1980-01-01",
"gender": "MALE",
"nationality": "HKG"
},
"risks": [
{
"riskNumber": "1",
"attachmentDate": "2022-10-20",
"privateMotor": {
"vehicle": {
"id": "en_HK-TOYO21AU-3",
"make": "TOYO",
"makeDescription": "Toyota",
"model": "COROLLA",
"modelDescription": "COROLLA",
"vehicleDescription": "MY2020 Sedan 4dr CVT FWD 1.5i [OI]",
"body": "SEDAN",
"category": "AG",
"yearManufactured": 2021,
"vehicleType": "PV",
"vehicleEffectiveDate": "2022-07-12",
"vehicleUse": "VP",
"registrationNumber": "TBD",
"engineNumber": "765432",
"chassisNumber": "1111111",
"cubicCapacity": 1497,
"seatCapacity": 5,
"averageRetailPrice": 161587,
"goodRetailPrice": 176743,
"isSuperCar": false,
"sumInsured": 1000000,
"cover": "CO",
"mainDriverAge": "36",
"leastYearsDrivingExperience": "E3",
"mostDemeritPointsLost": "D1"
},
"noClaimDiscount": {
"percentage": 20,
"previousInsurer": "ABC Corp",
"previousPolicy": "ABC123"
},
"drivers": [
{
"driverType": "ID",
"driverName": "David Liongson",
"driverDateOfBirth": "1980-01-01",
"yearsLicensed": "E3",
"occupation": "000A",
"driverId": "ABC123",
"driverIdType": "HKID",
"demeritPoints": "D1"
},
{
"driverType": "ND",
"driverName": "David Liongson",
"driverDateOfBirth": "1980-01-01",
"yearsLicensed": "E3",
"occupation": "000A",
"driverId": "ABC123",
"driverIdType": "HKID",
"demeritPoints": "D1"
}
],
"optionalExtensions": {
"guangdongProvinceExtension": false,
"thirdPartyPropertyDamageLimitIncrease": "TPX1",
"accidentalDamageTPPDExcessAdjustment": "XP01"
},
"coverNoteAndCI": {
"coverNoteEffectiveDate": "2022-09-15T20:20:39+00:00",
"coverNoteExpiry": 30
}
}
}
],
"questions": {
"withClaimsPast3Years": false,
"claimDetails": [],
"isVehicleAltered": false,
"isVehicleForHire": false,
"hasDriverOffencePoints": false,
"hasDriverBeenDisqualified": false,
"hasRefusedPolicy": false,
"isDriverNotFit": false
}
} 		{
"status": "SUCCESS",
"action": "issueCoverNote",
"messageHeader": {
"partnerId": "05110014",
"transactionId": "issueCN-1108202308021"
},
"policyNumber": "V0514934",
"policyStatus": "ISSUED COVER NOTE"
}

Description
This API endpoint allows a partner to provide an existing Motor cover note policy number to QBE and QBE will automatically retrieve the details of the policy and convert to a New Business in forced policy internally. Only applicable for Hong Kong.

 

Path
POST /policies/convert


Request

Parameter Description Passed in Required
x-Partner-Id Unique identifier of the client making the API call HTTP Header Yes
x-Transaction-Id Unique ID for the request message HTTP Header Yes
quoteDetails Quote Number and Country Request body Yes
suppressCustDocsFlag boolean to determine if customer documents will be sent to client (default: false) URL No

Response

Parameter Description Passed in
status SUCCESS / WARNING / ERROR Response body
messages Any detailed message for WARNING or ERROR results Response body
policyNumber Unique Policy Number Response body
policyStatus INFORCED NEW BUSINESS / REFERRED / ISSUED COVER NOTE Response body

Sample

Sample Request Sample Response
{
"country": "HKG",
"covernoteNumber": "V0513930",
"suppressCustDocsFlag": false
} 		{
"status": "SUCCESS",
"action": "convertToPolicy",
"messageHeader": {
"partnerId": "05110014",
"transactionId": "convertPol"
},
"policyNumber": "V0514937",
"policyStatus": "INFORCED NEW BUSINESS"
}

Description
This API endpoint returns the full quote information saved in QBE’s systems.

 

Path
GET /quotes/{country}/{quote_id}


Request

Parameter Description Passed in Required
x-Partner-Id Unique identifier of the client making the API call HTTP Header Yes
x-Transaction-Id Unique ID for the request message HTTP Header Yes
country HKG, SGP URL Yes
quote_id Unique QBE quote number URL Yes
suppressCustDocsFlag boolean to determine if customer documents will be sent to client (default: false) URL No

Response

Parameter Description Passed in
status SUCCESS / WARNING / ERROR Response body
messages Any detailed message for WARNING or ERROR results Response body
Policy Full Saved Quote Information Response body

Sample

Sample Request Sample Response
N/A {
"status": "SUCCESS",
"action": "loadQuote",
"messageHeader": {
"partnerId": "05110014",
"transactionId": "getQuote"
},
"policy": {
"policyNumber": "00561809",
"policyStatus": "SAVED QUOTE",
"country": "HKG",
"product": "PRIVATE MOTOR",
"inceptionDate": "2023-11-20",
"effectiveDate": "2023-11-20",
"expiryDate": "2024-11-19",
"client": {
"clientKey": "05143202",
"clientAddress": {
"floorNumber": "",
"buildingName": "OCEANIA MANSION",
"streetName": "456 NATHAN ROAD",
"district": "MONGKOK",
"city": "",
"province": "",
"country": "HKG",
"postcode": "",
"state": ""
},
"email": "[email protected]",
"phone": "",
"fullName": "DAVID LIONGSON",
"gender": "MALE",
"salutation": "",
"birthDate": "1980-01-01",
"nationality": "HKG",
"HKID": "457349853"
},
"risks": [
{
"privateMotor": {
"vehicle": {
"id": "en_HK-TOYO21ACN-3",
"make": "TOYO",
"makeDescription": "Toyota",
"model": "COROLLA",
"modelDescription": "COROLLA",
"vehicleDescription": "2021 Toyota COROLLA 1.5",
"body": "SEDAN",
"category": "155",
"yearManufactured": 2021,
"vehicleType": "PV",
"vehicleEffectiveDate": "2023-09-24",
"vehicleUse": "VP",
"registrationNumber": "TBD",
"engineNumber": "765432",
"chassisNumber": "1111111",
"cubicCapacity": 1497,
"seatCapacity": 5,
"averageRetailPrice": 115750,
"goodRetailPrice": 128750,
"sumInsured": 0,
"cover": "CO",
"mainDriverAge": "41",
"leastYearsDrivingExperience": "E3",
"safeDriverDiscount": false,
"mostDemeritPointsLost": "D1",
"isSuperCar": false,
"restrictedDriver": false,
"isNewVehicle": false,
"registrationDate": "",
"hirePurchaseOwnerName": ""
},
"noClaimDiscount": {
"percentage": 20,
"previousInsurer": "ABC Corp",
"previousPolicy": "ABC123"
},
"drivers": [
{
"driverType": "ID",
"driverName": "David Liongson",
"driverDateOfBirth": "1980-01-01",
"yearsLicensed": "E3",
"occupation": "000A",
"driverId": "ABC123",
"driverIdType": "",
"demeritPoints": "D1",
"safeDriverDiscount": false,
"isInsuredDriving": false,
"namedDriverCount": 0,
"gender": "",
"maritalStatus": "",
"nationality": ""
},
{
"driverType": "ND",
"driverName": "David Liongson",
"driverDateOfBirth": "1980-01-01",
"yearsLicensed": "E3",
"occupation": "000A",
"driverId": "ABC123",
"driverIdType": "",
"demeritPoints": "D1",
"safeDriverDiscount": false,
"isInsuredDriving": true,
"namedDriverCount": 0,
"gender": "",
"maritalStatus": "",
"nationality": ""
}
],
"optionalExtensions": {
"guangdongProvinceExtension": false,
"thirdPartyPropertyDamageLimitIncrease": "TPX1",
"accidentalDamageTPPDExcessAdjustment": "XP01"
},
"coverNoteAndCI": {
"coverNoteEffectiveDate": "2023-11-20T00:00:00.000+0800",
"coverNoteExpiry": 30
}
},
"riskNumber": "1",
"attachmentDate": "2023-11-20"
}
],
"questions": {
"withClaimsPast3Years": false,
"claimDetails": [],
"isVehicleAltered": false,
"isVehicleAlteredText": "",
"isVehicleForHire": false,
"hasDriverOffencePoints": false,
"hasDriverBeenDisqualified": false,
"hasRefusedPolicy": false,
"isDriverNotFit": false,
"hasMoreThanOneClaim": false,
"isTotalClaimOver100K": false,
"hasInjurytoThirdParty": false
}
},
"premium": {
"annualPremium": 9632.05,
"premiumDue": 9632.05,
"gst": 0,
"totalDue": 9930.64,
"totalDiscount": 76.07,
"totalLoading": 0,
"totalCommission": {
"commissionRate": 25,
"commissionAmount": 2408.02
},
"charges": [
{
"chargeDescription": "IA LEVY",
"value": 9.63
},
{
"chargeDescription": "MIB FEE",
"value": 288.96
}
]
},
"excess": [
{
"section": "Section 1",
"excessDetails": [
{
"excessType": "Accidental Damage Excess",
"excessAmount": 6000
},
{
"excessType": "Theft Excess",
"excessAmount": 4000
},
{
"excessType": "Young Driver Excess",
"excessAmount": 5000
},
{
"excessType": "Inexperienced Driver Excess",
"excessAmount": 5000
},
{
"excessType": "Unnamed Driver Excess",
"excessAmount": 5000
},
{
"excessType": "Parking Excess",
"excessAmount": 2000
}
]
},
{
"section": "Section 2",
"excessDetails": [
{
"excessType": "Young Driver Excess",
"excessAmount": 5000
},
{
"excessType": "Inexperienced Driver Excess",
"excessAmount": 5000
},
{
"excessType": "Third Party Property Damage Excess",
"excessAmount": 7000
}
]
}
]
}

Description
This API endpoint returns the full policy information saved in QBE’s systems. This is applicable for both inforced policies and cover notes.

 

Path
GET /policies/{country}/{policy_id}


Request

Parameter Description Passed in Required
x-Partner-Id Unique identifier of the client making the API call HTTP Header Yes
x-Transaction-Id Unique ID for the request message HTTP Header Yes
country HKG, SGP URL Yes
policy_no Unique QBE policy number URL Yes

Response

Parameter Description Passed in
status SUCCESS / WARNING / ERROR Response body
messages Any detailed message for WARNING or ERROR results Response body
policyStatus INFORCED NEW BUSINESS / REFERRED / ISSUED COVER NOTE Response body
policy Full policy Information Response body
premium Calculated price / premium Response body
excess Excess section details for Private Motor Response body

Sample

Sample Request Sample Response
N/A {
"status": "SUCCESS",
"action": "loadPolicy",
"messageHeader": {
"partnerId": "05110014",
"transactionId": "getPolicyTest"
},
"policy": {
"policyNumber": "V0514937",
"policyStatus": "INFORCED NEW BUSINESS",
"country": "HKG",
"product": "PRIVATE MOTOR",
"inceptionDate": "2023-11-20",
"effectiveDate": "2023-11-20",
"expiryDate": "2024-11-19",
"client": {
"clientKey": "05143201",
"clientAddress": {
"floorNumber": "",
"buildingName": "OCEANIA MANSION",
"streetName": "456 NATHAN ROAD",
"district": "MONGKOK",
"city": "",
"province": "",
"country": "HKG",
"postcode": "",
"state": ""
},
"email": "[email protected]",
"phone": "",
"fullName": "DAVID LIONGSON",
"gender": "MALE",
"salutation": "",
"birthDate": "1980-01-01",
"nationality": "HKG",
"HKID": "457349853"
},
"risks": [
{
"privateMotor": {
"vehicle": {
"id": "en_HK-TOYO21ACN-3",
"make": "TOYO",
"makeDescription": "Toyota",
"model": "COROLLA",
"modelDescription": "COROLLA",
"vehicleDescription": "2021 Toyota COROLLA 1.5",
"body": "SEDAN",
"category": "155",
"yearManufactured": 2021,
"vehicleType": "PV",
"vehicleEffectiveDate": "2023-09-24",
"vehicleUse": "VP",
"registrationNumber": "TBD",
"engineNumber": "765432",
"chassisNumber": "1111111",
"cubicCapacity": 1497,
"seatCapacity": 5,
"averageRetailPrice": 115750,
"goodRetailPrice": 128750,
"sumInsured": 0,
"cover": "CO",
"mainDriverAge": "41",
"leastYearsDrivingExperience": "E3",
"safeDriverDiscount": false,
"mostDemeritPointsLost": "D1",
"isSuperCar": false,
"restrictedDriver": false,
"isNewVehicle": false,
"registrationDate": "",
"hirePurchaseOwnerName": ""
},
"noClaimDiscount": {
"percentage": 20,
"previousInsurer": "ABC Corp",
"previousPolicy": "ABC123"
},
"drivers": [
{
"driverType": "ID",
"driverName": "David Liongson",
"driverDateOfBirth": "1980-01-01",
"yearsLicensed": "E3",
"occupation": "000A",
"driverId": "ABC123",
"driverIdType": "",
"demeritPoints": "D1",
"safeDriverDiscount": false,
"isInsuredDriving": false,
"namedDriverCount": 0,
"gender": "",
"maritalStatus": "",
"nationality": ""
},
{
"driverType": "ND",
"driverName": "David Liongson",
"driverDateOfBirth": "1980-01-01",
"yearsLicensed": "E3",
"occupation": "000A",
"driverId": "ABC123",
"driverIdType": "",
"demeritPoints": "D1",
"safeDriverDiscount": false,
"isInsuredDriving": true,
"namedDriverCount": 0,
"gender": "",
"maritalStatus": "",
"nationality": ""
}
],
"optionalExtensions": {
"guangdongProvinceExtension": false,
"thirdPartyPropertyDamageLimitIncrease": "TPX1",
"accidentalDamageTPPDExcessAdjustment": "XP01"
},
"coverNoteAndCI": {
"coverNoteEffectiveDate": "2023-11-20T00:00:00.000+0800",
"coverNoteExpiry": 30
}
},
"riskNumber": "1",
"attachmentDate": "2023-11-20"
}
],
"questions": {
"withClaimsPast3Years": false,
"claimDetails": [],
"isVehicleAltered": false,
"isVehicleAlteredText": "",
"isVehicleForHire": false,
"hasDriverOffencePoints": false,
"hasDriverBeenDisqualified": false,
"hasRefusedPolicy": false,
"isDriverNotFit": false,
"hasMoreThanOneClaim": false,
"isTotalClaimOver100K": false,
"hasInjurytoThirdParty": false
}
},
"premium": {
"annualPremium": 9632.05,
"premiumDue": 9632.05,
"gst": 0,
"totalDue": 9930.64,
"totalDiscount": 76.07,
"totalLoading": 0,
"totalCommission": {
"commissionRate": 25,
"commissionAmount": 2408.02
},
"charges": [
{
"chargeDescription": "IA LEVY",
"value": 9.63
},
{
"chargeDescription": "MIB FEE",
"value": 288.96
}
]
},
"excess": [
{
"section": "Section 1",
"excessDetails": [
{
"excessType": "Accidental Damage Excess",
"excessAmount": 6000
},
{
"excessType": "Theft Excess",
"excessAmount": 4000
},
{
"excessType": "Young Driver Excess",
"excessAmount": 5000
},
{
"excessType": "Inexperienced Driver Excess",
"excessAmount": 5000
},
{
"excessType": "Unnamed Driver Excess",
"excessAmount": 5000
},
{
"excessType": "Parking Excess",
"excessAmount": 2000
}
]
},
{
"section": "Section 2",
"excessDetails": [
{
"excessType": "Young Driver Excess",
"excessAmount": 5000
},
{
"excessType": "Inexperienced Driver Excess",
"excessAmount": 5000
},
{
"excessType": "Third Party Property Damage Excess",
"excessAmount": 7000
}
]
}
]
}

Description
This API endpoint returns the list of vehicle makes for a given year of manufacture and country/locale. This is a pre-requisite step to retrieve the list of vehicle models.

 

Path
GET /vehicles/makes


Request

Parameter Description Passed in Required
x-Partner-Id Unique identifier of the client making the API call HTTP Header Yes
x-Transaction-Id Unique ID for the request message HTTP Header Yes
locale e.g. eg_SG, en_HK URL Yes
year Manufacture year of vehicle URL Yes

Response

Parameter Description Passed in
makes List of vehicle makes Response body

Sample

Sample Request Sample Response
N/A {
"makes": [
{
"id": "en_HK-ABAR",
"locale": "en_HK",
"make": "ABAR",
"makeDescription": "ABARTH",
"startYear": 2011,
"latestYear": 2022
},
{
"id": "en_HK-ACUR",
"locale": "en_HK",
"make": "ACUR",
"makeDescription": "ACURA",
"startYear": 1991,
"latestYear": 2022
},
{
"id": "en_HK-ALFA",
"locale": "en_HK",
"make": "ALFA",
"makeDescription": "ALFA ROMEO",
"startYear": 1992,
"latestYear": 2022
},
{
"id": "en_HK-ASTO",
"locale": "en_HK",
"make": "ASTO",
"makeDescription": "ASTON MARTIN",
"startYear": 1996,
"latestYear": 2022
},
{
"id": "en_HK-AUDI",
"locale": "en_HK",
"make": "AUDI",
"makeDescription": "Audi",
"startYear": 2020,
"latestYear": 2020
},
{
"id": "en_HK-BENT",
"locale": "en_HK",
"make": "BENT",
"makeDescription": "BENTLEY",
"startYear": 1991,
"latestYear": 2022
},
{
"id": "en_HK-BMW",
"locale": "en_HK",
"make": "BMW",
"makeDescription": "BMW",
"startYear": 1982,
"latestYear": 2022
},
{
"id": "en_HK-BUGA",
"locale": "en_HK",
"make": "BUGA",
"makeDescription": "BUGATTI",
"startYear": 2009,
"latestYear": 2022
},
{
"id": "en_HK-DAIH",
"locale": "en_HK",
"make": "DAIH",
"makeDescription": "DAIHATSU",
"startYear": 1989,
"latestYear": 2022
},
{
"id": "en_HK-FERR",
"locale": "en_HK",
"make": "FERR",
"makeDescription": "FERRARI",
"startYear": 1990,
"latestYear": 2022
},
{
"id": "en_HK-FIAT",
"locale": "en_HK",
"make": "FIAT",
"makeDescription": "FIAT",
"startYear": 1995,
"latestYear": 2022
},
{
"id": "en_HK-FORD",
"locale": "en_HK",
"make": "FORD",
"makeDescription": "FORD",
"startYear": 1993,
"latestYear": 2022
},
{
"id": "en_HK-GUMP",
"locale": "en_HK",
"make": "GUMP",
"makeDescription": "GUMPERT",
"startYear": 2009,
"latestYear": 2022
},
{
"id": "en_HK-HOND",
"locale": "en_HK",
"make": "HOND",
"makeDescription": "HONDA",
"startYear": 1985,
"latestYear": 2022
},
{
"id": "en_HK-HYUN",
"locale": "en_HK",
"make": "HYUN",
"makeDescription": "HYUNDAI",
"startYear": 1995,
"latestYear": 2022
},
{
"id": "en_HK-JAGU",
"locale": "en_HK",
"make": "JAGU",
"makeDescription": "JAGUAR",
"startYear": 1988,
"latestYear": 2022
},
{
"id": "en_HK-KIA",
"locale": "en_HK",
"make": "KIA",
"makeDescription": "KIA",
"startYear": 1996,
"latestYear": 2022
},
{
"id": "en_HK-LAMB",
"locale": "en_HK",
"make": "LAMB",
"makeDescription": "LAMBORGHINI",
"startYear": 1993,
"latestYear": 2022
},
{
"id": "en_HK-LAND",
"locale": "en_HK",
"make": "LAND",
"makeDescription": "LAND ROVER",
"startYear": 1990,
"latestYear": 2022
},
{
"id": "en_HK-LEXU",
"locale": "en_HK",
"make": "LEXU",
"makeDescription": "LEXUS",
"startYear": 1993,
"latestYear": 2022
},
{
"id": "en_HK-LOTU",
"locale": "en_HK",
"make": "LOTU",
"makeDescription": "LOTUS",
"startYear": 1991,
"latestYear": 2022
},
{
"id": "en_HK-MASE",
"locale": "en_HK",
"make": "MASE",
"makeDescription": "MASERATI",
"startYear": 1996,
"latestYear": 2022
},
{
"id": "en_HK-MAYB",
"locale": "en_HK",
"make": "MAYB",
"makeDescription": "MAYBACH",
"startYear": 2004,
"latestYear": 2022
},
{
"id": "en_HK-MAZD",
"locale": "en_HK",
"make": "MAZD",
"makeDescription": "MAZDA",
"startYear": 1987,
"latestYear": 2022
},
{
"id": "en_HK-MERC",
"locale": "en_HK",
"make": "MERC",
"makeDescription": "MERCEDES-BENZ",
"startYear": 1975,
"latestYear": 2022
},
{
"id": "en_HK-MINI",
"locale": "en_HK",
"make": "MINI",
"makeDescription": "MINI",
"startYear": 2001,
"latestYear": 2022
},
{
"id": "en_HK-MITS",
"locale": "en_HK",
"make": "MITS",
"makeDescription": "MITSUBISHI",
"startYear": 1993,
"latestYear": 2022
},
{
"id": "en_HK-NISS",
"locale": "en_HK",
"make": "NISS",
"makeDescription": "NISSAN",
"startYear": 1990,
"latestYear": 2022
},
{
"id": "en_HK-OPEL",
"locale": "en_HK",
"make": "OPEL",
"makeDescription": "OPEL",
"startYear": 1992,
"latestYear": 2022
},
{
"id": "en_HK-PORS",
"locale": "en_HK",
"make": "PORS",
"makeDescription": "PORSCHE",
"startYear": 1990,
"latestYear": 2022
},
{
"id": "en_HK-RENA",
"locale": "en_HK",
"make": "RENA",
"makeDescription": "RENAULT",
"startYear": 1995,
"latestYear": 2022
},
{
"id": "en_HK-ROLL",
"locale": "en_HK",
"make": "ROLL",
"makeDescription": "ROLLS ROYCE",
"startYear": 1991,
"latestYear": 2022
},
{
"id": "en_HK-SAAB",
"locale": "en_HK",
"make": "SAAB",
"makeDescription": "SAAB",
"startYear": 1995,
"latestYear": 2022
},
{
"id": "en_HK-SMAR",
"locale": "en_HK",
"make": "SMAR",
"makeDescription": "SMART",
"startYear": 2002,
"latestYear": 2022
},
{
"id": "en_HK-SPYK",
"locale": "en_HK",
"make": "SPYK",
"makeDescription": "SPYKER",
"startYear": 2009,
"latestYear": 2022
},
{
"id": "en_HK-SSAN",
"locale": "en_HK",
"make": "SSAN",
"makeDescription": "SSANGYONG",
"startYear": 1997,
"latestYear": 2022
},
{
"id": "en_HK-SUBA",
"locale": "en_HK",
"make": "SUBA",
"makeDescription": "SUBARU",
"startYear": 1995,
"latestYear": 2022
},
{
"id": "en_HK-SUZU",
"locale": "en_HK",
"make": "SUZU",
"makeDescription": "SUZUKI",
"startYear": 1995,
"latestYear": 2022
},
{
"id": "en_HK-TESL",
"locale": "en_HK",
"make": "TESL",
"makeDescription": "TESLA",
"startYear": 2010,
"latestYear": 2022
},
{
"id": "en_HK-TOYO",
"locale": "en_HK",
"make": "TOYO",
"makeDescription": "TOYOTA",
"startYear": 1981,
"latestYear": 2022
},
{
"id": "en_HK-VOLK",
"locale": "en_HK",
"make": "VOLK",
"makeDescription": "VOLKSWAGEN",
"startYear": 1993,
"latestYear": 2022
},
{
"id": "en_HK-VOLV",
"locale": "en_HK",
"make": "VOLV",
"makeDescription": "VOLVO",
"startYear": 1995,
"latestYear": 2022
}
]
}

Description
This API endpoint returns the list of vehicle models for a selected vehicle make, year of manufacture, & country/locale. This is a pre-requisite step to retrieve the list of QBE vehicle model records.

 

Path
GET /vehicles/{make}/models


Request

Parameter Description Passed in Required
x-Partner-Id Unique identifier of the client making the API call HTTP Header Yes
x-Transaction-Id Unique ID for the request message HTTP Header Yes
make Make code from GET /vehicles/makes URL Yes
locale e.g. eg_SG, en_HK URL Yes
year Manufacture year of vehicle URL Yes

Response

Parameter Description Passed in
models List of vehicle models Response body

Sample

Sample Request Sample Response
N/A {
"models": [
{
"id": "en_HK-TOYO-86",
"locale": "en_HK",
"make": "TOYO",
"model": "86",
"modelDescription": "86",
"vehicleType": "PV",
"startYear": 2012,
"latestYear": 2022
},
{
"id": "en_HK-TOYO-ALPHARD",
"locale": "en_HK",
"make": "TOYO",
"model": "ALPHARD",
"modelDescription": "ALPHARD",
"vehicleType": "PV",
"startYear": 2000,
"latestYear": 2022
},
{
"id": "en_HK-TOYO-AQUA",
"locale": "en_HK",
"make": "TOYO",
"model": "AQUA",
"modelDescription": "AQUA",
"vehicleType": "PV",
"startYear": 2012,
"latestYear": 2019
},
{
"id": "en_HK-TOYO-C-HR",
"locale": "en_HK",
"make": "TOYO",
"model": "C-HR",
"modelDescription": "C-HR",
"vehicleType": "PV",
"startYear": 2016,
"latestYear": 2022
},
{
"id": "en_HK-TOYO-CAMRY",
"locale": "en_HK",
"make": "TOYO",
"model": "CAMRY",
"modelDescription": "CAMRY",
"vehicleType": "PV",
"startYear": 1986,
"latestYear": 2022
},
{
"id": "en_HK-TOYO-CENTURY",
"locale": "en_HK",
"make": "TOYO",
"model": "CENTURY",
"modelDescription": "CENTURY",
"vehicleType": "PV",
"startYear": 1997,
"latestYear": 2007
},
{
"id": "en_HK-TOYO-COROLLA",
"locale": "en_HK",
"make": "TOYO",
"model": "COROLLA",
"modelDescription": "COROLLA",
"vehicleType": "PV",
"startYear": 1992,
"latestYear": 2022
},
{
"id": "en_HK-TOYO-CROWN",
"locale": "en_HK",
"make": "TOYO",
"model": "CROWN",
"modelDescription": "CROWN",
"vehicleType": "PV",
"startYear": 1995,
"latestYear": 2022
},
{
"id": "en_HK-TOYO-ESQU",
"locale": "en_HK",
"make": "TOYO",
"model": "ESQU",
"modelDescription": "ESQUIRE",
"vehicleType": "PV",
"startYear": 2014,
"latestYear": 2014
},
{
"id": "en_HK-TOYO-ESTIMA",
"locale": "en_HK",
"make": "TOYO",
"model": "ESTIMA",
"modelDescription": "ESTIMA",
"vehicleType": "PV",
"startYear": 1995,
"latestYear": 2022
},
{
"id": "en_HK-TOYO-FJC",
"locale": "en_HK",
"make": "TOYO",
"model": "FJC",
"modelDescription": "FJ CRUISER",
"vehicleType": "PV",
"startYear": 2012,
"latestYear": 2022
},
{
"id": "en_HK-TOYO-HARRIER",
"locale": "en_HK",
"make": "TOYO",
"model": "HARRIER",
"modelDescription": "HARRIER",
"vehicleType": "PV",
"startYear": 1998,
"latestYear": 2011
},
{
"id": "en_HK-TOYO-LANDCRUISER",
"locale": "en_HK",
"make": "TOYO",
"model": "LANDCRUISER",
"modelDescription": "LANDCRUISER",
"vehicleType": "PV",
"startYear": 1998,
"latestYear": 2022
},
{
"id": "en_HK-TOYO-LANDCRUISER PRADO",
"locale": "en_HK",
"make": "TOYO",
"model": "LANDCRUISER PRADO",
"modelDescription": "LANDCRUISER PRADO",
"vehicleType": "PV",
"startYear": 1996,
"latestYear": 2022
},
{
"id": "en_HK-TOYO-MARKX",
"locale": "en_HK",
"make": "TOYO",
"model": "MARKX",
"modelDescription": "MARKX",
"vehicleType": "PV",
"startYear": 2004,
"latestYear": 2022
},
{
"id": "en_HK-TOYO-NOAH",
"locale": "en_HK",
"make": "TOYO",
"model": "NOAH",
"modelDescription": "NOAH",
"vehicleType": "PV",
"startYear": 2002,
"latestYear": 2022
},
{
"id": "en_HK-TOYO-PASSO",
"locale": "en_HK",
"make": "TOYO",
"model": "PASSO",
"modelDescription": "PASSO",
"vehicleType": "PV",
"startYear": 2004,
"latestYear": 2005
},
{
"id": "en_HK-TOYO-PORTE",
"locale": "en_HK",
"make": "TOYO",
"model": "PORTE",
"modelDescription": "PORTE",
"vehicleType": "PV",
"startYear": 2004,
"latestYear": 2015
},
{
"id": "en_HK-TOYO-PREVIA",
"locale": "en_HK",
"make": "TOYO",
"model": "PREVIA",
"modelDescription": "PREVIA",
"vehicleType": "PV",
"startYear": 1994,
"latestYear": 2022
},
{
"id": "en_HK-TOYO-PRIUS",
"locale": "en_HK",
"make": "TOYO",
"model": "PRIUS",
"modelDescription": "PRIUS",
"vehicleType": "PV",
"startYear": 2001,
"latestYear": 2022
},
{
"id": "en_HK-TOYO-PRIUS C",
"locale": "en_HK",
"make": "TOYO",
"model": "PRIUS C",
"modelDescription": "PRIUS C",
"vehicleType": "PV",
"startYear": 2012,
"latestYear": 2022
},
{
"id": "en_HK-TOYO-RACTIS",
"locale": "en_HK",
"make": "TOYO",
"model": "RACTIS",
"modelDescription": "RACTIS",
"vehicleType": "PV",
"startYear": 2005,
"latestYear": 2020
},
{
"id": "en_HK-TOYO-RAIZE",
"locale": "en_HK",
"make": "TOYO",
"model": "RAIZE",
"modelDescription": "RAIZE",
"vehicleType": "PV",
"startYear": 2019,
"latestYear": 2022
},
{
"id": "en_HK-TOYO-RAV4",
"locale": "en_HK",
"make": "TOYO",
"model": "RAV4",
"modelDescription": "RAV4",
"vehicleType": "PV",
"startYear": 1995,
"latestYear": 2020
},
{
"id": "en_HK-TOYO-Roomy",
"locale": "en_HK",
"make": "TOYO",
"model": "Roomy",
"modelDescription": "Roomy",
"vehicleType": "PV",
"startYear": 2019,
"latestYear": 2020
},
{
"id": "en_HK-TOYO-ROOMY",
"locale": "en_HK",
"make": "TOYO",
"model": "ROOMY",
"modelDescription": "ROOMY",
"vehicleType": "PV",
"startYear": 2016,
"latestYear": 2022
},
{
"id": "en_HK-TOYO-SIENTA",
"locale": "en_HK",
"make": "TOYO",
"model": "SIENTA",
"modelDescription": "SIENTA",
"vehicleType": "PV",
"startYear": 2003,
"latestYear": 2022
},
{
"id": "en_HK-TOYO-SPADE",
"locale": "en_HK",
"make": "TOYO",
"model": "SPADE",
"modelDescription": "SPADE",
"vehicleType": "PV",
"startYear": 2012,
"latestYear": 2022
},
{
"id": "en_HK-TOYO-SUPRA",
"locale": "en_HK",
"make": "TOYO",
"model": "SUPRA",
"modelDescription": "SUPRA",
"vehicleType": "PV",
"startYear": 1991,
"latestYear": 2022
},
{
"id": "en_HK-TOYO-TANK",
"locale": "en_HK",
"make": "TOYO",
"model": "TANK",
"modelDescription": "TANK",
"vehicleType": "PV",
"startYear": 2016,
"latestYear": 2016
},
{
"id": "en_HK-TOYO-TOYO",
"locale": "en_HK",
"make": "TOYO",
"model": "TOYO",
"modelDescription": "Vellfire",
"vehicleType": "PV",
"startYear": 2018,
"latestYear": 2018
},
{
"id": "en_HK-TOYO-VELLFIRE",
"locale": "en_HK",
"make": "TOYO",
"model": "VELLFIRE",
"modelDescription": "VELLFIRE",
"vehicleType": "PV",
"startYear": 2008,
"latestYear": 2022
},
{
"id": "en_HK-TOYO-VOXY",
"locale": "en_HK",
"make": "TOYO",
"model": "VOXY",
"modelDescription": "VOXY",
"vehicleType": "PV",
"startYear": 2001,
"latestYear": 2022
},
{
"id": "en_HK-TOYO-WISH",
"locale": "en_HK",
"make": "TOYO",
"model": "WISH",
"modelDescription": "WISH",
"vehicleType": "PV",
"startYear": 2003,
"latestYear": 2020
}
]
}

Description
This API endpoint returns detailed vehicle model records to be used for a Private Motor quote or policy based on the selected make and model, year of manufacture, & country/locale. This endpoint returns all records applicable for either Comprehensive or Third-Party Only coverage.

 

Path
GET /vehicles/{make}/{model}


Request

Parameter Description Passed in Required
x-Partner-Id Unique identifier of the client making the API call HTTP Header Yes
x-Transaction-Id Unique ID for the request message HTTP Header Yes
make Make code from /vehicles/makes URL Yes
model Model code from /vehicles/make/models URL Yes
locale e.g. eg_SG, en_HK URL Yes
year Manufacture year of vehicle URL Yes
cover COMPREHENSIVE, THIRD PARTY URL No
effectiveOn Relative effective date of the vehicle, yyyyMMddhhmmss format URL No

Response

Parameter Description Passed in
vehicles List of vehicles Response body

Sample

Sample Request Sample Response
N/A {
"vehicles": [
{
"id": "en_HK-TOYO11AE-7",
"locale": "en_HK",
"make": "TOYO",
"makeDescription": "TOYOTA",
"model": "COROLLA",
"modelDescription": "COROLLA",
"vehicleDescription": "ZE141 MY11 Excel Sedan 4dr Auto 4sp FWD 1.5i [OI]",
"body": "SEDAN",
"category": "BG",
"yearManufactured": 2011,
"vehicleType": "PV",
"vehicleEffectiveDate": "2022-10-27",
"cubicCapacity": 1496,
"seatCapacity": 5,
"averageRetailPrice": 23750,
"goodRetailPrice": 43000,
"isSuperCar": false,
"restrictedDriver": false
},
{
"id": "en_HK-TOYO11AF-7",
"locale": "en_HK",
"make": "TOYO",
"makeDescription": "TOYOTA",
"model": "COROLLA",
"modelDescription": "COROLLA",
"vehicleDescription": "ZE141 MY11 Advantage Sedan 4dr Auto 4sp FWD 1.5i [OI]",
"body": "SEDAN",
"category": "BG",
"yearManufactured": 2011,
"vehicleType": "PV",
"vehicleEffectiveDate": "2022-10-27",
"cubicCapacity": 1496,
"seatCapacity": 5,
"averageRetailPrice": 27250,
"goodRetailPrice": 48500,
"isSuperCar": false,
"restrictedDriver": false
}
]
}

Description
This API endpoint allows a partner to download the policy documents as PDF data for an existing quote or policy.

 

Path
POST /documents/{country}/{policy_id}


Request

Parameter Description Passed in Required
x-Partner-Id Unique identifier of the client making the API call HTTP Header Yes
x-Transaction-Id Unique ID for the request message HTTP Header Yes
country HKG, SGP URL Yes
policy_id Unique QBE quote or policy number URL Yes
suppressCustDocsFlag boolean to determine if customer documents will be sent to client (default: false) URL No

Response

Parameter Description Passed in
status SUCCESS / WARNING / ERROR Response body
messages Any detailed message for WARNING or ERROR results Response body
documents List of available documents and downloadable URLs Response body

Sample

Sample Request Sample Response
N/A {
"status": "SUCCESS",
"action": "getDocument",
"messageHeader": {
"partnerId": "05110014",
"transactionId": "getDocs"
},
"documents": [
{
"docDescription": "Motor Certificate (TBD)",
"url": "https://uat2-qnect.qbe.com/ebusiness/DocumentApiController/getApiDocument.do?token=FSaxJSAvysgI9SKgEKYXGxNTpnig343X-oUZRdQR22g76hfjPGOvjTzURh2UZ_fjY5G17qzvoa9BKac83O-WkhGOthHVmwjYBWI5ohKUeUZJ08LKrXDJaxbf6twaZIfX3CCh2S-ZXq0MiSyjcd-i_UT_fVWYFO38k584IQr1ciKlwCELGNmRZ055mbnExA4I5zsbeNptywuYvZlrm7W1vuO5N99cOJau3-UsuPW2VRCYiJNeM6hdYkiKGuGTJsayiFKne3jDTkWoOpd899GadVBNFTPycHFHQwQ19G0jjkjpuOwGMamwJ-Lw4_r5ahPtxTO0zQQu5EGZU0KzxNBc&iv=JWjvHmJwyzeyEn9ZPCEY4g"
},
{
"docDescription": "Schedule - Client Copy",
"url": "https://uat2-qnect.qbe.com/ebusiness/DocumentApiController/getApiDocument.do?token=kJDzwmNsfKTNXLxV3A1yk88RoqK7cLTz2BoCMiRtaJhN_Vm6AYgx3K0C3HPsoS0aDbELds40L7t8OsBapqffqeqfPQ9quct_nkHkTJn6l1J98xZoUi31UGXZzG1ATazn_scOCGKugSnum50dsrv_d6jXIHoShnkOmwrI13itDKVsPI2c8WkUlyBmcwJ-mqCPQzM3I_jZfbxCrJRHsyC2b7Ls40KWKRHagglVgYdxGYIu0NILzAGkcus2UNyejhpTGKHEDe78XjZeNk_xggmbWJZZXhaPiCSTnh2diWiLcuVnJDSZk5cwoCL2t4mSZ8db_CJw2N8H4iI&iv=t9tt1df9712tmEDQTHFrfA"
},
{
"docDescription": "Policy Wording",
"url": "https://uat2-qnect.qbe.com/ebusiness/DocumentApiController/getApiDocument.do?token=Jrq2-kE3C8sZFi7wXxmErLWqM596J_YHaIXgpq284BkDwnBBhqoE-WciQFi_HyRbTAIGqc2sM7eg5HwL5tNQxwoF2n6WqmEomf2Wb1-aXYv1MoUF0pk_-Gs0Qge8xzBGpBYMQMOoHI8CIYX2TL7El_9NnUgLpjBgXxvIVgBkJp1KT-tPeBab6iAZnyDMtAxXzSaEg8GcVnnYkeoW93WHT3HHqdpG8rz92PtOhU6HpTj3PViGlOtRnPs-NbVWfzqd2naEphD_fKWAgGgMbIiZT4ZACaxcQeY_jXvpxdbJkPDr2vW3r6qe26q7SFAGuQ&iv=qF8g3aHRPvMYkxvrMGSSuA"
},
{
"docDescription": "Debit Credit Note - Client Copy",
"url": "https://uat2-qnect.qbe.com/ebusiness/DocumentApiController/getApiDocument.do?token=lSTXjo680QRnUaks51MQZhrZ1L3m5jom2KmRemmdJYGxYm07sQtUoYg8DSvkWdPVzicEfqvngEgqxLcli0Ei__7r040uoUhfo-VcAWWFgOUx11bX4x1p9G9SEigV2A3DpwR1XVmyQyhnvBHj9ogCcmm1_5qh3XAuwAgcL7_0CkuGWIG_4mCQo9DL8oCNrcmp_7aRnz80Xxy0qP9u_qnz3a5WHQzEHVJaCLavt6kYljUNl3tQl-50O7UNWWkzvdEnNNN8G52FOW4LKKAr4x-4gxIL34RSP3qysR9mrUKHd37rN8PaQXUFpDuBn_XpR-8i4ksnR-k_bPtqA6oiUlokgXFLBA&iv=DvDsWfr7XSxyPVPRq0rurw"
},
{
"docDescription": "QBE eClaims and Panel Network",
"url": "https://uat2-qnect.qbe.com/ebusiness/DocumentApiController/getApiDocument.do?token=BzYtRrqy3MPx9DT30a0rk_U1mjugR9WOMuA2ZtXvhWv1s0-6ZQDVbWvQ7d6u9XVdbdMK-3kBwHmV194PmQwXC_G4RZMhCINjFO7zhENfjfaFdVSrW29XpNntQuDsc8unAn_cE01NsZ3RWXhMBPfr1UlW-qBUXs-ueZrdd8IPR0kmh1H30ioAOGrenbeND5a60gDK1RZY5bWqMMTrRHVFbX20VyzoUHygRutAs_1LuP9JSoEk9nL97Fs1z7WQHwnFeK8x0d0eZfDY3SRS3BMumEgomSzXCXLDTbM5ZyDeqjePgz6q4B0X20UqCLQ6TtIfO8EoGnVGR5GNSF1IHqQ&iv=cv3OK-0GqRF5sKnDQ4w4YQ"
}
]
}

Description
This API endpoint allows a partner to get the status of an existing claim based on its current stage in the claims process.

 

Path
POST /claims/status


Request

Parameter Description Passed in Required
x-Partner-Id Unique identifier of the client making the API call HTTP Header Yes
x-Transaction-Id Unique ID for the request message HTTP Header Yes
claimNumber Claim Number lodged Request body Yes
policyNumber Policy number of the claim being made Request body Yes
country HKG, SGP Request body Yes
policyType Type of Policy Request body Yes
name Policyholder’s full name (as indicated in policy) Request body Yes
idNumber Policyholder’s full name (as indicated in policy) Request body Yes

Response

Parameter Description Passed in
status SUCCESS / WARNING / ERROR Response body
messages Any detailed message for WARNING or ERROR results Response body
claimStatus Array of claims with claim status associated with the requested claim number or policy number Response body

Sample

Sample Request Sample Response
{
"claimNumber": "VC077736",
"policyNumber": "",
"country": "HKG",
"name" : "AUTOTEST PERSONAL",
"idNumber": "TEST123",
"policyType": "motor"
} 		{
"status": "SUCCESS",
"action": "InquireClaimStatus",
"messageHeader": {
"partnerId": "05110014",
"transactionId": "VC077736"
},
"claimStatus": [
{
"productType": "MVA",
"claimNumber": "VC077736",
"policyNumber": "V0512084",
"claimStatus": "Claim Received",
"policyHolderName": "AUTOTEST PERSONAL",
"dateOfLoss": "2023-09-01"
}
]
}

Description
This API endpoint allows a partner to register a claim for any valid QBE policy if the date of loss falls within the policy’s period of cover.

 

Path
POST /claims


Request

Parameter Description Passed in Required
x-Partner-Id Unique identifier of the client making the API call HTTP Header Yes
x-Transaction-Id Unique ID for the request message HTTP Header Yes
country 3-digit ISO code for countries Request body Yes
policyNumber Policy number of the claim being made Request body Yes
dateOfLoss Date of Loss or when the incident occurred Request body Yes
policyHolderName Policyholder’s full name (as indicated in policy) Request body Yes
securityNumber Policy Holder’s Security ID Number (HKID or Passport Number as indicated in policy) Request body Yes
incidentLocation 3-digit ISO code for country where the incident/loss occurred Request body Yes
incidentDescription Description of the incident Request body Yes
amountClaimedCurrency 3-digit ISO code for country currency of the total amount to be claimed Request body Yes
amountClaimed Total amount to be claimed Request body Yes
isClaimCoveredByOtherInsurer Boolean indicator to know if the claim is covered by other insurance policy Request body Yes
claimantName Name of person creating the claim Request body Yes
contactNumber Claimant contact number Request body Yes
Email Claimant email address Request body Yes
sendNotifToAgent Flag to send updates to agent Request body Yes
otherInsurerDetails Information required if claim is covered by other insurer Request body No
bankDetails Bank details and information where claim amount will be deposited Request body Yes

Response

Parameter Description Passed in
status SUCCESS / WARNING / ERROR Response body
messages Any detailed message for WARNING or ERROR results Response body
claimDetails Claim Details with claim number Response body

Sample

Sample Request Sample Response
{
"country": "HKG",
"policyNumber": "V0512084",
"dateOfLoss": "2023-10-04",
"policyHolderName": "AUTOTEST PERSONAL",
"securityNumber": "123456",
"incidentLocation": "HKG",
"incidentDescription": "motor accident",
"amountClaimedCurrency": "HKD",
"amountClaimed": 500.00,
"isClaimCoveredByOtherInsurer": true,
"claimantName": "ABCD",
"contactNumber": "12345678",
"email": "[email protected]",
"sendNotifToAgent": true,
"otherInsurerDetails": {
"nameOfInsuranceCompany": "TEST C",
"policyNumber": "E0180472",
"withClaim": true
},
"bankDetails": {
"accountHolderName": "GAMMON CONSTRUCTION LIMITED",
"bankCode": "004 | HSBC",
"branchCode": 123,
"accountNumber": 123456789
}
} 		{
"action": "LodgeClaim",
"messageHeader": {
"partnerId": "05110014",
"transactionId": "hkgsysmotor"
},
"status": "Success",
"productType": "MVA",
"claimNumber": "VC077818",
"policyNumber": "V0512084",
"policyHolderName": "AUTOTEST PERSONAL",
"dateOfLoss": "2023-10-04"
}

Travel

Description
This API endpoint performs premium calculation and business validation on the provided information to determine if it can be processed as a straight-through transaction.

 

Path
POST /quotes/premiums


Request

Parameter Description Passed in Required
x-Partner-Id Unique identifier of the client making the API call HTTP Header Yes
x-Transaction-Id Unique ID for the request message HTTP Header Yes
Policy Full Policy Information Request body Yes

Response

Parameter Description Passed in
status SUCCESS / WARNING / ERROR Response body
messages Any detailed message for WARNING or ERROR results Response body
premium Calculated price / premium Response body

Sample

Sample Request Sample Response
{
"expiryDate" : "2023-11-30",
"country" : "HKG",
"product" : "TRAVEL",
"risks" : [ {
"attachmentDate" : "2023-07-28",
"travel" : {
"numberOfSeniors" : 0,
"coverType" : "PTRHBS",
"numberOfChildren" : 1,
"planType" : "ID",
"numberOfAdults" : 4,
"oneWayCover" : false,
"printChineseDoc" : false,
"majorDestination" : "9",
"plan" : "2",
"insuredPersons" : [ {
"fullTimeStudent" : "N",
"fullName" : "FirstNameY LastNameT",
"dateOfBirth" : "1986-01-01",
"IDNumber" : "C668668(E)"
}, {
"fullTimeStudent" : "N",
"fullName" : "FirstNamesp LastNameTsp",
"dateOfBirth" : "1988-01-01",
"IDNumber" : "Z7126108"
}, {
"fullTimeStudent" : "N",
"fullName" : "FirstNameYch LastNameTch",
"dateOfBirth" : "2010-01-01",
"IDNumber" : "V600153A"
}, {
"fullTimeStudent" : "N",
"fullName" : "FirstNameYch LastNameTch",
"dateOfBirth" : "1990-01-01",
"IDNumber" : "V600153A"
}, {
"fullTimeStudent" : "N",
"fullName" : "FirstNameYch LastNameTch",
"dateOfBirth" : "1991-01-01",
"IDNumber" : "V600153A"
} ]
}
]
}
 		{
"status": "SUCCESS",
"action": "quoteRate",
"messageHeader": {
"partnerId": "05110014",
"transactionId": "CHG0276369-rateQuoteTest"
},
"premium": {
"annualPremium": 888.25,
"premiumDue": 888.25,
"gst": 0,
"totalDue": 889.14,
"totalDiscount": 0,
"totalLoading": 0,
"totalCommission": {
"commissionRate": 40,
"commissionAmount": 355.3
},
"charges": [
{
"chargeDescription": "IA LEVY",
"value": 0.89
}
]
}
}

Description
This API endpoint allows a partner to officially bind a policy with QBE. The transaction will send the policy documents to the indicated insured’s e-mail address.

 

Path
POST /policies


Request

Parameter Description Passed in Required
x-Partner-Id Unique identifier of the client making the API call HTTP Header Yes
x-Transaction-Id Unique ID for the request message HTTP Header Yes
Policy Full Policy Information Request body Yes
suppressCustDocsFlag boolean to determine if customer documents will be sent to client (default: false) URL No

Response

Parameter Description Passed in
status SUCCESS / WARNING / ERROR Response body
messages Any detailed message for WARNING or ERROR results Response body
policyNumber Unique policy number allocated by QBE Response body
policyStatus INFORCED NEW BUSINESS / REFERRED Response body

Sample

Sample Request Sample Response
{
"expiryDate" : "2023-11-30",
"country" : "HKG",
"product" : "TRAVEL",
"risks" : [ {
"attachmentDate" : "2023-07-28",
"travel" : {
"numberOfSeniors" : 0,
"coverType" : "PTRHBS",
"numberOfChildren" : 1,
"planType" : "ID",
"numberOfAdults" : 4,
"oneWayCover" : false,
"printChineseDoc" : false,
"majorDestination" : "9",
"plan" : "2",
"insuredPersons" : [ {
"fullTimeStudent" : "N",
"fullName" : "FirstNameY LastNameT",
"dateOfBirth" : "1986-01-01",
"IDNumber" : "C668668(E)"
}, {
"fullTimeStudent" : "N",
"fullName" : "FirstNamesp LastNameTsp",
"dateOfBirth" : "1988-01-01",
"IDNumber" : "Z7126108"
}, {
"fullTimeStudent" : "N",
"fullName" : "FirstNameYch LastNameTch",
"dateOfBirth" : "2010-01-01",
"IDNumber" : "V600153A"
}, {
"fullTimeStudent" : "N",
"fullName" : "FirstNameYch LastNameTch",
"dateOfBirth" : "1990-01-01",
"IDNumber" : "V600153A"
}, {
"fullTimeStudent" : "N",
"fullName" : "FirstNameYch LastNameTch",
"dateOfBirth" : "1991-01-01",
"IDNumber" : "V600153A"
} ]
}
]
}
 		{
"status": "SUCCESS",
"action": "createPolicy",
"messageHeader": {
"partnerId": "05110014",
"transactionId": "CHG0276369-policyCreateTest"
},
"policyNumber": "HPS12345678",
"policyStatus": "INFORCED NEW BUSINESS"
}

Description
This API endpoint returns the full policy information saved in QBE’s systems. This is applicable for both inforced policies and cover notes.

 

Path
GET /policies/{country}/{policy_id}


Request

Parameter Description Passed in Required
x-Partner-Id Unique identifier of the client making the API call HTTP Header Yes
x-Transaction-Id Unique ID for the request message HTTP Header Yes
country HKG, SGP URL Yes
policy_no Unique QBE policy number URL Yes

Response

Parameter Description Passed in
status SUCCESS / WARNING / ERROR Response body
messages Any detailed message for WARNING or ERROR results Response body
policyStatus INFORCED NEW BUSINESS / REFERRED / ISSUED COVER NOTE Response body
policy Full policy Information Response body
premium Calculated price / premium Response body
excess Excess section details for Private Motor Response body

Sample

Sample Request Sample Response
N/A {
"status": "SUCCESS",
"action": "loadPolicy",
"messageHeader": {
"partnerId": "05110014",
"transactionId": "getPolicyTest"
},
"policy": {
"policyNumber": "T0611055",
"policyStatus": "INFORCED NEW BUSINESS",
"country": "HKG",
"product": "TRAVEL",
"inceptionDate": "2023-11-28",
"effectiveDate": "2023-11-28",
"expiryDate": "2023-11-30",
"client": {
"clientKey": "05143203",
"clientAddress": {
"floorNumber": "",
"buildingName": "BUILDINGNAME",
"streetName": "STREETNAME",
"district": "ABC",
"city": "",
"province": "",
"country": "HKG",
"postcode": "",
"state": ""
},
"email": "[email protected]",
"phone": "",
"fullName": "FIRSTNAMEY LASTNAMET",
"gender": "MALE",
"salutation": "",
"birthDate": "1986-01-01",
"nationality": " ",
"HKID": "C668668(E)"
},
"risks": [
{
"travel": {
"coverType": "PTRHBS",
"plan": "2",
"planType": "ID",
"numberOfAdults": 4,
"numberOfChildren": 1,
"insuredPersons": [
{
"fullName": "FirstNameY LastNameT",
"dateOfBirth": "1986-01-01",
"IDNumber": "C668668(E)"
},
{
"fullName": "FirstNamesp LastNameTsp",
"dateOfBirth": "1988-01-01",
"IDNumber": "Z7126108"
},
{
"fullName": "FirstNameYch LastNameTch",
"dateOfBirth": "2010-01-01",
"IDNumber": "V600153A"
},
{
"fullName": "FirstNameYch LastNameTch",
"dateOfBirth": "1990-01-01",
"IDNumber": "V600153A"
},
{
"fullName": "FirstNameYch LastNameTch",
"dateOfBirth": "1991-01-01",
"IDNumber": "V600153A"
}
]
}
}
],
"premium": {
"annualPremium": 888.25,
"premiumDue": 888.25,
"gst": 0,
"totalDue": 889.14,
"totalDiscount": 0,
"totalLoading": 0,
"totalCommission": {
"commissionRate": 40,
"commissionAmount": 355.3
},
"charges": [
{
"chargeDescription": "IA LEVY",
"value": 0.89
}
]
}
}

Description
This API endpoint allows a partner to download the policy documents as PDF data for an existing quote or policy.

 

Path
GET /documents/{country}/{policy_id}


Request

Parameter Description Passed in Required
x-Partner-Id Unique identifier of the client making the API call HTTP Header Yes
x-Transaction-Id Unique ID for the request message HTTP Header Yes
country HKG, SGP URL Yes
policy_id Unique QBE quote or policy number URL Yes
suppressCustDocsFlag Boolean to determine if customer documents will be sent to the client (default: false) URL No

Response

Parameter Description Passed in
status SUCCESS / WARNING / ERROR Response body
messages Any detailed message for WARNING or ERROR results Response body
documents List of available documents and downloadable URLs Response body

Sample

Sample Request Sample Response
N/A {
"status": "SUCCESS",
"action": "getDocument",
"messageHeader": {
"partnerId": "05110014",
"transactionId": "getDocs"
},
"documents": [
{
"docDescription": "Schedule - Client Copy",
"url": "https://uat2-qnect.qbe.com/ebusiness/DocumentApiController/getApiDocument.do?token=yMY3vSQe1aJ7xxc6xaQvTvPbohlfg86XXcdSuPuKchO3n0cKjVWazjvWJP7qalLS4SridMWvGJ_PnTH_OqoT1ePZkvQdxlU6qvpd7CMUcXhk8HwSMmGox0FPgL1Ml2bRgOLZiWsO-J_7CAYqkuO_YXvBKDRHWsJ6qQdctZofZbqJXsnVDHwBH08LD6BVDT2f9f24dAdEk8wRyT2FAsFzLzP3xSYLiog_z6ks6PQCDnBtj4mAfsObB2ZtWtS10-Qx1JnaPqpK7ZMkAQpk25G2wJTHs7nJM-uAjLvtfYikyXOTHeFf2HZXUvwD5QPOwQbSvcF7Dh8WlDQ&iv=CDeamwXblJUJBsoVSPxpGw"
},
{
"docDescription": "Policy Wording",
"url": "https://uat2-qnect.qbe.com/ebusiness/DocumentApiController/getApiDocument.do?token=eSIjW2ODhSf0LLB0Ms_dCdc4TgJ8FSf6RoXsK8PN528tHX0J9w962xaQkItScIXDinYsWI55AW-r-VLIRGySP5Mv1Uh_mbqHpRrMQP80U6YZmuZvazUU4wSrvMaxjULClcbTB88cBo1sTQaWqJNMKZGfxCZhtBmB2oXY1o3G97bz77pvfR3yJG2gTHeK0Nvkv621-dcTdnceXoxNrJtYFXSobV33q8iPrKgk_69m-vZPxkv7MgGZIch3Hpw134_5-YlH12Ecl5x4CHcD3IdKwPSciLyd_NLFD0hqnKlM9LRJKYS4faELxN1wlZtpuA&iv=C_DcvqePlaXs9VUbwW9M_Q"
},
{
"docDescription": "Debit Credit Note - Client Copy",
"url": "https://uat2-qnect.qbe.com/ebusiness/DocumentApiController/getApiDocument.do?token=x2JELcYeqp1NAzU-LjRbhZTARTXz90FcccMsGDykJeBV1iK1wSSap8fFHpYEf9HMhmVRcrnUvbHnDHicRxu4FVTENcbcbv6DO5RxfQvusmb1-U8Y7m22DP-WcFsLeSKGbrsSYzwj8JBkcOp0jnMuu17uugazDzu3TPnSgvne1Gnrc5Wit0xE5PAP1L4KDuab0qWLDXojtKdX5nhBMtgESGUZ6JVW6Y48sLWUyIZP4m80sDZGo-yf1HLwKenHBg-VMGQ2E3jPFfGVegxttch9bJ8V8aVYB6hsDdBRzVd5mdqpmh1huPTcXFDsUUTEh7xU_-pXL-MI_jpTRIseogtcsyZC5w&iv=meRoJF3xbImnrSY2pyVqag"
},
{
"docDescription": "Summary of Benefits",
"url": "https://uat2-qnect.qbe.com/ebusiness/DocumentApiController/getApiDocument.do?token=NsA6ljSFP_BsnPYIcFnCVZwEQfM5Kf_pL5Y0SKj8Cjloo0MCGY7y1vacahY-aLmK5XyImscXg8PYUqd28eShvO9x-ccJvCCgeZrmQgGs2HWDMcpVM3PZbLshUXN85uPTRxIbtc3u5IB2oQMiJVsO-L2IEYQPCC2ltloic26QB6ZZ5S7reqZASDeIpcq-0ywo5Wp3NV7pC-w48v1fVCcfv_eIWM7m4W363BbDoRyuDkI_d6kMR8jzYhOj5fURvMiK85SY1IPgXc-UsD3eQHOTALBXzteRlC48Wmr26JNhyjOsHEtMQ5mbU23xiaZrwr4j0jJhRDX8Xg&iv=JMppCt1xIzCGOoSJ4ftliQ"
},
{
"docDescription": "Outbound Travel Alert",
"url": "https://uat2-qnect.qbe.com/ebusiness/DocumentApiController/getApiDocument.do?token=7hxf_R9L4Yc3P8-h4H-u6liFJMLEcabVGJbL-f5Sfq81oJoT0lBoMwfv0W8hnndvO6fmTdWZqq9hKrRd9Jl1TWlfq-LUKQtUd0fajtWAnzAvuMns3S7hUX4BYib3dILZ1Nrr2ipSOtFtNfiNf6oHQanu3wNh4Ttb8Tf9IZTFsoDeYQo12y2Lm3HvKvxN4EdxNoqeN2d3cHWHznw0xdOCShHzawkMtkvPHGwd9r2XwEqlodvsZ-qQkv8io8vmm63HXQyJLY_cG_JRD9QKPNAjrhYaJfYq_memx5XG4c2chAZa4VXsuV-mEat846w&iv=KikSmBLXUxKkfr3s4SgPfg"
},
{
"docDescription": "24-hr Worldwide Emergency Assistance Cards",
"url": "https://uat2-qnect.qbe.com/ebusiness/DocumentApiController/getApiDocument.do?token=7_pTU3byq3yZCSyFKvwBGM-FQJ_3GXVYSONYgcauOu9nna5n26uazdT2Ux7hJLfhO3FXtEX9cDieqmAPA2qqtuGoATxQFC-f6nRP_clqBYd61CO5_Ij8yagRRXGehT6f95-6I3zvIE73Ahafztdr3cA0jxZkq-adG9BlbnXBQMxRC1O3DAEZM-st_Qfx11u3Er40XILAmwJCd1QPwiHcYfOKRcEAxRrLVYr_a70S9rDsqO6vyB_ezwohRrxD_yanszWU1aKekTYkM8zL7p05BWnF4N2E_cLgIUsecXxgRjXBmRdgYi9_ppu6uILoqGqlACKL9PDss3YvV6SLTajSy79hqLfuR-52PIahPPYB&iv=cDx-Yht6JwRQeqlxUHhgJg"
},
{
"docDescription": "Certificate of Insurance",
"url": "https://uat2-qnect.qbe.com/ebusiness/DocumentApiController/getApiDocument.do?token=qCTW-J4p9W7YyzpUj8DpnT5yCHQan2XaluaPqEAKI5Rk7Cj2N08_9qh6pLZFZwQ9tJ9z8JfHIsjJVcXDTUaTqPQAwMl6H_yu5HJFSV3-IKUAlg2vTu24RB8UeLA9uhPQiqa9NN82SFWgfeEIIrpv_r1NQETHwVk2SYFtiVolHzaodJ_eWZo94RewdKb_sAlkqGS4EU4rFLbSCg6iYoLQJ0VDpLpKMzIYhy_gDl0NtwV7i-qXibBsalvhUYOnrci-4Qu6cei6OnIqFOzyHjGcxWTHjBsfFrd2NPiuO3vWx04Ur8eeNqEfjvBqxFjSPjK9TBxSknXJ_bPCOUOqLOc&iv=aqGXUe5q9FKvl-ob1xrsxg"
}
]
}

Description
This API endpoint allows a partner to get the status of an existing claim based on its current stage in the claims process.

 

Path
POST /claims/status


Request

Parameter Description Passed in Required
x-Partner-Id Unique identifier of the client making the API call HTTP Header Yes
x-Transaction-Id Unique ID for the request message HTTP Header Yes
claimNumber Claim Number lodged Request body Yes
policyNumber Policy number of the claim being made Request body Yes
country HKG, SGP Request body Yes
policyType Type of Policy Request body Yes
name Policyholder’s full name (as indicated in policy) Request body Yes
idNumber Policyholder’s full name (as indicated in policy) Request body Yes

Response

Parameter Description Passed in
status SUCCESS / WARNING / ERROR Response body
messages Any detailed message for WARNING or ERROR results Response body
claimStatus Array of claims with claim status associated with the requested claim number or policy number Response body

Sample

Sample Request Sample Response
{
"claimNumber": "TC059032",
"policyNumber": "",
"country": "HKG",
"name": "AUTOTEST PERSONAL",
"idNumber": "123456",
"policyType": "travel"
} 		{
"status": "SUCCESS",
"action": "InquireClaimStatus",
"messageHeader": {
"partnerId": "05110014",
"transactionId": "TC059032"
},
"claimStatus": [
{
"productType": "PIT",
"claimNumber": "TC059032",
"policyNumber": "T0597215",
"claimStatus": "Claim Received",
"policyHolderName": "AUTOTEST PERSONAL",
"dateOfLoss": "2023-01-03"
}
]
}

Description
This API endpoint allows a partner to register a claim for any valid QBE policy if the date of loss falls within the policy’s period of cover.

 

Path
POST /claims


Request

Parameter Description Passed in Required
x-Partner-Id Unique identifier of the client making the API call HTTP Header Yes
x-Transaction-Id Unique ID for the request message HTTP Header Yes
country 3-digit ISO code for countries Request body Yes
policyNumber Policy number of the claim being made Request body Yes
dateOfLoss Date of Loss or when the incident occurred Request body Yes
policyHolderName Policyholder’s full name (as indicated in policy) Request body Yes
securityNumber Policy Holder’s Security ID Number (HKID or Passport Number as indicated in policy) Request body Yes
incidentLocation 3-digit ISO code for country where the incident/loss occurred Request body Yes
incidentDescription Description of the incident Request body Yes
amountClaimedCurrency 3-digit ISO code for country currency of the total amount to be claimed Request body Yes
amountClaimed Total amount to be claimed Request body Yes
isClaimCoveredByOtherInsurer Boolean indicator to know if the claim is covered by other insurance policy Request body Yes
claimantName Name of person creating the claim Request body Yes
contactNumber Claimant contact number Request body Yes
Email Claimant email address Request body Yes
sendNotifToAgent Flag to send updates to agent Request body Yes
otherInsurerDetails Information required if claim is covered by other insurer Request body No
bankDetails Bank details and information where claim amount will be deposited Request body Yes

Response

Parameter Description Passed in
status SUCCESS / WARNING / ERROR Response body
messages Any detailed message for WARNING or ERROR results Response body
claimDetails Claim Details with claim number Response body

Sample

Sample Request Sample Response
{
"country": "HKG",
"policyNumber": "T0597215",
"dateOfLoss": "2023-10-04",
"policyHolderName": "AUTOTEST PERSONAL",
"securityNumber": "123456",
"incidentLocation": "HKG",
"incidentDescription": "travel acc test",
"amountClaimedCurrency": "HKD",
"amountClaimed": 1500.00,
"isClaimCoveredByOtherInsurer": true,
"claimantName": "ABCD",
"contactNumber": "12345678",
"contactNumberCountryCode": "+852",
"email": "[email protected]",
"sendNotifToAgent": true,
"otherInsurerDetails": {
"nameOfInsuranceCompany": "TEST C",
"policyNumber": "E0180472",
"withClaim": true
},
"bankDetails": {
"accountHolderName": "GAMMON CONSTRUCTION LIMITED",
"bankCode": "004 | HSBC",
"branchCode": 123,
"accountNumber": 123456789
}
} 		{
"action": "LodgeClaim",
"messageHeader": {
"partnerId": "05110014",
"transactionId": "hkgsystravel"
},
"status": "Success",
"productType": "PIT",
"claimNumber": "TC059439",
"policyNumber": "T0597215",
"policyHolderName": "AUTOTEST PERSONAL",
"dateOfLoss": "2023-10-04"
}

Home

Description
This API endpoint performs premium calculation and business validation on the provided information to determine if it can be processed as a straight-through transaction.

 

Path
POST /quotes/premiums


Request

Parameter Description Passed in Required
x-Partner-Id Unique identifier of the client making the API call HTTP Header Yes
x-Transaction-Id Unique ID for the request message HTTP Header Yes
Policy Full Policy Information Request body Yes

Response

Parameter Description Passed in
status SUCCESS / WARNING / ERROR Response body
messages Any detailed message for WARNING or ERROR results Response body
premium Calculated price / premium Response body

Sample

Sample Request Sample Response
{
"country": "HKG",
"product": "HOME",
"inceptionDate": "2023-12-15",
"expiryDate": "2024-12-14",
"risks": [
{
"riskNumber": "0",
"attachmentDate": "2022-12-15",
"home": {
"planType": "PM",
"floorArea": "G0700",
"buildingType": "MS",
"noClaimDiscount": 0,
"occupancyType": "0002",
"contentsSumInsured": 1000000,
"floorAreaType": "G",
"buildingSumInsured": 100000,
"liabilityToOthers": 5000000,
"personalAccidentSI": 100000,
"specifiedValuables": [],
"homeEmployees": [],
"insuredAddress": {
"floorNumber": "",
"buildingName": "RICE MERCHANTS BUILD",
"streetName": "77-78 CONNAUGHT ROAD WEST",
"district": "",
"city": "",
"province": "",
"country": "HKG",
"postcode": "",
"accumulationRegister": "0054805"
},
"historyQuestions": {
"past3Years": false,
"past3YearsText": "",
"declinedInsurance": false,
"declinedInsuranceText": ""
}
}
}
]
} 		{
"status": "SUCCESS",
"action": "quoteRate",
"messageHeader": {
"partnerId": "05110014",
"transactionId": "RateQuoteSample"
},
"premium": {
"annualPremium": 1041,
"premiumDue": 1041,
"gst": 0,
"totalDue": 1042.04,
"totalDiscount": 0,
"totalLoading": 0,
"totalCommission": {
"commissionRate": 40,
"commissionAmount": 416.4
},
"charges": [
{
"chargeDescription": "IA LEVY",
"value": 1.04
}
]
}
}

Description
This API endpoint allows a partner to save a quotation to with QBE that can be retrieved or converted to a policy later within 30-60 days, depending on the product.

 

Path
POST /quotes


Request

Parameter Description Passed in Required
x-Partner-Id Unique identifier of the client making the API call HTTP Header Yes
x-Transaction-Id Unique ID for the request message HTTP Header Yes
Policy Full quote Information Request body Yes
suppressCustDocsFlag boolean to determine if customer documents will be sent to client (default: false) URL No

Response

Parameter Description Passed in
status SUCCESS / WARNING / ERROR Response body
messages Any detailed message for WARNING or ERROR results Response body
quoteNumber Unique quote number allocated by QBE Response body
quoteStatus ISSUED / ISSUED WITH REFERRAL Response body

Sample

Sample Request Sample Response
{
"country": "HKG",
"product": "HOME",
"inceptionDate": "2023-12-15",
"expiryDate": "2024-12-14",
"risks": [
{
"riskNumber": "0",
"attachmentDate": "2022-12-15",
"home": {
"planType": "PM",
"floorArea": "G0700",
"buildingType": "MS",
"noClaimDiscount": 0,
"occupancyType": "0002",
"contentsSumInsured": 1000000,
"floorAreaType": "G",
"buildingSumInsured": 100000,
"liabilityToOthers": 5000000,
"personalAccidentSI": 100000,
"specifiedValuables": [],
"homeEmployees": [],
"insuredAddress": {
"floorNumber": "",
"buildingName": "RICE MERCHANTS BUILD",
"streetName": "77-78 CONNAUGHT ROAD WEST",
"district": "",
"city": "",
"province": "",
"country": "HKG",
"postcode": "",
"accumulationRegister": "0054805"
},
"historyQuestions": {
"past3Years": false,
"past3YearsText": "",
"declinedInsurance": false,
"declinedInsuranceText": ""
}
}
}
],
"client": {
"email": "[email protected]",
"clientAddress": {
"streetName": "taipo",
"country": "HKG"
},
"fullName": "TEST TEST",
"gender": "MALE",
"birthDate": "1979-12-26",
"nationality": "HKG",
"HKID": "A5678903"
}
} 		{
"status": "SUCCESS",
"action": "issueQuote",
"messageHeader": {
"partnerId": "05110014",
"transactionId": "saveQuoteTest"
},
"quoteNumber": "00561822",
"quoteStatus": "SAVED QUOTE"
}

Description
This API endpoint allows a partner to officially bind a policy with QBE. The transaction will send the policy documents to the indicated insured’s e-mail address.

 

Path
POST /policies


Request

Parameter Description Passed in Required
x-Partner-Id Unique identifier of the client making the API call HTTP Header Yes
x-Transaction-Id Unique ID for the request message HTTP Header Yes
Policy Full Policy Information Request body Yes
suppressCustDocsFlag boolean to determine if customer documents will be sent to client (default: false) URL No

Response

Parameter Description Passed in
status SUCCESS / WARNING / ERROR Response body
messages Any detailed message for WARNING or ERROR results Response body
policyNumber Unique policy number allocated by QBE Response body
policyStatus INFORCED NEW BUSINESS / REFERRED Response body

Sample

Sample Request Sample Response
{
"country": "HKG",
"product": "HOME",
"inceptionDate": "2023-12-15",
"expiryDate": "2024-12-14",
"risks": [
{
"riskNumber": "0",
"attachmentDate": "2022-12-15",
"home": {
"planType": "PM",
"floorArea": "G0700",
"buildingType": "MS",
"noClaimDiscount": 0,
"occupancyType": "0002",
"contentsSumInsured": 1000000,
"floorAreaType": "G",
"buildingSumInsured": 100000,
"liabilityToOthers": 5000000,
"personalAccidentSI": 100000,
"specifiedValuables": [],
"homeEmployees": [],
"insuredAddress": {
"floorNumber": "",
"buildingName": "RICE MERCHANTS BUILD",
"streetName": "77-78 CONNAUGHT ROAD WEST",
"district": "",
"city": "",
"province": "",
"country": "HKG",
"postcode": "",
"accumulationRegister": "0054805"
},
"historyQuestions": {
"past3Years": false,
"past3YearsText": "",
"declinedInsurance": false,
"declinedInsuranceText": ""
}
}
}
],
"client": {
"email": "[email protected]",
"clientAddress": {
"streetName": "taipo",
"country": "HKG"
},
"fullName": "TEST TEST",
"gender": "MALE",
"birthDate": "1979-12-26",
"nationality": "HKG",
"HKID": "A5678903"
}
} 		{
"status": "SUCCESS",
"action": "quoteUpdate",
"messageHeader": {
"partnerId": "05110014",
"transactionId": "issuePolicy-11082023Home"
},
"policyNumber": "H0255180",
"policyStatus": "INFORCED NEW BUSINESS"
}

Description
This API endpoint allows a partner to provide an existing Motor cover note policy number to QBE and QBE will automatically retrieve the details of the policy and convert to a New Business in forced policy internally. Only applicable for Hong Kong.

 

Path
POST /policies/convert


Request

Parameter Description Passed in Required
x-Partner-Id Unique identifier of the client making the API call HTTP Header Yes
x-Transaction-Id Unique ID for the request message HTTP Header Yes
quoteDetails Quote Number and Country Request body Yes
suppressCustDocsFlag boolean to determine if customer documents will be sent to client (default: false) URL No

Response

Parameter Description Passed in
status SUCCESS / WARNING / ERROR Response body
messages Any detailed message for WARNING or ERROR results Response body
policyNumber Unique Policy Number Response body
policyStatus INFORCED NEW BUSINESS / REFERRED / ISSUED COVER NOTE Response body

Sample

Sample Request Sample Response
{
"country" : "HKG",
"quoteNumber" : "00561822"
} 		{
"status": "SUCCESS",
"action": "convertToPolicy",
"messageHeader": {
"partnerId": "05110014",
"transactionId": "convertPol"
},
"policyNumber": "H0255181",
"policyStatus": "INFORCED NEW BUSINESS"
}

Description
This API endpoint returns the full quote information saved in QBE’s systems.

 

Path
GET /quotes/{country}/{quote_id}


Request

Parameter Description Passed in Required
x-Partner-Id Unique identifier of the client making the API call HTTP Header Yes
x-Transaction-Id Unique ID for the request message HTTP Header Yes
country HKG, SGP URL Yes
quote_id Unique QBE quote number URL Yes
suppressCustDocsFlag boolean to determine if customer documents will be sent to client (default: false) URL No

Response

Parameter Description Passed in
status SUCCESS / WARNING / ERROR Response body
messages Any detailed message for WARNING or ERROR results Response body
Policy Full Saved Quote Information Response body

Sample

Sample Request Sample Response
N/A {
"status": "SUCCESS",
"action": "loadQuote",
"messageHeader": {
"partnerId": "05110014",
"transactionId": "getQuote"
},
"policy": {
"policyNumber": "00561822",
"policyStatus": "SAVED QUOTE",
"country": "HKG",
"product": "HOME",
"inceptionDate": "2023-12-15",
"effectiveDate": "2023-12-15",
"expiryDate": "2024-12-14",
"client": {
"clientKey": "05143204",
"clientAddress": {
"streetName": "TAIPO",
"country": "HKG"
},
"email": "[email protected]",
"fullName": "TEST TEST",
"gender": "MALE",
"birthDate": "1979-12-26",
"nationality": "HKG",
"HKID": "A5678903"
},
"risks": [
{
"home": {
"planType": "PM",
"contentsSumInsured": 1000000,
"buildingSumInsured": 100000,
"liabilityToOthers": 5000000,
"insuredAddress": {
"streetName": "77-78 CONNAUGHT ROAD WEST",
"city": "HONG KONG"
}
},
"riskNumber": "1",
"attachmentDate": "2023-12-15"
}
]
},
"premium": {
"annualPremium": 1041,
"totalDue": 1042.04,
"commissionRate": 40,
"commissionAmount": 416.4,
"charges": [
{
"chargeDescription": "IA LEVY",
"value": 1.04
}
]
}
}

Description
This API endpoint returns the full policy information saved in QBE’s systems. This is applicable for both inforced policies and cover notes.

 

Path
GET /policies/{country}/{policy_id}


Request

Parameter Description Passed in Required
x-Partner-Id Unique identifier of the client making the API call HTTP Header Yes
x-Transaction-Id Unique ID for the request message HTTP Header Yes
country HKG, SGP URL Yes
policy_no Unique QBE policy number URL Yes

Response

Parameter Description Passed in
status SUCCESS / WARNING / ERROR Response body
messages Any detailed message for WARNING or ERROR results Response body
policyStatus INFORCED NEW BUSINESS / REFERRED / ISSUED COVER NOTE Response body
policy Full policy Information Response body
premium Calculated price / premium Response body
excess Excess section details for Private Motor Response body

Sample

Sample Request Sample Response
N/A {
"status": "SUCCESS",
"action": "loadPolicy",
"messageHeader": {
"partnerId": "05110014",
"transactionId": "getPolicyTest"
},
"policy": {
"policyNumber": "H0255180",
"policyStatus": "INFORCED NEW BUSINESS",
"country": "HKG",
"product": "HOME",
"inceptionDate": "2023-12-15",
"effectiveDate": "2023-12-15",
"expiryDate": "2024-12-14",
"client": {
"clientKey": "05143205",
"clientAddress": {
"floorNumber": "",
"buildingName": "",
"streetName": "TAIPO",
"district": "",
"city": "",
"province": "",
"country": "HKG",
"postcode": "",
"state": ""
},
"email": "[email protected]",
"phone": "",
"fullName": "TEST TEST",
"gender": "MALE",
"salutation": "",
"birthDate": "1979-12-26",
"nationality": "HKG",
"HKID": "A5678903"
},
"risks": [
{
"home": {
"planType": "PM",
"optionalExtensions": [
{
"numberOfEmployees": 0,
"totalSumInsured": 0
}
],
"specifiedValuables": [],
"homeEmployees": [],
"historyQuestions": {
"past3Years": false,
"declinedInsurance": false
},
"insuredAddress": {
"accumulationRegister": "0054805",
"addressDisplay": "RICE MERCHANTS BUILD, 77-78 CONNAUGHT ROAD WEST, HONG KONG",
"floorNumber": "",
"buildingName": "RICE MERCHANTS BUILD",
"streetName": "77-78 CONNAUGHT ROAD WEST",
"district": "",
"city": "",
"province": "",
"country": "HKG",
"postcode": ""
},
"occupancyType": "0002",
"contentsSumInsured": 1000000,
"buildingSumInsured": 100000,
"liabilityToOthers": 5000000,
"floorArea": "G0700",
"actualFloorArea": 0,
"buildingType": "MS",
"noClaimDiscount": 0
},
"riskNumber": "1",
"attachmentDate": "2023-12-15"
}
]
},
"premium": {
"annualPremium": 1041,
"premiumDue": 1041,
"gst": 0,
"totalDue": 1042.04,
"totalDiscount": 0,
"totalLoading": 0,
"totalCommission": {
"commissionRate": 40,
"commissionAmount": 416.4
},
"charges": [
{
"chargeDescription": "IA LEVY",
"value": 1.04
}
]
}
}

Description
This API endpoint allows a partner to search and select a location or address for a Home quote or policy. For Hong Kong, the partner can pass any text string. For Singapore, the partner can pass the Singaporean postal codes.

 

Path
GET /locations/{country}?queryString={queryString}


Request

Parameter Description Passed in Required
x-Partner-Id Unique identifier of the client making the API call HTTP Header Yes
x-Transaction-Id Unique ID for the request message HTTP Header Yes
country SGP, HKG URL Yes
queryString For Hong Kong, enter the text to search
For Singapore, enter the postcode to search		 URL Yes

Response

Parameter Description Passed in
addresses List of addresses with their IDs and details Response body

Sample

Sample Request Sample Response
N/A {
"status": "SUCCESS",
"action": "addressSearch",
"messageHeader": {
"partnerId": "05110014",
"transactionId": "CHG0276369-testGetLoc"
},
"address": [
{
"accumulationRegister": "H00035256",
"addressDisplay": "15 & 18 TEMPORARY HA, HONG KONG",
"floorNumber": "",
"buildingName": "",
"streetName": "15 & 18 TEMPORARY HA",
"district": "",
"city": "",
"province": "",
"country": "HKG",
"postcode": ""
},
{
"accumulationRegister": "H00047331",
"addressDisplay": "TEMPORARY COOKED, 30 HAIPHONG ROAD, HONG KONG",
"floorNumber": "",
"buildingName": "TEMPORARY COOKED",
"streetName": "30 HAIPHONG ROAD",
"district": "",
"city": "",
"province": "",
"country": "HKG",
"postcode": ""
},
{
"accumulationRegister": "H00050520",
"addressDisplay": "TEMPORARY HAWKER, TUNG YAN STREET, HONG KONG",
"floorNumber": "",
"buildingName": "TEMPORARY HAWKER",
"streetName": "TUNG YAN STREET",
"district": "",
"city": "",
"province": "",
"country": "HKG",
"postcode": ""
},
{
"accumulationRegister": "H00051922",
"addressDisplay": "123 KAM TIN ROAD, HONG KONG",
"floorNumber": "",
"buildingName": "",
"streetName": "123 KAM TIN ROAD",
"district": "",
"city": "",
"province": "",
"country": "HKG",
"postcode": ""
},
{
"accumulationRegister": "H00052263",
"addressDisplay": "COOKED FOOD HAWKER, 33-35 RECLAMATION STREET, HONG KONG",
"floorNumber": "",
"buildingName": "COOKED FOOD HAWKER",
"streetName": "33-35 RECLAMATION STREET",
"district": "",
"city": "",
"province": "",
"country": "HKG",
"postcode": ""
}
]
}

Description
This API endpoint allows a partner to download the policy documents as PDF data for an existing quote or policy.

 

Path
GET /documents/{country}/{policy_id}


Request

Parameter Description Passed in Required
x-Partner-Id Unique identifier of the client making the API call HTTP Header Yes
x-Transaction-Id Unique ID for the request message HTTP Header Yes
country HKG, SGP URL Yes
policy_id Unique QBE quote or policy number URL Yes
suppressCustDocsFlag boolean to determine if customer documents will be sent to client (default: false) URL No

Response

Parameter Description Passed in
status SUCCESS / WARNING / ERROR Response body
messages Any detailed message for WARNING or ERROR results Response body
documents List of available documents and downloadable URLs Response body

Sample

Sample Request Sample Response
N/A {
"status": "SUCCESS",
"action": "getDocument",
"messageHeader": {
"partnerId": "05110014",
"transactionId": "getDocs"
},
"documents": [
{
"docDescription": "Schedule - Client Copy",
"url": "https://uat2-qnect.qbe.com/ebusiness/DocumentApiController/getApiDocument.do?token=kJ0omKvHSaN9MFjH9dZ83SuEJtxRv6HOCUzmgIkHJnWX8oKXBWOqyyJ_D8bkKI8uGHAqm5wgEJxm_clqaeIMoeHcs3SovMOWPd9PSkwdR6kvp27H7j1wdNYUGlGToIg701Z_OIxrRKwKrv6K5BfN1TXSnJbbxnk0tcunajqNzHShASKawREylae-OgRUlP3nKByQKSApUvJFc9i_3XY8So4ygivzK38vlwA6caLwN3wassq07tmubTgn7kXcSx0R_x9GJFDB5SUyG5Enao_lnQ7AMqbN0F2Sf-PGJmtEgRiDf5B4dc_M5DV0LwdaHavGdATkHaojQfk&iv=3TKbthn9vqipIRT1N1e-gA"
},
{
"docDescription": "Debit Credit Note - Client Copy",
"url": "https://uat2-qnect.qbe.com/ebusiness/DocumentApiController/getApiDocument.do?token=Hr6-Yhfs8ww_hZMHmhpY1IrxXRHYS6sH7TudS1UNA2u7oD78_NE3_u03tIF-qCwfr85GbNKIRb6FuVUndY8lta2N3t10t6UVwr_ZMdoOTIsqi6tQH6J5UfMftq6VU_qxmEG4zjyhOshFuGmgxL9_vigdK0VylWFjNzVIKupX4kuwfsybvAzQyDeBJEzFZwqzDInehTkLUUYMDnymV4xeSr4sv-pKYTdWHbNTVw2_OwIYuaPv8ABeYnuG64dNdX1X21FQueL3TzoXjk4MLnN53vyQu3_dK5itPefPAffu7a7Iy706XbFjupvqv4w&iv=_DyPVu5USXgKmgYzmc7bEQ"
}
]
}

Description
This API endpoint allows a partner to get the status of an existing claim based on its current stage in the claims process.

 

Path
POST /claims/status


Request

Parameter Description Passed in Required
x-Partner-Id Unique identifier of the client making the API call HTTP Header Yes
x-Transaction-Id Unique ID for the request message HTTP Header Yes
claimNumber Claim Number lodged Request body Yes
policyNumber Policy number of the claim being made Request body Yes
country HKG, SGP Request body Yes
policyType Type of Policy Request body Yes
Name Policyholder’s full name (as indicated in policy) Request body Yes
idNumber Policy Holder’s Security ID Number (HKID or Passport Number as indicated in policy) Request body Yes

Response

Parameter Description Passed in
status SUCCESS / WARNING / ERROR Response body
messages Any detailed message for WARNING or ERROR results Response body
claimStatus Array of claims with claim status associated with the requested claim number or policy number Response body

Sample

Sample Request Sample Response
{
"claimNumber": "HC010490",
"policyNumber": "",
"country": "HKG",
"name" : "AUTOTEST PERSONAL",
"idNumber": "123456",
"policyType": "home"
} 		{
"status": "SUCCESS",
"action": "InquireClaimStatus",
"messageHeader": {
"partnerId": "05110014",
"transactionId": "HC010490"
},
"claimStatus": [
{
"productType": "HPK",
"claimNumber": "HC010490",
"policyNumber": "H0255422",
"claimStatus": "Claim Received",
"policyHolderName": "AUTOTEST PERSONAL",
"dateOfLoss": "2023-03-03"
}
]
}

Description
This API endpoint allows a partner to register a claim for any valid QBE policy if the date of loss falls within the policy’s period of cover.

 

Path
POST /claims


Request

Parameter Description Passed in Required
x-Partner-Id Unique identifier of the client making the API call HTTP Header Yes
x-Transaction-Id Unique ID for the request message HTTP Header Yes
country 3-digit ISO code for countries Request body Yes
policyNumber Policy number of the claim being made Request body Yes
dateOfLoss Date of Loss or when the incident occurred Request body Yes
policyHolderName Policyholder’s full name (as indicated in policy) Request body Yes
securityNumber Policy Holder’s Security ID Number (HKID or Passport Number as indicated in policy) Request body Yes
incidentLocation 3-digit ISO code for country where the incident/loss occurred Request body Yes
incidentDescription Description of the incident Request body Yes
amountClaimedCurrency 3-digit ISO code for country currency of the total amount to be claimed Request body Yes
amountClaimed Total amount to be claimed Request body Yes
isClaimCoveredByOtherInsurer Boolean indicator to know if the claim is covered by other insurance policy Request body Yes
claimantName Name of person creating the claim Request body Yes
contactNumber Claimant contact number Request body Yes
Email Claimant email address Request body Yes
sendNotifToAgent Flag to send updates to agent Request body Yes
otherInsurerDetails Information required if claim is covered by other insurer Request body No
bankDetails Bank details and information where claim amount will be deposited Request body Yes

Response

Parameter Description Passed in
status SUCCESS / WARNING / ERROR Response body
messages Any detailed message for WARNING or ERROR results Response body
claimDetails Claim Details with claim number Response body

Sample

Sample Request Sample Response
{
"country": "HKG",
"policyNumber": "H0255422",
"dateOfLoss": "2023-10-04",
"policyHolderName": "AUTOTEST PERSONAL",
"securityNumber": "123456",
"incidentLocation": "HKG",
"incidentDescription": "hkgsyshome test",
"amountClaimedCurrency": "HKD",
"amountClaimed": 1000.00,
"isClaimCoveredByOtherInsurer": true,
"claimantName": "ABCD",
"contactNumber": "12345678",
"contactNumberCountryCode": "+852",
"email": "[email protected]",
"sendNotifToAgent": true,
"otherInsurerDetails": {
"nameOfInsuranceCompany": "TEST C",
"policyNumber": "E0180472",
"withClaim": true
},
"bankDetails": {
"accountHolderName": "GAMMON CONSTRUCTION LIMITED",
"bankCode": "004 | HSBC",
"branchCode": 123,
"accountNumber": 123456789
}
} 		{
"action": "LodgeClaim",
"messageHeader": {
"partnerId": "05110014",
"transactionId": "hkgsyshome"
},
"status": "Success",
"productType": "HPK",
"claimNumber": "HC010601",
"policyNumber": "H0255422",
"policyHolderName": "AUTOTEST PERSONAL",
"dateOfLoss": "2023-10-04"
}

Domestic Helper

Description
This API endpoint performs premium calculation and business validation on the provided information to determine if it can be processed as a straight-through transaction.

 

Path
POST /quotes/premiums


Request

Parameter Description Passed in Required
x-Partner-Id Unique identifier of the client making the API call HTTP Header Yes
x-Transaction-Id Unique ID for the request message HTTP Header Yes
Policy Full Policy Information Request body Yes

Response

Parameter Description Passed in
status SUCCESS / WARNING / ERROR Response body
messages Any detailed message for WARNING or ERROR results Response body
premium Calculated price / premium Response body

Sample

Sample Request Sample Response
{
"country": "HKG",
"product": "DOMESTIC HELPER",
"inceptionDate": "2023-12-20",
"effectiveDate": "2023-12-20",
"expiryDate": "2024-12-19",
"policyNumber": "",
"policyStatus": "",
"risks": [
{
"riskNumber": "0",
"attachmentDate": "2023-02-07",
"domesticHelper": {
"planType": "BS",
"helperNationality": "IDN",
"yearsOfCover": "1",
"isMedicalExpenseCHD": false,
"helpersName": "Raymond the Helper",
"dateOfBirth": "1986-02-10",
"idNumber": "439349399"
}
}
]
} 		{
"status": "SUCCESS",
"action": "quoteRate",
"messageHeader": {
"partnerId": "05110014",
"transactionId": "RateQuoteSample"
},
"premium": {
"annualPremium": 442.44,
"premiumDue": 442.44,
"gst": 0,
"totalDue": 450.44,
"totalDiscount": 0,
"totalLoading": 0,
"totalCommission": {
"commissionRate": 45,
"commissionAmount": 199.1
},
"charges": [
{
"chargeDescription": "LEVY",
"value": 8
}
]
}
}

Description
This API endpoint allows a partner to save a quotation to with QBE that can be retrieved or converted to a policy later within 30-60 days, depending on the product.

 

Path
POST /quotes


Request

Parameter Description Passed in Required
x-Partner-Id Unique identifier of the client making the API call HTTP Header Yes
x-Transaction-Id Unique ID for the request message HTTP Header Yes
Policy Full quote Information Request body Yes
suppressCustDocsFlag boolean to determine if customer documents will be sent to client (default: false) URL No

Response

Parameter Description Passed in
status SUCCESS / WARNING / ERROR Response body
messages Any detailed message for WARNING or ERROR results Response body
quoteNumber Unique quote number allocated by QBE Response body
quoteStatus ISSUED / ISSUED WITH REFERRAL Response body

Sample

Sample Request Sample Response
{
"country": "HKG",
"product": "DOMESTIC HELPER",
"inceptionDate": "2023-12-20",
"effectiveDate": "2023-12-20",
"expiryDate": "2024-12-19",
"policyNumber": "",
"policyStatus": "",
"risks": [
{
"riskNumber": "0",
"attachmentDate": "2023-02-07",
"domesticHelper": {
"planType": "BS",
"helperNationality": "IDN",
"yearsOfCover": "1",
"isMedicalExpenseCHD": false,
"helpersName": "Raymond the Helper",
"dateOfBirth": "1986-02-10",
"idNumber": "439349399"
}
}
],
"client": {
"email": "[email protected]",
"clientAddress": {
"buildingName": "building 1",
"floorNumber": "unit 1",
"streetName": "street 1",
"district": "polo ds",
"country": "HKG"
},
"fullName": "persona hkg",
"gender": "FEMALE",
"salutation": "MS",
"birthDate": "1987-01-01",
"nationality": "HKG",
"HKID": "009898"
}
} 		{
"status": "SUCCESS",
"action": "issueQuote",
"messageHeader": {
"partnerId": "05110014",
"transactionId": "saveQuoteTest"
},
"quoteNumber": "00561825",
"quoteStatus": "SAVED QUOTE"
}

Description
This API endpoint allows a partner to officially bind a policy with QBE. The transaction will send the policy documents to the indicated insured’s e-mail address.

 

Path
POST /policies


Request

Parameter Description Passed in Required
x-Partner-Id Unique identifier of the client making the API call HTTP Header Yes
x-Transaction-Id Unique ID for the request message HTTP Header Yes
Policy Full Policy Information Request body Yes
suppressCustDocsFlag boolean to determine if customer documents will be sent to client (default: false) URL No

Response

Parameter Description Passed in
status SUCCESS / WARNING / ERROR Response body
messages Any detailed message for WARNING or ERROR results Response body
policyNumber Unique policy number allocated by QBE Response body
policyStatus INFORCED NEW BUSINESS / REFERRED Response body

Sample

Sample Request Sample Response
{
"country": "HKG",
"product": "DOMESTIC HELPER",
"inceptionDate": "2023-12-20",
"effectiveDate": "2023-12-20",
"expiryDate": "2024-12-19",
"policyNumber": "",
"policyStatus": "",
"risks": [
{
"riskNumber": "0",
"attachmentDate": "2023-02-07",
"domesticHelper": {
"planType": "BS",
"helperNationality": "IDN",
"yearsOfCover": "1",
"isMedicalExpenseCHD": false,
"helpersName": "Raymond the Helper",
"dateOfBirth": "1986-02-10",
"idNumber": "439349399"
}
}
],
"client": {
"email": "[email protected]",
"clientAddress": {
"buildingName": "building 1",
"floorNumber": "unit 1",
"streetName": "street 1",
"district": "polo ds",
"country": "HKG"
},
"fullName": "persona hkg",
"gender": "FEMALE",
"salutation": "MS",
"birthDate": "1987-01-01",
"nationality": "HKG",
"HKID": "009898"
}
} 		{
"status": "SUCCESS",
"action": "quoteUpdate",
"messageHeader": {
"partnerId": "05110014",
"transactionId": "issuePolicy-11082023DH"
},
"policyNumber": "A0660841",
"policyStatus": "INFORCED NEW BUSINESS"
}

Description
This API endpoint allows a partner to provide an existing Motor cover note policy number to QBE and QBE will automatically retrieve the details of the policy and convert to a New Business in forced policy internally. Only applicable for Hong Kong.

 

Path
POST /policies/convert


Request

Parameter Description Passed in Required
x-Partner-Id Unique identifier of the client making the API call HTTP Header Yes
x-Transaction-Id Unique ID for the request message HTTP Header Yes
quoteDetails Quote Number and Country Request body Yes
suppressCustDocsFlag boolean to determine if customer documents will be sent to client (default: false) URL No

Response

Parameter Description Passed in
status SUCCESS / WARNING / ERROR Response body
messages Any detailed message for WARNING or ERROR results Response body
policyNumber Unique Policy Number Response body
policyStatus INFORCED NEW BUSINESS / REFERRED / ISSUED COVER NOTE Response body

Sample

Sample Request Sample Response
{
"country" : "HKG",
"quoteNumber" : "00561825"
} 		{
"status": "SUCCESS",
"action": "convertToPolicy",
"messageHeader": {
"partnerId": "05110014",
"transactionId": "convertPolDH"
},
"policyNumber": "A0660842",
"policyStatus": "INFORCED NEW BUSINESS"
}

Description
This API endpoint returns the full quote information saved in QBE’s systems.

 

Path
GET /quotes/{country}/{quote_id}


Request

Parameter Description Passed in Required
x-Partner-Id Unique identifier of the client making the API call HTTP Header Yes
x-Transaction-Id Unique ID for the request message HTTP Header Yes
country HKG, SGP URL Yes
quote_id Unique QBE quote number URL Yes
suppressCustDocsFlag boolean to determine if customer documents will be sent to client (default: false) URL No

Response

Parameter Description Passed in
status SUCCESS / WARNING / ERROR Response body
messages Any detailed message for WARNING or ERROR results Response body
Policy Full Saved Quote Information Response body

Sample

Sample Request Sample Response
N/A {
"status": "SUCCESS",
"action": "loadQuote",
"messageHeader": {
"partnerId": "05110014",
"transactionId": "getQuote"
},
"policy": {
"policyNumber": "00561825",
"policyStatus": "SAVED QUOTE",
"country": "HKG",
"product": "DOMESTIC HELPER",
"inceptionDate": "2023-12-20",
"effectiveDate": "2023-12-20",
"expiryDate": "2024-12-19",
"client": {
"clientKey": "05143207",
"clientAddress": {
"floorNumber": "UNIT 1",
"buildingName": "BUILDING 1",
"streetName": "STREET 1",
"district": "POLO DS",
"city": "",
"province": "",
"country": "HKG",
"postcode": "",
"state": ""
},
"email": "[email protected]",
"phone": "",
"fullName": "PERSONA HKG",
"gender": "FEMALE",
"salutation": "MS",
"birthDate": "1987-01-01",
"nationality": "HKG",
"HKID": "009898"
},
"risks": [
{
"domesticHelper": {
"planType": "BS",
"helperNationality": "IDN",
"yearsOfCover": "1",
"helpersName": "Raymond the Helper",
"dateOfBirth": "1986-02-10",
"idNumber": "439349399"
},
"riskNumber": "0",
"attachmentDate": ""
}
]
},
"premium": {
"annualPremium": 442.44,
"premiumDue": 442.44,
"gst": 0,
"totalDue": 450.44,
"totalDiscount": 0,
"totalLoading": 0,
"totalCommission": {
"commissionRate": 45,
"commissionAmount": 199.1
},
"charges": [
{
"chargeDescription": "LEVY",
"value": 8
}
]
}
}

Description
This API endpoint returns the full policy information saved in QBE’s systems. This is applicable for both inforced policies and cover notes.

 

Path
GET /policies/{country}/{policy_id}


Request

Parameter Description Passed in Required
x-Partner-Id Unique identifier of the client making the API call HTTP Header Yes
x-Transaction-Id Unique ID for the request message HTTP Header Yes
country HKG, SGP URL Yes
policy_no Unique QBE policy number URL Yes

Response

Parameter Description Passed in
status SUCCESS / WARNING / ERROR Response body
messages Any detailed message for WARNING or ERROR results Response body
policyStatus INFORCED NEW BUSINESS / REFERRED / ISSUED COVER NOTE Response body
policy Full policy Information Response body
premium Calculated price / premium Response body
excess Excess section details for Private Motor Response body

Sample

Sample Request Sample Response
N/A {
"status": "SUCCESS",
"action": "loadPolicy",
"messageHeader": {
"partnerId": "05110014",
"transactionId": "getPolicyTest"
},
"policy": {
"policyNumber": "A0660841",
"policyStatus": "INFORCED NEW BUSINESS",
"country": "HKG",
"product": "DOMESTIC HELPER",
"inceptionDate": "2023-12-20",
"effectiveDate": "2023-12-20",
"expiryDate": "2024-12-19",
"client": {
"clientKey": "05143208",
"clientAddress": {
"floorNumber": "UNIT 1",
"buildingName": "BUILDING 1",
"streetName": "STREET 1",
"district": "POLO DS",
"city": "",
"province": "",
"country": "HKG",
"postcode": "",
"state": ""
},
"email": "[email protected]",
"phone": "",
"fullName": "PERSONA HKG",
"gender": "FEMALE",
"salutation": "MS",
"birthDate": "1987-01-01",
"nationality": "HKG",
"HKID": "009898"
},
"risks": [
{
"domesticHelper": {
"planType": "BS",
"helperNationality": "IDN",
"yearsOfCover": "1",
"helpersName": "Raymond the Helper",
"dateOfBirth": "1986-02-10",
"idNumber": "439349399"
},
"riskNumber": "0",
"attachmentDate": ""
}
]
},
"premium": {
"annualPremium": 442.44,
"premiumDue": 442.44,
"gst": 0,
"totalDue": 450.44,
"totalDiscount": 0,
"totalLoading": 0,
"totalCommission": {
"commissionRate": 45,
"commissionAmount": 199.1
},
"charges": [
{
"chargeDescription": "LEVY",
"value": 8
}
]
}
}

Description
This API endpoint allows a partner to download the policy documents as PDF data for an existing quote or policy.

 

Path
GET /documents/{country}/{policy_id}


Request

Parameter Description Passed in Required
x-Partner-Id Unique identifier of the client making the API call HTTP Header Yes
x-Transaction-Id Unique ID for the request message HTTP Header Yes
country HKG, SGP URL Yes
policy_id Unique QBE quote or policy number URL Yes
suppressCustDocsFlag boolean to determine if customer documents will be sent to client (default: false) URL No

Response

Parameter Description Passed in
status SUCCESS / WARNING / ERROR Response body
messages Any detailed message for WARNING or ERROR results Response body
documents List of available documents and downloadable URLs Response body

Sample

Sample Request Sample Response
N/A {
"status": "SUCCESS",
"action": "getDocument",
"messageHeader": {
"partnerId": "05110014",
"transactionId": "getDocs"
},
"documents": [
{
"docDescription": "Schedule - Client Copy",
"url": "https://uat2-qnect.qbe.com/ebusiness/DocumentApiController/getApiDocument.do?token=m1yY3XDExsMUee-dc8D-Qy6UDAcEs0Pfe9rlzAff8kO6AvRDdgA8c6fcP-IJUhW05OKMAS_9NCXKBsFcDLOkF1vKaBnRAB25xNWMTUf7PLeseITibXFtPzbYdXMhivEa8DmqxF6aJu1TJ50FqrxbzPeMzFOYsX65N9BF7wr8KOl5uUPoiDhUKhLPixWZduh9-4vc49hIhRl_yMrtEc8dzkt8I864JrsPXnE4fy8dGNKWzpaJZ37sPJeOeJ_KCZ34Tm1mT2-JCRdadkRLTb1OBo3EFZNvkCdzch7BXaZeDGL4FH9R5Ug5L7j8GLEZ5a9n7ID_wyfbGLY&iv=6KfZhCQl9CjDjkdJvhZgDA"
},
{
"docDescription": "Policy Wording",
"url": "https://uat2-qnect.qbe.com/ebusiness/DocumentApiController/getApiDocument.do?token=ik9C4aqKgPHJbgYixideqCvwFj6hqrzkKDs1_VgViD3oxAFrnh0Dkd1v0Gc3cMDQJRx8ZSd2esXDintYceu2enfZSLF9_DnkmsN8H4d28Zq6VlQPVxTUSfntwZsj9SqBWR6dSJRzNDqz2A6P46kqi9Qed4IeK1mO_cHMhgAt_9ctpz_qLWs-KMrnaHyWVfXmAuqhhvAALvXGWPSQTQ5c90gkJ9xkD0tth_2T0_18zYg7KutvDJl9k_Z8vGYWi9i70ljNhuk0hQomk0gA57vDfdrKfXOdxi0z-eob46K75ADKW9ir8Ghgk0fgY9mFEQ&iv=SV3_ouzyPXgZkq8IHRmWQA"
},
{
"docDescription": "Debit Credit Note - Client Copy",
"url": "https://uat2-qnect.qbe.com/ebusiness/DocumentApiController/getApiDocument.do?token=DvUwF1DETh3BnvCezOiNf3g5OA1xlh3tifer4TR-8qN47RoxAzR-4Sqwr7qhv2WtncGBnD3jWr5ezWL5NhqPlRxWLx-ESVaZJafUOQcHdsdA9u27uODESkG-O0h4aQc-EYdrVEu5wLfkPIhgFXCfaF-IEHN1T0UYp_EInIb3C-ws5AOR3vZHeJFiyzsamBR8_3YkmFUCEHIueFHvmCnxDkaGzwtDWzNXu4abARo8bl4kUa9qOyoiPXGjLoHI7NPDX67DR0ksUYhsFwU5Y5FBrw67veGch6pCJt3C4ZpezPJfVTCjJThgHgIHP5pKT8CXMozX_eoX9KGQQDF3MEfe81hkyQ&iv=5de9Rgz1k966kteq9vgZ8w"
},
{
"docDescription": "Summary of Benefits",
"url": "https://uat2-qnect.qbe.com/ebusiness/DocumentApiController/getApiDocument.do?token=_y2WJLrLghvb0PC4mMVwHen70fFzNK1lD5uQGyhX1Xq9xljs1WKLx5QIUNtA9ASX_QLhw5Q3i8vk2SBVB-sz3fElEAeu2ngSMFhXOvYADrda1XvOTeChcjrQ3EBGa34p2p2GUTdWKtu6L2S4dzUBNX2IlBnxawFwPemXLWlrP25svBNessihWqu6t25vHkmQGsweLITA-BF_4T_lPRRlwlWBm3rFFvLEq1-jkjuNpDenNshOLWOejZ_F_SszPwf_em99K_Ey2dBA8AKoWRw8laJXuKIaPcv0U2NKYLiDT2P4-gWR6xKm2pQWWjA5oNVd-CTQIQBfgw&iv=J64K-e0TYIc4jPV-YFhv8w"
}
]
}

Description
This API endpoint allows a partner to get the status of an existing claim based on its current stage in the claims process.

 

Path
POST /claims/status


Request

Parameter Description Passed in Required
x-Partner-Id Unique identifier of the client making the API call HTTP Header Yes
x-Transaction-Id Unique ID for the request message HTTP Header Yes
claimNumber Claim Number lodged Request body Yes
policyNumber Policy number of the claim being made Request body Yes
country HKG, SGP Request body Yes
policyType Type of Policy Request body Yes
Name Policyholder’s full name (as indicated in policy) Request body Yes
idNumber Policy Holder’s Security ID Number (HKID or Passport Number as indicated in policy) Request body Yes

Response

Parameter Description Passed in
status SUCCESS / WARNING / ERROR Response body
messages Any detailed message for WARNING or ERROR results Response body
claimStatus Array of claims with claim status associated with the requested claim number or policy number Response body

Sample

Sample Request Sample Response
{
"claimNumber": "AC800370",
"policyNumber": "",
"country": "HKG",
"name" : "N WAI KAN WAN WAI K",
"idNumber": "K362671(7)",
"policyType": "domestichelper"
} 		{
"status": "SUCCESS",
"action": "InquireClaimStatus",
"messageHeader": {
"partnerId": "05110014",
"transactionId": "AC800370"
},
"claimStatus": [
{
"productType": "DMH",
"claimNumber": "AC800370",
"policyNumber": "A0659735",
"claimStatus": "Claim Received",
"policyHolderName": "N WAI KAN WAN WAI K",
"dateOfLoss": "2023-01-01"
}
]
}

Description
This API endpoint allows a partner to register a claim for any valid QBE policy if the date of loss falls within the policy’s period of cover.

 

Path
POST /claims


Request

Parameter Description Passed in Required
x-Partner-Id Unique identifier of the client making the API call HTTP Header Yes
x-Transaction-Id Unique ID for the request message HTTP Header Yes
country 3-digit ISO code for countries Request body Yes
policyNumber Policy number of the claim being made Request body Yes
dateOfLoss Date of Loss or when the incident occurred Request body Yes
policyHolderName Policyholder’s full name (as indicated in policy) Request body Yes
securityNumber Policy Holder’s Security ID Number (HKID or Passport Number as indicated in policy) Request body Yes
incidentLocation 3-digit ISO code for country where the incident/loss occurred Request body Yes
incidentDescription Description of the incident Request body Yes
amountClaimedCurrency 3-digit ISO code for country currency of the total amount to be claimed Request body Yes
amountClaimed Total amount to be claimed Request body Yes
isClaimCoveredByOtherInsurer Boolean indicator to know if the claim is covered by other insurance policy Request body Yes
claimantName Name of person creating the claim Request body Yes
contactNumber Claimant contact number Request body Yes
Email Claimant email address Request body Yes
sendNotifToAgent Flag to send updates to agent Request body Yes
otherInsurerDetails Information required if claim is covered by other insurer Request body No
bankDetails Bank details and information where claim amount will be deposited Request body Yes

Response

Parameter Description Passed in
status SUCCESS / WARNING / ERROR Response body
messages Any detailed message for WARNING or ERROR results Response body
claimDetails Claim Details with claim number Response body

Sample

Sample Request Sample Response
{
"country": "HKG",
"policyNumber": "A0659735",
"dateOfLoss": "2023-10-04",
"policyHolderName": "N WAI KAN WAN WAI K",
"securityNumber": "K362671(7)",
"incidentLocation": "HKG",
"incidentDescription": "hkgsysdomestic test",
"amountClaimedCurrency": "HKD",
"amountClaimed": 1300.00,
"isClaimCoveredByOtherInsurer": true,
"claimantName": "ABCD",
"contactNumber": "12345678",
"contactNumberCountryCode": "+852",
"email": "[email protected]",
"sendNotifToAgent": true,
"otherInsurerDetails": {
"nameOfInsuranceCompany": "TEST C",
"policyNumber": "E0180472",
"withClaim": true
},
"bankDetails": {
"accountHolderName": "GAMMON CONSTRUCTION LIMITED",
"bankCode": "004 | HSBC",
"branchCode": 123,
"accountNumber": 123456789
}
} 		{
"action": "LodgeClaim",
"messageHeader": {
"partnerId": "05110014",
"transactionId": "hkgsysdomestic"
},
"status": "Success",
"productType": "DMH",
"claimNumber": "AC800450",
"policyNumber": "A0659735",
"policyHolderName": "N WAI KAN WAN WAI K",
"dateOfLoss": "2023-10-04"
}

Personal Accident

Description
This API endpoint performs premium calculation and business validation on the provided information to determine if it can be processed as a straight-through transaction.

 

Path
POST /quotes/premiums


Request

Parameter Description Passed in Required
x-Partner-Id Unique identifier of the client making the API call HTTP Header Yes
x-Transaction-Id Unique ID for the request message HTTP Header Yes
Policy Full Policy Information Request body Yes

Response

Parameter Description Passed in
status SUCCESS / WARNING / ERROR Response body
messages Any detailed message for WARNING or ERROR results Response body
premium Calculated price / premium Response body

Sample

Sample Request Sample Response
{
"country": "HKG",
"product": "PERSONAL ACCIDENT",
"inceptionDate": "2023-11-16",
"expiryDate": "2024-11-15",
"risks": [
{
"riskNumber": "0",
"attachmentDate": "2023-01-16",
"personalAccident": {
"insuredPersons": [
{
"adultChild": "AD",
"occupation": "01",
"optionalCover": {
"isTempTotalDisablement": false,
"isHospitalCash": false
},
"plan": "3P",
"dateOfBirth": "1981-10-10"
},
{
"occupation": "01",
"optionalCover": {
"isTempTotalDisablement": false,
"isHospitalCash": false
},
"adultChild": "AD",
"plan": "3P",
"dateOfBirth": "1980-02-14"
},
{
"optionalCover": {
"isTempTotalDisablement": false,
"isHospitalCash": false
},
"adultChild": "CH",
"plan": "1P",
"dateOfBirth": "2008-01-01",
"studyingFulltime": "Y"
}
],
"numOfInsured": 3
}
}
]
} 		{
"status": "SUCCESS",
"action": "quoteRate",
"messageHeader": {
"partnerId": "05110014",
"transactionId": "RateQuoteSample"
},
"premium": {
"annualPremium": 2550.6,
"premiumDue": 2550.6,
"gst": 0,
"totalDue": 2553.16,
"totalDiscount": 0,
"totalLoading": 0,
"totalCommission": {
"commissionRate": 40,
"commissionAmount": 1020.24
},
"charges": [
{
"chargeDescription": "IA LEVY",
"value": 2.56
}
]
}
}

Description
This API endpoint allows a partner to save a quotation to with QBE that can be retrieved or converted to a policy later within 30-60 days, depending on the product.

 

Path
POST /quotes


Request

Parameter Description Passed in Required
x-Partner-Id Unique identifier of the client making the API call HTTP Header Yes
x-Transaction-Id Unique ID for the request message HTTP Header Yes
Policy Full quote Information Request body Yes
suppressCustDocsFlag boolean to determine if customer documents will be sent to client (default: false) URL No

Response

Parameter Description Passed in
status SUCCESS / WARNING / ERROR Response body
messages Any detailed message for WARNING or ERROR results Response body
quoteNumber Unique quote number allocated by QBE Response body
quoteStatus ISSUED / ISSUED WITH REFERRAL Response body

Sample

Sample Request Sample Response
{
"country": "HKG",
"product": "PERSONAL ACCIDENT",
"inceptionDate": "2023-11-16",
"expiryDate": "2024-11-15",
"client": {
"email": "[email protected]",
"clientAddress": {
"streetName": "taikoo",
"country": "HKG"
},
"fullName": "test test",
"gender": "MALE",
"birthDate": "1983-01-27",
"nationality": "HKG",
"HKID": "A5678903"
},
"risks": [
{
"riskNumber": "0",
"attachmentDate": "2023-01-16",
"personalAccident": {
"insuredPersons": [
{
"adultChild": "AD",
"occupation": "01",
"optionalCover": {
"isTempTotalDisablement": false,
"isHospitalCash": false
},
"plan": "3P",
"givenName": "Raymond",
"idNumber": "A5678903",
"dateOfBirth": "1981-11-11"
},
{
"occupation": "01",
"optionalCover": {
"isTempTotalDisablement": false,
"isHospitalCash": false
},
"adultChild": "AD",
"plan": "3P",
"givenName": "Raymond2",
"idNumber": "A1234563",
"dateOfBirth": "1991-08-09"
},
{
"optionalCover": {
"isTempTotalDisablement": false,
"isHospitalCash": false
},
"adultChild": "CH",
"plan": "1P",
"givenName": "Raymond Jr",
"idNumber": "C1234567",
"dateOfBirth": "2008-02-02",
"studyingFulltime": "Y"
}
],
"numOfInsured": 3,
"historyQuestions": {
"past3Years": false,
"past3YearsText": "",
"declinedInsurance": false,
"declinedInsuranceText": "",
"declinedHealthStatus": false,
"declinedHealthStatusText": ""
}
}
}
]
} 		{
"status": "SUCCESS",
"action": "issueQuote",
"messageHeader": {
"partnerId": "05110014",
"transactionId": "saveQuoteTest"
},
"quoteNumber": "00561826",
"quoteStatus": "SAVED QUOTE"
}

Description
This API endpoint allows a partner to officially bind a policy with QBE. The transaction will send the policy documents to the indicated insured’s e-mail address.

 

Path
POST /policies


Request

Parameter Description Passed in Required
x-Partner-Id Unique identifier of the client making the API call HTTP Header Yes
x-Transaction-Id Unique ID for the request message HTTP Header Yes
Policy Full Policy Information Request body Yes
suppressCustDocsFlag boolean to determine if customer documents will be sent to client (default: false) URL No

Response

Parameter Description Passed in
status SUCCESS / WARNING / ERROR Response body
messages Any detailed message for WARNING or ERROR results Response body
policyNumber Unique policy number allocated by QBE Response body
policyStatus INFORCED / NEW BUSINESS REFERRED Response body

Sample

Sample Request Sample Response
{
"country": "HKG",
"product": "PERSONAL ACCIDENT",
"inceptionDate": "2023-11-16",
"expiryDate": "2024-11-15",
"client": {
"email": "[email protected]",
"clientAddress": {
"streetName": "taikoo",
"country": "HKG"
},
"fullName": "test test",
"gender": "MALE",
"birthDate": "1983-01-27",
"nationality": "HKG",
"HKID": "A5678903"
},
"risks": [
{
"riskNumber": "0",
"attachmentDate": "2023-01-16",
"personalAccident": {
"insuredPersons": [
{
"adultChild": "AD",
"occupation": "01",
"optionalCover": {
"isTempTotalDisablement": false,
"isHospitalCash": false
},
"plan": "3P",
"givenName": "Raymond",
"idNumber": "A5678903",
"dateOfBirth": "1981-11-11"
},
{
"occupation": "01",
"optionalCover": {
"isTempTotalDisablement": false,
"isHospitalCash": false
},
"adultChild": "AD",
"plan": "3P",
"givenName": "Raymond2",
"idNumber": "A1234563",
"dateOfBirth": "1991-08-09"
},
{
"optionalCover": {
"isTempTotalDisablement": false,
"isHospitalCash": false
},
"adultChild": "CH",
"plan": "1P",
"givenName": "Raymond Jr",
"idNumber": "C1234567",
"dateOfBirth": "2008-02-02",
"studyingFulltime": "Y"
}
],
"numOfInsured": 3,
"historyQuestions": {
"past3Years": false,
"past3YearsText": "",
"declinedInsurance": false,
"declinedInsuranceText": "",
"declinedHealthStatus": false,
"declinedHealthStatusText": ""
}
}
}
]
} 		{
"status": "SUCCESS",
"action": "quoteUpdate",
"messageHeader": {
"partnerId": "05110014",
"transactionId": "issuePolicy-11082023PA"
},
"policyNumber": "A0660843",
"policyStatus": "INFORCED NEW BUSINESS"
}

Description
This API endpoint allows a partner to provide an existing Motor cover note policy number to QBE and QBE will automatically retrieve the details of the policy and convert to a New Business in forced policy internally. Only applicable for Hong Kong.

 

Path
POST /policies/convert


Request

Parameter Description Passed in Required
x-Partner-Id Unique identifier of the client making the API call HTTP Header Yes
x-Transaction-Id Unique ID for the request message HTTP Header Yes
quoteDetails Quote Number and Country Request body Yes
suppressCustDocsFlag boolean to determine if customer documents will be sent to client (default: false) URL No

Response

Parameter Description Passed in
status SUCCESS / WARNING / ERROR Response body
messages Any detailed message for WARNING or ERROR results Response body
policyNumber Unique policy number allocated by QBE Response body
policyStatus INFORCED NEW BUSINESS / REFERRED Response body

Sample

Sample Request Sample Response
{
"quoteNumber": "00561825",
"country": "HKG"
} 		{
"status": "SUCCESS",
"messageHeader": {
"partnerId": "05110014",
"transactionId": "convertPolDH"
},
"policyNumber": "A0660842",
"policyStatus": "INFORCED NEW BUSINESS"
}

Description
This API endpoint returns the full quote information saved in QBE’s systems.

 

Path
GET /quotes/{country}/{quote_id}


Request

Parameter Description Passed in Required
x-Partner-Id Unique identifier of the client making the API call HTTP Header Yes
x-Transaction-Id Unique ID for the request message HTTP Header Yes
country HKG, SGP URL Yes
quote_id Unique QBE quote number URL Yes
suppressCustDocsFlag boolean to determine if customer documents will be sent to client (default: false) URL No

Response

Parameter Description Passed in
status SUCCESS / WARNING / ERROR Response body
messages Any detailed message for WARNING or ERROR results Response body
Policy Full Saved Quote Information Response body

Sample

Sample Request Sample Response
N/A {
"status": "SUCCESS",
"action": "loadQuote",
"messageHeader": {
"partnerId": "05110014",
"transactionId": "getQuote"
},
"policy": {
"policyNumber": "00561826",
"policyStatus": "SAVED QUOTE",
"country": "HKG",
"product": "PERSONAL ACCIDENT",
"inceptionDate": "2023-11-16",
"effectiveDate": "2023-11-16",
"expiryDate": "2024-11-15",
"client": {
"clientKey": "05143209",
"clientAddress": {
"floorNumber": "",
"buildingName": "",
"streetName": "TAIKOO",
"district": "",
"city": "",
"province": "",
"country": "HKG",
"postcode": "",
"state": ""
},
"email": "[email protected]",
"phone": "",
"fullName": "TEST TEST",
"gender": "MALE",
"salutation": "",
"birthDate": "1983-01-27",
"nationality": "HKG",
"HKID": "A5678903"
},
"risks": [
{
"personalAccident": {
"insuredPersons": [
{
"givenName": "Raymond",
"adultChild": "AD",
"dateOfBirth": "1981-11-11",
"idNumber": "A5678903",
"plan": "3P",
"occupation": "01",
"classType": "",
"extension": "",
"studyingFulltime": "N",
"situationNumberForMessaging": "0",
"optionalCover": {
"isHospitalCash": false,
"isTempTotalDisablement": false,
"includeOptionCover": false
}
},
{
"givenName": "Raymond2",
"adultChild": "AD",
"dateOfBirth": "1991-08-09",
"idNumber": "A1234563",
"plan": "3P",
"occupation": "01",
"classType": "",
"extension": "",
"studyingFulltime": "N",
"situationNumberForMessaging": "0",
"optionalCover": {
"isHospitalCash": false,
"isTempTotalDisablement": false,
"includeOptionCover": false
}
},
{
"givenName": "Raymond Jr",
"adultChild": "CH",
"dateOfBirth": "2008-02-02",
"idNumber": "C1234567",
"plan": "1P",
"occupation": "",
"classType": "",
"extension": "",
"studyingFulltime": "Y",
"situationNumberForMessaging": "0",
"optionalCover": {
"isHospitalCash": false,
"isTempTotalDisablement": false,
"includeOptionCover": false
}
}
],
"numOfInsured": "3",
"historyQuestions": {
"past3Years": false,
"declinedInsurance": false,
"declinedHealthStatus": false
}
},
"riskNumber": "3",
"attachmentDate": "2023-11-16"
}
]
},
"premium": {
"annualPremium": 2550.6,
"premiumDue": 2550.6,
"gst": 0,
"totalDue": 2553.16,
"totalDiscount": 0,
"totalLoading": 0,
"totalCommission": {
"commissionRate": 40,
"commissionAmount": 1020.24
},
"charges": [
{
"chargeDescription": "IA LEVY",
"value": 2.56
}
]
}
}

Description
This API endpoint returns the full policy information saved in QBE’s systems. This is applicable for both inforced policies and cover notes.

 

Path
GET /policies/{country}/{policy_id}


Request

Parameter Description Passed in Required
x-Partner-Id Unique identifier of the client making the API call HTTP Header Yes
x-Transaction-Id Unique ID for the request message HTTP Header Yes
country HKG, SGP URL Yes
policy_no Unique QBE policy number URL Yes

Response

Parameter Description Passed in
status SUCCESS / WARNING / ERROR Response body
messages Any detailed message for WARNING or ERROR results Response body
policyStatus INFORCED NEW / BUSINESS REFERRED / ISSUED COVER NOTE Response body
policy Full policy Information Response body
premium Calculated price / premium Response body
excess Excess section details for Private Motor Response body

Sample

Sample Request Sample Response
N/A {
"status": "SUCCESS",
"action": "loadPolicy",
"messageHeader": {
"partnerId": "05110014",
"transactionId": "getPolicyTest"
},
"policy": {
"policyNumber": "A0660843",
"policyStatus": "INFORCED NEW BUSINESS",
"country": "HKG",
"product": "PERSONAL ACCIDENT",
"inceptionDate": "2023-11-16",
"effectiveDate": "2023-11-16",
"expiryDate": "2024-11-15",
"client": {
"clientKey": "05143210",
"clientAddress": {
"floorNumber": "",
"buildingName": "",
"streetName": "TAIKOO",
"district": "",
"city": "",
"province": "",
"country": "HKG",
"postcode": "",
"state": ""
},
"email": "[email protected]",
"phone": "",
"fullName": "TEST TEST",
"gender": "MALE",
"salutation": "",
"birthDate": "1983-01-27",
"nationality": "HKG",
"HKID": "A5678903"
},
"risks": [
{
"personalAccident": {
"insuredPersons": [
{
"givenName": "Raymond",
"adultChild": "AD",
"dateOfBirth": "1981-11-11",
"idNumber": "A5678903",
"plan": "3P",
"occupation": "01",
"classType": "",
"extension": "",
"studyingFulltime": "N",
"situationNumberForMessaging": "0",
"optionalCover": {
"isHospitalCash": false,
"isTempTotalDisablement": false,
"includeOptionCover": false
}
},
{
"givenName": "Raymond2",
"adultChild": "AD",
"dateOfBirth": "1991-08-09",
"idNumber": "A1234563",
"plan": "3P",
"occupation": "01",
"classType": "",
"extension": "",
"studyingFulltime": "N",
"situationNumberForMessaging": "0",
"optionalCover": {
"isHospitalCash": false,
"isTempTotalDisablement": false,
"includeOptionCover": false
}
},
{
"givenName": "Raymond Jr",
"adultChild": "CH",
"dateOfBirth": "2008-02-02",
"idNumber": "C1234567",
"plan": "1P",
"occupation": "",
"classType": "",
"extension": "",
"studyingFulltime": "Y",
"situationNumberForMessaging": "0",
"optionalCover": {
"isHospitalCash": false,
"isTempTotalDisablement": false,
"includeOptionCover": false
}
}
],
"numOfInsured": "3",
"historyQuestions": {
"past3Years": false,
"declinedInsurance": false,
"declinedHealthStatus": false
}
},
"riskNumber": "3",
"attachmentDate": "2023-11-16"
}
]
},
"premium": {
"annualPremium": 2550.6,
"premiumDue": 2550.6,
"gst": 0,
"totalDue": 2553.16,
"totalDiscount": 0,
"totalLoading": 0,
"totalCommission": {
"commissionRate": 40,
"commissionAmount": 1020.24
},
"charges": [
{
"chargeDescription": "IA LEVY",
"value": 2.56
}
]
}
}

Description
This API endpoint allows a partner to download the policy documents as PDF data for an existing quote or policy.

 

Path
GET /documents/{country}/{policy_id}


Request

Parameter Description Passed in Required
x-Partner-Id Unique identifier of the client making the API call HTTP Header Yes
x-Transaction-Id Unique ID for the request message HTTP Header Yes
country HKG, SGP URL Yes
policy_id Unique QBE quote or policy number Request body Yes
suppressCustDocsFlag boolean to determine if customer documents will be sent to client (default: false) URL No

Response

Parameter Description Passed in
status SUCCESS / WARNING / ERROR Response body
messages Any detailed message for WARNING or ERROR results Response body
documents List of available documents and downloadable URLs Response body

Sample

Sample Request Sample Response
N/A {
"status": "SUCCESS",
"action": "getDocument",
"messageHeader": {
"partnerId": "05110014",
"transactionId": "getDocs"
},
"documents": [
{
"docDescription": "Schedule - Client Copy",
"url": "https://uat2-qnect.qbe.com/ebusiness/DocumentApiController/getApiDocument.do?token=v9REAYf-VjE94R3dRwakE3k0HMIDAmKBBU5Prz0WKIlYtBvJ4K2URJGadC0t7-T-Hj2gmRPqKkjdOLcRVjYmdUFxMawvB0NOEdcFJ4Hci63IOGR_RICpFRnVBjn4Mi_-wp2twMrPgMwTpegyBBIAexG_q8PHOQZTxu2kpgJKsacP1M9TAWctAaPsWRyOCIfRr3IvN4YUcv3vxPquyijXWiB-Wkzjt5qRNU0LbAkXdetIgXj3v3UF-PER8Lmy6MyMBzym6--dWH6aFXFMLArLVZJneptLXDHKXZ9SSPBMB0NlnkXAGwkjJ4l1IaRvsBJFpEJ2z3PXxXU&iv=3VSqxllaHCTggZF5cL6S8g"
},
{
"docDescription": "Policy Wording",
"url": "https://uat2-qnect.qbe.com/ebusiness/DocumentApiController/getApiDocument.do?token=qTw9_3UxCqQ2p-IYkfTxrT6awwaZcwUvCgiNB9Uh14Z6xgEmSfDB63ysWRpCZ8f0HU2lEpU0kOQFjlFrCwh3PulBcSuE__egXIPL62JITsRffadMUw2mzN10bF-GGVkURDwCsCsgEkdqDxbXAkOJXcgjLSL0-VUQCvaKd1_o0KJbqTTOwlPvc5zb_xAD_doc6WTayfdgR6PMIrU0fPU9pEq6_o5F4052ZVtHk2L6sRAaxe5KwmLyrfBB845eE4aX9SvFvlMIgvorD3ECfU7bCDLeDXMcttn-a59DWu5kAxzEngKz1NFTh-TxAbDhsQ&iv=HTqSW5F855hZj6kAjHf07g"
},
{
"docDescription": "Debit Credit Note - Client Copy",
"url": "https://uat2-qnect.qbe.com/ebusiness/DocumentApiController/getApiDocument.do?token=oFX6P1B7BG4vLsp3wACahG4TyBJoQrZ3mstsgtA5snhWhPy3kPmF51CA4-FNN56cZaRiwaCj4cp-lLkquC76oLE69eFPQon_MAOWdwpMa_KyoFkDslYa5NlX1nX0vKutA-05CsxA-aXt0-mQLZyR6CrNcNA1LG2ecHtC3XKpUf2gV4n6HXAIcxIyafJbZEI9_8CuZh0AZR-v8JyvnUiZ-GjA9f4dc4kIN5Pk3baIcv2NU7lg2jwKNNPDjWwUfN5eLfT0sv7f5BYBxeE70zHWopYBJg63-nRZr5PpUmDyoRvueDj2hTcVVbkn45uPMFkY2FpZEQc8PZ2w1xEqncxiCm33Tw&iv=QMd8ykIzummnqF3P-q0zAQ"
},
{
"docDescription": "Summary of Benefits",
"url": "https://uat2-qnect.qbe.com/ebusiness/DocumentApiController/getApiDocument.do?token=OrDKHMyMhPSAxaiBjTkkosclw4kuPh2Alr02DO5Y86zN29RecEwrUvToxDA1CKVmPQhgFFdt7gqfU6u2x3wvb5GyUJ83bB5svrj6r8Am-wdQbM-2mQbMufyqy1Hnn4t_0jcb3mgMneaaRglAGfhF2OuHX0l7XI-vXoOSirNRY38JESSeGQv4NSRRj8cB89CG49jzJx4PQl6sVEzS-yrle8hmkGk4NtbH4ECleKkfEigBHmAycfqtexdd4MX7A4QrV9HwwXEE-2-Fbnv9IxzrfKLeqbXi8x1D25clNvKw0syUwL5LXiJi4Bwmwo8rlVQ-DbK5uIG3GQ&iv=sATd82-QwQCa21Pt5XMGbA"
},
{
"docDescription": "Personal Accident Emergency Card",
"url": "https://uat2-qnect.qbe.com/ebusiness/DocumentApiController/getApiDocument.do?token=X1uFVFQ4USwinQXKtStzgsJEuKc19aUEH02n9bbBHesyJveSpgSrO9v4iDeykRQea0KGpQq4eaKmeb9JGDk4ZhLLmsO4K0aCCO9oqbPcE9jCphmmaZWPUJqlFGqLFq_B-KUSO2pH4-QtWG857aS_-sEsnSLBTJNhil5xdPSlCmY_c4vL8pN0VWe7CuS6cXapyNcc437aphoGjGFJlVUduABe01ZBoUOfOkkaQQWwodVQjj9hDA7XQSZD2Tdzj6CUGwJRNpTZgYx67lI8QAM0-n4pyxjv7mPMXMxt0YUcp5TEq_gHDDl3_gflR1xy_2ENFDWmyuLjv5WpsxHjrtR4P4YvqFNxfUaKlnEHt49GY4M3iw&iv=2D1Hqckd_qj5niXGdpueJw"
}
]
}

Description
This API endpoint allows a partner to get the status of an existing claim based on its current stage in the claims process.

 

Path
POST /claims/status


Request

Parameter Description Passed in Required
x-Partner-Id Unique identifier of the client making the API call HTTP Header Yes
x-Transaction-Id Unique ID for the request message HTTP Header Yes
claimNumber Claim Number lodged Request body Yes
policyNumber Policy number of the claim being made Request body Yes
policyType Type of Policy Request body Yes
Name Policyholder’s full name (as indicated in policy) Request body Yes
idNumber Policy Holder’s Security ID Number (HKID or Passport Number as indicated in policy) Request body Yes

Response

Parameter Description Passed in
status SUCCESS / WARNING / ERROR Response body
messages Any detailed message for WARNING or ERROR results Response body
claimStatus Array of claims with claim status associated with the requested claim number or policy number Response body

Sample

Sample Request Sample Response
{
"claimNumber": "AC800370",
"policyNumber": "",
"country": "HKG",
"name": "N WAI KAN WAN WAI K",
"idNumber": "K362671(7)",
"policyType": "personalaccident"
} 		{
{
"status": "SUCCESS",
"action": "InquireClaimStatus",
"messageHeader": {
"partnerId": "05110014",
"transactionId": "AC800370"
},
"claimStatus": [
{
"productType": "DMH",
"claimNumber": "AC800370",
"policyNumber": "A0659735",
"claimStatus": "Claim Received",
"policyHolderName": "N WAI KAN WAN WAI K",
"dateOfLoss": "2023-01-01"
}
]
}

Description
This API endpoint allows a partner to register a claim for any valid QBE policy if the date of loss falls within the policy’s period of cover.

 

Path
POST /claims


Request

Parameter Description Passed in Required
x-Partner-Id Unique identifier of the client making the API call HTTP Header Yes
x-Transaction-Id Unique ID for the request message HTTP Header Yes
country 3-digit ISO code for countries Request body Yes
policyNumber Policy number of the claim being made Request body Yes
dateOfLoss Date of Loss or when the incident occurred Request body Yes
policyHolderName Policyholder’s full name (as indicated in policy) Request body Yes
securityNumber Policy Holder’s Security ID Number (HKID or Passport Number as indicated in policy) Request body Yes
incidentLocation 3-digit ISO code for country where the incident/loss occurred Request body Yes
incidentDescription Description of the incident Request body Yes
amountClaimedCurrency 3-digit ISO code for country currency of the total amount to be claimed Request body Yes
amountClaimed Total amount to be claimed Request body Yes
isClaimCoveredByOtherInsurer Boolean indicator to know if the claim is covered by other insurance policy Request body Yes
claimantName Name of person creating the claim Request body Yes
contactNumber Claimant contact number Request body Yes
Email Claimant email address Request body Yes
sendNotifToAgent Flag to send updates to agent Request body Yes
otherInsurerDetails Information required if claim is covered by other insurer Request body No
bankDetails Bank details and information where claim amount will be deposited Request body Yes

Response

Parameter Description Passed in
status SUCCESS / WARNING / ERROR Response body
messages Any detailed message for WARNING or ERROR results Response body
claimDetails Claim Details with claim number Response body

Sample

Sample Request Sample Response
{
"country": "HKG",
"policyNumber": "A0659735",
"dateOfLoss": "2023-10-04",
"policyHolderName": "N WAI KAN WAN WAI K",
"securityNumber": "K362671(7)",
"incidentLocation": "HKG",
"incidentDescription": "hkgsysdomestic test",
"amountClaimedCurrency": "HKD",
"amountClaimed": 1300.00,
"isClaimCoveredByOtherInsurer": true,
"claimantName": "ABCD",
"contactNumber": "12345678",
"contactNumberCountryCode": "+852",
"email": "[email protected]",
"sendNotifToAgent": true,
"otherInsurerDetails": {
"nameOfInsuranceCompany": "TEST C",
"policyNumber": "E0180472",
"withClaim": true
},
"bankDetails": {
"accountHolderName": "GAMMON CONSTRUCTION LIMITED",
"bankCode": "004 | HSBC",
"branchCode": 123,
"accountNumber": 123456789
}
} 		{
"action": "LodgeClaim",
"messageHeader": {
"partnerId": "05110014",
"transactionId": "hkgsysdomestic"
},
"status": "Success",
"productType": "DMH",
"claimNumber": "AC800450",
"policyNumber": "A0659735",
"policyHolderName": "N WAI KAN WAN WAI K",
"dateOfLoss": "2023-10-04"
}