Docs
  • Introduction
  • Getting Acquainted with Insurpass API
    • Before you start
    • Access to Insurpass API
    • Environment
    • Authentication
    • Errors
    • Pagination
    • Versioning
  • Know Insurpass' Products
    • Definition of Terms
    • Micro-health Insurance
    • Credit Life Insurance
    • Motor Insurance
    • Parcel Guard Insurance
    • Shop Insurance
    • Group Insurance
    • School Fees Insurance
    • Okada Insurance
    • Keke Insurance
  • Insurpass APi Reference
    • Micro-health Insurance
      • Policy
      • Claim
      • Pharmacy
    • Shop Insurance
      • Shop Insurance Policy
      • Shop Insurance Claims
    • School Fees Insurance
      • School Fees Policy
      • School Fees Claims
    • Keke Insurance
      • Keke Policy
      • Keke Claims
    • Okada Insurance
      • Okada Policy
      • Okada Claims
    • Motor Insurance
      • Comprehensive Motor Insurance
        • Comprehensive Motor Policy
        • Comprehensive Motor Claims
      • Third Party Motor Insurance
        • Third Party Motor Policy
        • Third Party Motor Claims
    • Parcel Guard Insurance
      • Policy
      • Claims
    • Group Insurance
      • Policy
      • Claims
    • Credit Life Insurance
      • Credit Life Policy
      • Credit Life Claims
  • GUIDES
    • Customer Journey Guidebook
      • Micro-health Insurance Flow
        • Claims Flow
        • Pharmacy Treatment Flow
        • User Interface Samples - Micro-health Insurance Plan
        • Issue Management Flow
      • Credit Life Insurance Flow
        • User Interface Samples - Credit Life Plan
Powered by GitBook
On this page
  • Initiate Cash Reimbursement Claims
  • The endpoint initiates the creation of a Cash Reimbursement Micro Health claim.
  • Initiate Funeral Expense Benefit Claims
  • The endpoint initiates the creation of a Funeral Expense Benefit Micro Health claim.
  • Micro Health Claim Details
  • This endpoint returns an object containing a single Micro Health claim
  • List All Micro Health Claims
  • This endpoint returns a list of all the Micro Health Claim objects.

Was this helpful?

  1. Insurpass APi Reference
  2. Micro-health Insurance

Claim

Initiate Cash Reimbursement Claims

The endpoint initiates the creation of a Cash Reimbursement Micro Health claim.

POST https://sandbox.insurpass.com/api/merchants/micro_health/cash_raimbursement_claims

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 - 2062058003

proof_of_hospitalization*

String

url to the proof of hospitalization - https://meet.google.com/image.png

receipt_of_payment

String

url to the receipt of payment - https://meet.google.com/image.png

 {
            "id": 28,
            "policy_id": 439,
            "proof_of_hospitalization": null,
            "receipt_of_payment": null,
            "beneficiary_id_card": "https://meet.google.com/image.png",
            "medical_certificate": "https://meet.google.com/image.png",
            "police_report": "https://meet.google.com/image.png",
            "death_certificate": "https://meet.google.com/image.png",
            "status": "pending",
            "merchant_id": 1,
            "type_of_claims": "funeral_expense_benefits",
            "created_at": "2022-10-17T12:56:50.000000Z",
            "updated_at": "2022-10-17T12:56:50.000000Z"
 }
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://sandbox.insurpass.com/api/merchant/micro_health/cash_raimbursement_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 => 'POST',
  CURLOPT_POSTFIELDS =>'{
    "policy_number":"2062058003",
    "proof_of_hospitalization":"https://meet.google.com/image.png",
    "receipt_of_payment":"https://meet.google.com/image.png"
}',
  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":"2062058003",
    "proof_of_hospitalization":"https://meet.google.com/image.png",
    "receipt_of_payment":"https://meet.google.com/image.png"
});

var config = {
  method: 'post',
  url: 'https://sandbox.insurpass.com/api/merchant/micro_health/cash_raimbursement_claims',
  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/merchants/micro_health/cash_raimbursement_claims' \
--header 'Authorization: Bearer {{SECRETKEY}}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
    "policy_number":"2062058003",
    "proof_of_hospitalization":"https://meet.google.com/image.png",
    "receipt_of_payment":"https://meet.google.com/image.png"
}'

Initiate Funeral Expense Benefit Claims

