Claims
Initiate Parcel Guard Claims
The endpoint initiates the creation of a Parcel Guard claim.
POST https://sandbox.insurpass.com/api/merchant/create_parcel_guard_policy_claim
Headers
Name
Type
Description
Authorization*
String
Bearer {$secret-key}/{$api-key}
Content-Type*
String
application/json
Request Body
Name
Type
Description
policy_number*
String
The unique number that identifies the purchased insurance policy - IN98570819
details_of_incident*
String
Descriptive text of the full details of the incident
insured_name*
String
The full name of the insured - Seth Rollins
name_of_claimant*
String
The full name of the claimant- Roman Reigns
estimated_cost_of_damage*
String
The estimated cost of the damage parcel - 5000
signature*
String
image url of the signature
{
"success": true,
"response_message": "Parcel Guard policy claim initiated successfully",
"response_code": 200,
"data": {
"policy_number": "UIC/RE/INP/PGD/19102022/46103",
"insured_name": "Seth Rollins",
"details_of_incident": "It was a dark and stormy night",
"estimated_cost_of_damange": "22000",
"name_of_claimant": "Roman Reigns",
"declaration_date": "2022-10-19T00:00:00.000000Z",
"status": "pending",
"signature": "https://example.com/image",
"updated_at": "2022-10-19T19:31:36.000000Z",
"created_at": "2022-10-19T19:31:36.000000Z"
}
}<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://sandbox.insurpass.com/api/merchant/create_parcel_guard_policy_claim',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS =>'{
"policy_number": "UIC/RE/INP/MTP/06102022/53166",
"insured_name": "Seth Rollins",
"details_of_incident": "It was a dark and stormy night",
"estimated_cost_of_damange": "22000",
"name_of_claimant": "Roman Reigns",
"signature": "https://example.com/image"
}',
CURLOPT_HTTPHEADER => array(
'Authorization: Bearer {{SECRETKEY}}',
'Content-Type: application/json'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;var axios = require('axios');
var data = JSON.stringify({
"policy_number": "UIC/RE/INP/MTP/06102022/53166",
"insured_name": "Seth Rollins",
"details_of_incident": "It was a dark and stormy night",
"estimated_cost_of_damange": "22000",
"name_of_claimant": "Roman Reigns",
"signature": "https://example.com/image"
});
var config = {
method: 'post',
url: 'https://sandbox.insurpass.com/api/merchant/create_parcel_guard_policy_claim',
headers: {
'Authorization': 'Bearer {{SECRETKEY}}',
'Content-Type': 'application/json'
},
data: data
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});curl --location --request POST https://sandbox.insurpass.com/api/merchant/create_parcel_guard_policy_claim' \
--header 'Authorization: Bearer {{SECRETKEY}}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '({
"policy_number": "UIC/RE/INP/MTP/06102022/53166",
"insured_name": "Seth Rollins",
"details_of_incident": "It was a dark and stormy night",
"estimated_cost_of_damange": "22000",
"name_of_claimant": "Roman Reigns",
"signature": "https://example.com/image"
}'Parcel Guard Details
This endpoint returns an object containing a single Parcel Guard claim
GET https://sandbox.insurpass.com/api/merchant/parcel_guard_policy_claim_details/:claim_id
Path Parameters
Name
Type
Description
claim_id
String
The unique number that identifies the claim -9
Headers
Name
Type
Description
Authorization*
String
Bearer {$secret-key}/{$api-key}
Content-Type*
String
application/json
{
"id": 1,
"user_id": 387,
"merchant_id": 1,
"policy_id": 7,
"policy_number": "UIC/RE/INP/PGD/19102022/68438",
"insured_name": "Seth Rollins",
"details_of_incident": "It was a dark and stormy night",
"estimated_cost_of_damange": "22000",
"name_of_claimant": "Roman Reigns",
"signature": "https://example.com/image",
"declaration_date": "2022-10-19T00:00:00.000000Z",
"status": "pending",
"deleted_at": null,
"created_at": "2022-10-19T10:12:48.000000Z",
"updated_at": "2022-10-19T10:12:48.000000Z",
"user": {
"first_name": "hjdhjdj",
"middle_name": null,
"surname": "jfhdj",
"phone_no": "90948584934",
"email": "jb@jdj.com",
"address": null,
"gender": "male",
"date_of_birth": null,
"password": null,
"policy_no": null,
"have_beneficiaries": false,
"enable": true,
"next_of_kin_full_name": null,
"merchant_user_id": null,
"user_type": "user",
"created_at": "2022-10-14T08:44:16.000000Z",
"updated_at": "2022-10-14T08:44:16.000000Z",
"principal_policy_no": null,
"nin_number": null,
"id_url": null,
"profile_url": null,
"company_id": null,
"verify_phone": 0,
"verify_email": 0,
"town": null,
"state_of_residence": null,
"transaction_pin": null,
"occupation": null,
"id_type": null
},
"policy": {
"id": 7,
"user_id": 387,
"product_id": 1,
"merchant_id": 1,
"mode_of_shipment_id": 2,
"policy_number": "UIC/RE/INP/PGD/19102022/68438",
"description_of_goods": null,
"description_of_packing": null,
"quantity": 4,
"cost_per_unit": "2.00",
"total_value": "44.00",
"goods_package_move_from": "London",
"goods_package_move_to": "Arizona",
"name_of_reciever": "Mia",
"address_of_reciever": "al, 39403, tz",
"reciever_phone_no": "04953943943",
"transit_commencement_date": "2022-05-03T00:00:00.000000Z",
"expected_arrival_date": "2022-06-03T00:00:00.000000Z",
"duration_of_goods_conveyed": "4",
"driver_name": null,
"driver_phone_no": null,
"vehicle_reg_no": null,
"start_date": "2022-10-19T00:00:00.000000Z",
"end_date": "2023-10-18T00:00:00.000000Z",
"status": "success",
"product_code": "PG",
"deleted_at": null,
"created_at": "2022-10-19T08:01:58.000000Z",
"updated_at": "2022-10-19T08:02:10.000000Z"
},
"merchant": {
"id": 1,
"company_name": "Bimacred",
"email": "hello@bimacred.com",
"phone_no": "0701-8365-644",
"address": "8b, Aliu Animashaun Avenue, Off Admiralty Way, Lekki Phase 1, Lagos. Nigeria.",
"category_id": 1,
"secret_key": "ins_sk_b572c86da070944e81bf7abd6b18a47b7768a2a075acbb40c11acff39bbdc6e9f41c1a8d38cf6d60_test",
"username": "Bimacred",
"enable": true,
"created_at": "2022-01-07T09:00:40.000000Z",
"updated_at": "2022-09-20T11:03:05.000000Z",
"transaction_pin": "$2y$10$YXb/VnuzeloHfZhWHpgk0eL5yoRN0cB6HcLQ2sS0ia9tvjlhR3hL2",
"verify_email": 1,
"verify_phone": 0,
"logo_url": null,
"merchant_type": "business"
}<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://sandbox.insurpass.com/api/merchant/parcel_guard_policy_claim_details/{claim_id}',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => array(
'Authorization: Bearer {{SECRETKEY}}',
'Content-Type: application/json'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;var axios = require('axios');
var data = '';
var config = {
method: 'get',
url: 'https://sandbox.insurpass.com/api/merchant/parcel_guard_policy_claim_details/{claim_id}',
headers: {
'Authorization': 'Bearer {{SECRETKEY}}',
'Content-Type': 'application/json'
},
data: data
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});curl --location --request GET https://sandbox.insurpass.com/api/merchant/parcel_guard_policy_claim_details/:claim_id' \
--header 'Authorization: Bearer {{SECRETKEY}}' \
--header 'Accept: application/json' \
--data-raw ''List All Parcel Guard Claims
This endpoint returns a list of all the Parcel Guard claim objects.
GET https://sandbox.insurpass.com/api/merchant/get_parcel_guard_policy_claims
Headers
Name
Type
Description
Authorization*
String
Bearer {$secret-key}/{$api-key}
Content-Type*
String
application/json
{
"success": true,
"response_message": "Parcel Guard claim fetched successfully",
"response_code": 200,
"data": [
{
"id": 1,
"user_id": 387,
"merchant_id": 1,
"policy_id": 7,
"policy_number": "UIC/RE/INP/PGD/19102022/68438",
"insured_name": "Seth Rollins",
"details_of_incident": "It was a dark and stormy night",
"estimated_cost_of_damange": "22000",
"name_of_claimant": "Roman Reigns",
"signature": "https://example.com/image",
"declaration_date": "2022-10-19T00:00:00.000000Z",
"status": "pending",
"deleted_at": null,
"created_at": "2022-10-19T10:12:48.000000Z",
"updated_at": "2022-10-19T10:12:48.000000Z",
"user": {
"first_name": "hjdhjdj",
"middle_name": null,
"surname": "jfhdj",
"phone_no": "90948584934",
"email": "jb@jdj.com",
"address": null,
"gender": "male",
"date_of_birth": null,
"password": null,
"policy_no": null,
"have_beneficiaries": false,
"enable": true,
"next_of_kin_full_name": null,
"merchant_user_id": null,
"user_type": "user",
"created_at": "2022-10-14T08:44:16.000000Z",
"updated_at": "2022-10-14T08:44:16.000000Z",
"principal_policy_no": null,
"nin_number": null,
"id_url": null,
"profile_url": null,
"company_id": null,
"verify_phone": 0,
"verify_email": 0,
"town": null,
"state_of_residence": null,
"transaction_pin": null,
"occupation": null,
"id_type": null
},
"policy": {
"id": 7,
"user_id": 387,
"product_id": 1,
"merchant_id": 1,
"mode_of_shipment_id": 2,
"policy_number": "UIC/RE/INP/PGD/19102022/68438",
"description_of_goods": null,
"description_of_packing": null,
"quantity": 4,
"cost_per_unit": "2.00",
"total_value": "44.00",
"goods_package_move_from": "London",
"goods_package_move_to": "Arizona",
"name_of_reciever": "Mia",
"address_of_reciever": "al, 39403, tz",
"reciever_phone_no": "04953943943",
"transit_commencement_date": "2022-05-03T00:00:00.000000Z",
"expected_arrival_date": "2022-06-03T00:00:00.000000Z",
"duration_of_goods_conveyed": "4",
"driver_name": null,
"driver_phone_no": null,
"vehicle_reg_no": null,
"start_date": "2022-10-19T00:00:00.000000Z",
"end_date": "2023-10-18T00:00:00.000000Z",
"status": "success",
"product_code": "PG",
"deleted_at": null,
"created_at": "2022-10-19T08:01:58.000000Z",
"updated_at": "2022-10-19T08:02:10.000000Z"
},
"merchant": {
"id": 1,
"company_name": "Bimacred",
"email": "hello@bimacred.com",
"phone_no": "0701-8365-644",
"address": "8b, Aliu Animashaun Avenue, Off Admiralty Way, Lekki Phase 1, Lagos. Nigeria.",
"category_id": 1,
"secret_key": "ins_sk_b572c86da070944e81bf7abd6b18a47b7768a2a075acbb40c11acff39bbdc6e9f41c1a8d38cf6d60_test",
"username": "Bimacred",
"enable": true,
"created_at": "2022-01-07T09:00:40.000000Z",
"updated_at": "2022-09-20T11:03:05.000000Z",
"transaction_pin": "$2y$10$YXb/VnuzeloHfZhWHpgk0eL5yoRN0cB6HcLQ2sS0ia9tvjlhR3hL2",
"verify_email": 1,
"verify_phone": 0,
"logo_url": null,
"merchant_type": "business"
}
},
{
"id": 2,
"user_id": 387,
"merchant_id": 1,
"policy_id": 7,
"policy_number": "UIC/RE/INP/PGD/19102022/68438",
"insured_name": "Seth Rollins",
"details_of_incident": "It was a dark and stormy night",
"estimated_cost_of_damange": "22000",
"name_of_claimant": "Roman Reigns",
"signature": "https://example.com/image",
"declaration_date": "2022-10-19T00:00:00.000000Z",
"status": "pending",
"deleted_at": null,
"created_at": "2022-10-19T15:05:46.000000Z",
"updated_at": "2022-10-19T15:05:46.000000Z",
"user": {
"first_name": "hjdhjdj",
"middle_name": null,
"surname": "jfhdj",
"phone_no": "90948584934",
"email": "jb@jdj.com",
"address": null,
"gender": "male",
"date_of_birth": null,
"password": null,
"policy_no": null,
"have_beneficiaries": false,
"enable": true,
"next_of_kin_full_name": null,
"merchant_user_id": null,
"user_type": "user",
"created_at": "2022-10-14T08:44:16.000000Z",
"updated_at": "2022-10-14T08:44:16.000000Z",
"principal_policy_no": null,
"nin_number": null,
"id_url": null,
"profile_url": null,
"company_id": null,
"verify_phone": 0,
"verify_email": 0,
"town": null,
"state_of_residence": null,
"transaction_pin": null,
"occupation": null,
"id_type": null
},
"policy": {
"id": 7,
"user_id": 387,
"product_id": 1,
"merchant_id": 1,
"mode_of_shipment_id": 2,
"policy_number": "UIC/RE/INP/PGD/19102022/68438",
"description_of_goods": null,
"description_of_packing": null,
"quantity": 4,
"cost_per_unit": "2.00",
"total_value": "44.00",
"goods_package_move_from": "London",
"goods_package_move_to": "Arizona",
"name_of_reciever": "Mia",
"address_of_reciever": "al, 39403, tz",
"reciever_phone_no": "04953943943",
"transit_commencement_date": "2022-05-03T00:00:00.000000Z",
"expected_arrival_date": "2022-06-03T00:00:00.000000Z",
"duration_of_goods_conveyed": "4",
"driver_name": null,
"driver_phone_no": null,
"vehicle_reg_no": null,
"start_date": "2022-10-19T00:00:00.000000Z",
"end_date": "2023-10-18T00:00:00.000000Z",
"status": "success",
"product_code": "PG",
"deleted_at": null,
"created_at": "2022-10-19T08:01:58.000000Z",
"updated_at": "2022-10-19T08:02:10.000000Z"
},
"merchant": {
"id": 1,
"company_name": "Bimacred",
"email": "hello@bimacred.com",
"phone_no": "0701-8365-644",
"address": "8b, Aliu Animashaun Avenue, Off Admiralty Way, Lekki Phase 1, Lagos. Nigeria.",
"category_id": 1,
"secret_key": "ins_sk_b572c86da070944e81bf7abd6b18a47b7768a2a075acbb40c11acff39bbdc6e9f41c1a8d38cf6d60_test",
"username": "Bimacred",
"enable": true,
"created_at": "2022-01-07T09:00:40.000000Z",
"updated_at": "2022-09-20T11:03:05.000000Z",
"transaction_pin": "$2y$10$YXb/VnuzeloHfZhWHpgk0eL5yoRN0cB6HcLQ2sS0ia9tvjlhR3hL2",
"verify_email": 1,
"verify_phone": 0,
"logo_url": null,
"merchant_type": "business"
}
},
{
"id": 3,
"user_id": 387,
"merchant_id": 1,
"policy_id": 7,
"policy_number": "UIC/RE/INP/PGD/19102022/68438",
"insured_name": "Seth Rollins",
"details_of_incident": "It was a dark and stormy night",
"estimated_cost_of_damange": "22000",
"name_of_claimant": "Roman Reigns",
"signature": "https://example.com/image",
"declaration_date": "2022-10-19T00:00:00.000000Z",
"status": "pending",
"deleted_at": null,
"created_at": "2022-10-19T15:11:44.000000Z",
"updated_at": "2022-10-19T15:11:44.000000Z",
"user": {
"first_name": "hjdhjdj",
"middle_name": null,
"surname": "jfhdj",
"phone_no": "90948584934",
"email": "jb@jdj.com",
"address": null,
"gender": "male",
"date_of_birth": null,
"password": null,
"policy_no": null,
"have_beneficiaries": false,
"enable": true,
"next_of_kin_full_name": null,
"merchant_user_id": null,
"user_type": "user",
"created_at": "2022-10-14T08:44:16.000000Z",
"updated_at": "2022-10-14T08:44:16.000000Z",
"principal_policy_no": null,
"nin_number": null,
"id_url": null,
"profile_url": null,
"company_id": null,
"verify_phone": 0,
"verify_email": 0,
"town": null,
"state_of_residence": null,
"transaction_pin": null,
"occupation": null,
"id_type": null
},
"policy": {
"id": 7,
"user_id": 387,
"product_id": 1,
"merchant_id": 1,
"mode_of_shipment_id": 2,
"policy_number": "UIC/RE/INP/PGD/19102022/68438",
"description_of_goods": null,
"description_of_packing": null,
"quantity": 4,
"cost_per_unit": "2.00",
"total_value": "44.00",
"goods_package_move_from": "London",
"goods_package_move_to": "Arizona",
"name_of_reciever": "Mia",
"address_of_reciever": "al, 39403, tz",
"reciever_phone_no": "04953943943",
"transit_commencement_date": "2022-05-03T00:00:00.000000Z",
"expected_arrival_date": "2022-06-03T00:00:00.000000Z",
"duration_of_goods_conveyed": "4",
"driver_name": null,
"driver_phone_no": null,
"vehicle_reg_no": null,
"start_date": "2022-10-19T00:00:00.000000Z",
"end_date": "2023-10-18T00:00:00.000000Z",
"status": "success",
"product_code": "PG",
"deleted_at": null,
"created_at": "2022-10-19T08:01:58.000000Z",
"updated_at": "2022-10-19T08:02:10.000000Z"
},
"merchant": {
"id": 1,
"company_name": "Bimacred",
"email": "hello@bimacred.com",
"phone_no": "0701-8365-644",
"address": "8b, Aliu Animashaun Avenue, Off Admiralty Way, Lekki Phase 1, Lagos. Nigeria.",
"category_id": 1,
"secret_key": "ins_sk_b572c86da070944e81bf7abd6b18a47b7768a2a075acbb40c11acff39bbdc6e9f41c1a8d38cf6d60_test",
"username": "Bimacred",
"enable": true,
"created_at": "2022-01-07T09:00:40.000000Z",
"updated_at": "2022-09-20T11:03:05.000000Z",
"transaction_pin": "$2y$10$YXb/VnuzeloHfZhWHpgk0eL5yoRN0cB6HcLQ2sS0ia9tvjlhR3hL2",
"verify_email": 1,
"verify_phone": 0,
"logo_url": null,
"merchant_type": "business"
}
}
]
}<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://sandbox.insurpass.com/api/merchant/get_parcel_guard_policy_claims',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => array(
'Authorization: Bearer {{SECRETKEY}}'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;var axios = require('axios');
var data = '';
var config = {
method: 'get',
url: 'https://sandbox.insurpass.com/api/merchant/get_parcel_guard_policy_claims',
headers: {
'Authorization': 'Bearer {{SECRETKEY}}'
},
data: data
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});curl --location --request GET https://sandbox.insurpass.com/api/merchant/get_parcel_guard_policy_claims' \
--header 'Authorization: Bearer {{SECRETKEY}}' \
--header 'Accept: application/json' \
--data-raw ''Last updated
Was this helpful?