Policy

Initiate Parcel Guard Policy

This method initiates the creation of a Parcel Guard Insurance Policy.

POST https://sandbox.insurpass.com/api/merchant/initiate_parcel_guard_policy

Successful initiation of policy generates a token which would be used to verify a transaction.

Headers

Name
Type
Description

Authorization*

String

Bearer {$secret-key}/{$api-key}

Content-Type*

String

application/json

Request Body

Name
Type
Description

email*

Email

Principal Customer's email address - emaill@domain.com

first_name*

String

Principal Customer's first name - Favour

Surname*

String

Principal Customer's surname (Last name) - Ezedibia

phone_no*

numeric|digits:11

Principal Customer's email address -- email@domain.com

gender*

String

Principal Customer's gender - female, male

dob*

String

Principal Customer's date of birth - yy-mm-dd - 1999-09-12

poduct_id*

String

The unique number that identifies parcel guard insurance product you're purchasig - 3

mode_of_shipment_id*

integer

The unique number that identifies which mode of shipment was used to ship the package - 2

quantity*

integer

The number of item (parcels) being shipped - 2

cost_per_unit*

numeric

Price of each unit of parcel - 800

total_value*

numeric

Total value of the parcels combined - 20,000

goods_package_move_from*

String

Location from where the package was shipped. - Lagos max:255

goods_package_move_to*

String

Location of where the package is going. - Lagos max:255

name_of_reciever*

String

Name of the person receiving parcel - Favour Adewale max:255

address_of_reciever*

String

Address of the person receiving the package - Welfare quarters, makurdi

reciever_phone_no*

numeric|digits:11

Phone number of the person receiving the package - 08098876543

transit_commencement_date*

Date FORMAT YYYY-MM-DD

Date whe the package was sent out - 2022-09-09

expected_arrival_date*

Date FORMAT YYYY-MM-DD

Expected date when the parcel will arrive - 2022-10-9-09

duration_of_goods_conveyed*

String

The total nuber of days it will take from whn the parcel is shipped to when it arrives. - 15 Days - max:255

premium_rate*

numeric

description_of_goods

String

A description that tells what the package is. - HD Television.

description_of_packing

String

driver_name

String

Name of the driver delivering the parcel - Ahmad Obi. max:255

driver_phone_no

String

Phone number of the driver delivering the parcel - 09088876676. digit:11

vehicle_reg_no

String

The vehicle registration number - 94422342424

Verify Parcel Guard Policy

This endpoint verifies the token which was generated during initiation of the policy.

GET https://sandbox.insurpass.comapi/merchant/verify_parcel_guard_policy

Note that the token expires after a certain duration. Kindly find below the sample responses and payload

Headers

Name
Type
Description

Authorization*

String

Bearer {$secret-key}/{$api-key}

Content-Type*

String

application/json

Request Body

Name
Type
Description

token*

String

Note that after 15 minutes, the token expires and you will need to reinitiate

The Initiate token expires in 15 minutes, and if a user does not verify his/her subscription after 15 minutes of initiation, the details of the subscription will be deleted.

List All Parcel Guard Policies

This endpoint returns all the policies created by the merchant

GET https://sandbox.insurpass.com/api/merchant/merchant_parcel_guard_policies

Headers

Name
Type
Description

Authorization*

String

Bearer {$secret-key}/{$api-key}

Content-Type*

String

application/json

Parcel Guard Policy Details

This endpoint returns the merchant policy details.

POST http://sandbox.insurpass.com/api/merchant/parcel_guard_policy_details

The developer needs to provide the policy number for the policy details to displ

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 - UIC/RE/INP/PGD/13062022/74177

Parcel Guard Premium Rate

This endpoint returns a premium rate for a parcel guard policy.

POST https://sandbox.insurpass.com/api/merchant/get_parcel_guard_premium_rate

Headers

Name
Type
Description

Authorization*

String

Bearer {$secret-key}/{$api-key}

Content-Type*

String

application/json

Request Body

Name
Type
Description

value_of_consignment*

numeric

Total value of the parcels combined - 20,000

Parcel Guard Report

This endpoint returns an object containing a merchant's number of policies and claims

GET https://sandbox.insurpass.com/api/merchant/get_parcel_guard_report

Headers

Name
Type
Description

Authorization*

String

Bearer {$secret-key}/{$api-key}

Content-Type*

String

application/json

Parcel Guard mode of Shipment

This endpoint returns a mode of Shipment for a parcel guard policy.

GET http://sandbox.insurpass.com/api/merchant/get_parcel_guard_mode_of_shipment

Headers

Name
Type
Description

Authorization*

String

Bearer {$secret-key}/{$api-key}

Content-Type*

String

application/json

Last updated

Was this helpful?