The endpoint initiates the creation of a Funeral Expense Benefit Micro Health claim.

POST https://sandbox.insurpass.com/api/merchants/micro_health/funeral_expense_benefit_claims

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 - 2062058003

beneficiary_id_card*

String

url to the proof of hospitalization - https://meet.google.com/image.png

medical_certificate

String

url to the medical certificate - https://meet.google.com/image.png

police_report

String

url to the police report - https://meet.google.com/image.png

death_certificate

String

url to the death certificate - https://meet.google.com/image.png

death_claims_form

String

url to the death claims form - https://meet.google.com/image.png

 {
            "id": 28,
            "policy_id": 439,
            "proof_of_hospitalization": null,
            "receipt_of_payment": null,
            "beneficiary_id_card": "https://meet.google.com/image.png",
            "medical_certificate": "https://meet.google.com/image.png",
            "police_report": "https://meet.google.com/image.png",
            "death_certificate": "https://meet.google.com/image.png",
            "status": "pending",
            "merchant_id": 1,
            "type_of_claims": "funeral_expense_benefits",
            "created_at": "2022-10-17T12:56:50.000000Z",
            "updated_at": "2022-10-17T12:56:50.000000Z"
        }
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://sandbox.insurpass.com/api/merchant/micro_health/funeral_expense_benefit_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 => 'POST',
  CURLOPT_POSTFIELDS =>'{
    "policy_number":"2062058003",
    "beneficiary_id_card":"https://meet.google.com/image.png",
    "medical_certificate":"https://meet.google.com/image.png",
    "police_report":"https://meet.google.com/image.png",
    "death_certificate":"https://meet.google.com/image.png",
    "death_claims_form":"https://meet.google.com/image.png"
}',
  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":"2062058003",
    "beneficiary_id_card":"https://meet.google.com/image.png",
    "medical_certificate":"https://meet.google.com/image.png",
    "police_report":"https://meet.google.com/image.png",
    "death_certificate":"https://meet.google.com/image.png",
    "death_claims_form":"https://meet.google.com/image.png"
});

var config = {
  method: 'post',
  url: 'https://sandbox.insurpass.com/api/merchant/micro_health/funeral_expense_benefit_claims',
  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/micro_health/funeral_expense_benefit_claims' \
--header 'Authorization: Bearer {{SECRETKEY}}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
    "policy_number":"2062058003",
    "beneficiary_id_card":"https://meet.google.com/image.png",
    "medical_certificate":"https://meet.google.com/image.png",
    "police_report":"https://meet.google.com/image.png",
    "death_certificate":"https://meet.google.com/image.png",
    "death_claims_form":"https://meet.google.com/image.png"
}'

Micro Health Claim Details

This endpoint returns an object containing a single Micro Health claim

GET https://sandbox.insurpass.com/api/merchant/micro_health/get_one_claims/: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

{
    "success": true,
    "response_message": "Micro Health Claims retrieved successfully",
    "response_code": "",
    "data": {
        "id": 3,
        "policy_id": 397,
        "proof_of_hospitalization": null,
        "receipt_of_payment": null,
        "beneficiary_id_card": "https://i0.wp.com/lifars.com/wp-content/uploads/2020/01/A-Lesson-for-CIOs-IT-Incident-Management.jpg?fit=1600%2C1200&ssl=1",
        "medical_certificate": "https://i0.wp.com/lifars.com/wp-content/uploads/2020/01/A-Lesson-for-CIOs-IT-Incident-Management.jpg?fit=1600%2C1200&ssl=1",
        "police_report": "https://i0.wp.com/lifars.com/wp-content/uploads/2020/01/A-Lesson-for-CIOs-IT-Incident-Management.jpg?fit=1600%2C1200&ssl=1",
        "death_certificate": "https://i0.wp.com/lifars.com/wp-content/uploads/2020/01/A-Lesson-for-CIOs-IT-Incident-Management.jpg?fit=1600%2C1200&ssl=1",
        "type_of_claims": "funeral_expense_benefits",
        "created_at": "2022-05-17T15:22:30.000000Z",
        "updated_at": "2022-05-17T15:22:30.000000Z"
    }
}
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://sandbox.insurpass.com/api/merchant/micro_health/get_one_claims/: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/micro_health/get_one_claims/: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/micro_health/get_one_claims/:claim_id' \
--header 'Authorization: Bearer {{SECRETKEY}}' \
--header 'Accept: application/json' \
--data-raw ''

