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 School Fees Claims
  • The endpoint initiates the creation of a school fees claim.
  • School Fees Claim Details
  • This endpoint returns an object containing a single school fees claim
  • List All School Fees Claims
  • This endpoint returns a list of all the School Fees claim objects.

Was this helpful?

  1. Insurpass APi Reference
  2. School Fees Insurance

School Fees Claims

Initiate School Fees Claims

The endpoint initiates the creation of a school fees claim.

POST https://sandbox.insurpass.com/api/merchant/school_fee_initiate_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

full_details*

String

Dscriptive text of the full details of the incident

supporting_document*

String

image url of very possible doument to suport their claim

signature_date*

String

Date the claim was made. DD/MM/YYYY

date_of_occurance*

String

Date the incident occurred. DD/MM/YYYY

signature*

String

image url of the signature

{
   "success":true,
   "response_message":"School fee  policy claim initiated successfully",
   "response_code":"",
   "data":{
      "result":"School fee  policy claim initiated successfully"
   }
}
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://sandbox.insurpass.com/api/merchant/school_fee_initiate_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/SFP/02102022/78555",
    "full_details": "Mille Bobby Brown",
    "supporting_document": "This is a detail",
    "signature_date": "2021-02-12",
    "date_of_occurance": "1993-02-12",
    "signature": "string"
}',
  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/SFP/02102022/78555",
    "full_details": "Mille Bobby Brown",
    "supporting_document": "This is a detail",
    "signature_date": "2021-02-12",
    "date_of_occurance": "1993-02-12",
    "signature": "string"
});

var config = {
  method: 'post',
  url: 'https://sandbox.insurpass.com/api/merchant/school_fee_initiate_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/school_fee_initiate_claim' \
--header 'Authorization: Bearer {{SECRETKEY}}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
    "policy_number": "UIC/RE/INP/SFP/02102022/78555",
    "full_details": "Mille Bobby Brown",
    "supporting_document": "This is a detail",
    "signature_date": "2021-02-12",
    "date_of_occurance": "1993-02-12",
    "signature": "string"
}'

School Fees Claim Details

This endpoint returns an object containing a single school fees claim

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

Headers

Name
Type
Description

Authorization*

String

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

Content-Type*

String

application/json

Request Body

Name
Type
Description

policyNumber*

String

The unique number that identifies the purchased insurance policy - IN98570819

{
   "success":true,
   "response_message":"Data fetched successfully",
   "response_code":"",
   "data":{
      "status":true,
      "full_details":"Salami Kaol",
      "supporting_document":"This is a detail",
      "signature":"string",
      "signature_date":"2021-02-12T00:00:00.000000Z",
      "date_of_occurance":"1993-02-12T00:00:00.000000Z",
      "deleted_at":null,
      "created_at":"2022-04-04T08:09:05.000000Z",
      "updated_at":"2022-04-04T08:09:05.000000Z",
      "school_fee_policy":{
         "beneficiary_id":18,
         "policy_number":"INS1645702524736",
         "trustee_fullname":"fsfs",
         "trustee_phone_number":"08034543234",
         "trustee_email":"salamikolawole@gmail.com",
         "frequency_type":"monthly",
         "frequency":30,
         "status":true,
         "deleted_at":null,
         "created_at":"2022-02-24T11:35:24.000000Z",
         "updated_at":"2022-02-24T11:35:24.000000Z"
      }
   }
}
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://sandbox.insurpass.com/api/merchant/school_fee_claim_details',
  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/SI/30092022/79187"}',
  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/SI/30092022/79187"});

var config = {
  method: 'post',
  url: 'https://sandbox.insurpass.com/api/merchant/school_fee_claim_details',
  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/school_fee_merchant_claims' \
--header 'Authorization: Bearer {{SECRETKEY}}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{"policy_number":"UIC/RE/INP/SI/30092022/79187"}'

List All School Fees Claims

This endpoint returns a list of all the School Fees claim objects.

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

Headers

Name
Type
Description

Authorization*

String

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

Content-Type*

String

application/json

{
   "success":true,
   "response_message":"Data fetched successfully",
   "response_code":"",
   "data":[
      {
         "status":true,
         "full_details":"Salami Kaol",
         "supporting_document":"This is a detail",
         "signature":"string",
         "signature_date":"2021-02-12T00:00:00.000000Z",
         "date_of_occurance":"1993-02-12T00:00:00.000000Z",
         "deleted_at":null,
         "created_at":"2022-04-04T08:09:05.000000Z",
         "updated_at":"2022-04-04T08:09:05.000000Z",
         "school_fee_policy":{
            "policy_number":"INS1645702524736"
         }
      }
   ]
}
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://sandbox.insurpass.com/api/merchant/school_fee_merchant_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/school_fee_merchant_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 POST https://sandbox.insurpass.com/api/merchant/school_fee_merchant_claims' \
--header 'Authorization: Bearer {{SECRETKEY}}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw ''
PreviousSchool Fees PolicyNextKeke Insurance

Last updated 2 years ago

Was this helpful?