List All Micro Health Claims

This endpoint returns a list of all the Micro Health Claim objects.

GET https://sandbox.insurpass.com/api/merchant/micro_health/get_claims

Headers

Name
Type
Description

Authorization*

String

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

Content-Type*

String

application/json

{
    "success": true,
    "response_message": "Micro health claim get successful",
    "response_code": "",
    "data": [
        {
            "id": 1,
            "policy_id": 397,
            "proof_of_hospitalization": "https://i0.wp.com/lifars.com/wp-content/uploads/2020/01/A-Lesson-for-CIOs-IT-Incident-Management.jpg?fit=1600%2C1200&ssl=1",
            "receipt_of_payment": "https://i0.wp.com/lifars.com/wp-content/uploads/2020/01/A-Lesson-for-CIOs-IT-Incident-Management.jpg?fit=1600%2C1200&ssl=1",
            "beneficiary_id_card": null,
            "medical_certificate": null,
            "police_report": null,
            "death_certificate": null,
            "status": "pending",
            "merchant_id": 1,
            "type_of_claims": "cash_reimbursement",
            "created_at": "2022-05-17T15:06:59.000000Z",
            "updated_at": "2022-05-17T15:06:59.000000Z"
        },
        {
            "id": 2,
            "policy_id": 397,
            "proof_of_hospitalization": null,
            "receipt_of_payment": null,
            "beneficiary_id_card": "https://i0.wp.com/lifars.com/wp-content/uploads/2020/01/A-Lesson-for-CIOs-IT-Incident-Management.jpg?fit=1600%2C1200&ssl=1",
            "medical_certificate": "https://i0.wp.com/lifars.com/wp-content/uploads/2020/01/A-Lesson-for-CIOs-IT-Incident-Management.jpg?fit=1600%2C1200&ssl=1",
            "police_report": "https://i0.wp.com/lifars.com/wp-content/uploads/2020/01/A-Lesson-for-CIOs-IT-Incident-Management.jpg?fit=1600%2C1200&ssl=1",
            "death_certificate": "https://i0.wp.com/lifars.com/wp-content/uploads/2020/01/A-Lesson-for-CIOs-IT-Incident-Management.jpg?fit=1600%2C1200&ssl=1",
            "status": "pending",
            "merchant_id": 1,
            "type_of_claims": "funeral_expense_benefits",
            "created_at": "2022-05-17T15:22:07.000000Z",
            "updated_at": "2022-05-17T15:22:07.000000Z"
        },
        {
            "id": 3,
            "policy_id": 397,
            "proof_of_hospitalization": null,
            "receipt_of_payment": null,
            "beneficiary_id_card": "https://i0.wp.com/lifars.com/wp-content/uploads/2020/01/A-Lesson-for-CIOs-IT-Incident-Management.jpg?fit=1600%2C1200&ssl=1",
            "medical_certificate": "https://i0.wp.com/lifars.com/wp-content/uploads/2020/01/A-Lesson-for-CIOs-IT-Incident-Management.jpg?fit=1600%2C1200&ssl=1",
            "police_report": "https://i0.wp.com/lifars.com/wp-content/uploads/2020/01/A-Lesson-for-CIOs-IT-Incident-Management.jpg?fit=1600%2C1200&ssl=1",
            "death_certificate": "https://i0.wp.com/lifars.com/wp-content/uploads/2020/01/A-Lesson-for-CIOs-IT-Incident-Management.jpg?fit=1600%2C1200&ssl=1",
            "status": "pending",
            "merchant_id": 1,
            "type_of_claims": "funeral_expense_benefits",
            "created_at": "2022-05-17T15:22:30.000000Z",
            "updated_at": "2022-05-17T15:22:30.000000Z"
        }
       
    ]
}
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://sandbox.insurpass.com/api/merchant/micro_health/get_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('axio');
var data = '';

var config = {
  method: 'get',
  url: 'https://sandbox.insurpass.com/api/merchant/micro_health/get_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/micro_health/get_claims' \
--header 'Authorization: Bearer {{SECRETKEY}}' \
--header 'Accept: application/json' \
--data-raw ''
PreviousPolicyNextPharmacy

Last updated 2 years ago

Was this helpful?