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
  • Create Credit Life Claims
  • CREATE CREDIT LIFE CLAIMS
  • Retrieve all Credit Life claims Initiated
  • ALL CREDIT LIFE CLAIMS
  • Retrieve details of Credit Life Claims
  • ALL CREDIT LIFE CLAIM DETAILS
  • Archive Credit Life Claims
  • ARCHIVE CREDIT LIFE CLAIM

Was this helpful?

  1. Insurpass APi Reference
  2. Credit Life Insurance

Credit Life Claims

Create Credit Life Claims

CREATE CREDIT LIFE CLAIMS

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

This endpoint allows users to create credit life claims.

Headers

Name
Type
Description

Authorization*

String

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

Content-Type*

String

application/json

Request Body

Name
Type
Description

policy_no*

string

The unique number that identifies the purchased insurance policy - IN98570819

loan_balance*

numeric

The amount left to complete the repayment of the loan. - 200,000

{
    "success": true,
    "data": {
        "id": 1,
        "claim_id": "5cf3c24e-4c63-4b7d-8689-7250618befcd",
        "claim_number": "TGC7582803",
        "loan_balance": "100.00",
        "claim_created_at": "2021-07-08T15:01:02.000000Z",
        "status": "Pending",
        "policy_id": 4,
        "created_at": "2021-07-08T15:00:57.000000Z",
        "updated_at": "2021-07-08T15:00:57.000000Z"
    },
    "response_message": "Credit Life Claims saved successfully",
    "response_code": ""
}

Retrieve all Credit Life claims Initiated

ALL CREDIT LIFE CLAIMS

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

Headers

Name
Type
Description

Authorization*

String

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

Content-Type

String

application/json

{
    "success": true,
    "data": {
        "current_page": 1,
        "data": [
            {
                "id": 1,
                "claim_id": "5cf3c24e-4c63-4b7d-8689-7250618befcd",
                "claim_number": "TGC7582803",
                "loan_balance": "100.00",
                "claim_created_at": "2021-07-08T15:01:02.000000Z",
                "status": "Pending",
                "policy_id": 4,
                "merchant_id": 1,
                "created_at": "2021-07-08T15:00:57.000000Z",
                "updated_at": "2021-07-08T15:00:57.000000Z",
                "company_id": "1a9b1e43-8946-4bb7-80d5-bbeef80ecc8e"
            }
        ],
        "first_page_url": "http://sandbox.insurpass.com/merchant/credit_life_claims?page=1",
        "from": 1,
        "last_page": 1,
        "last_page_url": "http://sandbox.insurpass.com/merchant/credit_life_claims?page=1",
        "next_page_url": null,
        "path": "http://sandbox.insurpass.com/merchant/credit_life_claims",
        "per_page": 15,
        "prev_page_url": null,
        "to": 1,
        "total": 1
    },
    "response_message": "Credit Life Claims retrieved successfully",
    "response_code": ""
}

Retrieve details of Credit Life Claims

ALL CREDIT LIFE CLAIM DETAILS

GET https://sandbox.insurpass.com/api/merchant/credit_life_claims/{id}

Headers

Name
Type
Description

Authorization*

String

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

Content-Type*

String

application/json

{
    "success": true,
    "data": {
        "id": 1,
        "claim_id": "5cf3c24e-4c63-4b7d-8689-7250618befcd",
        "claim_number": "TGC7582803",
        "loan_balance": "100.00",
        "claim_created_at": "2021-07-08T15:01:02.000000Z",
        "status": "Pending",
        "policy_id": 4,
        "created_at": "2021-07-08T15:00:57.000000Z",
        "updated_at": "2021-07-08T15:00:57.000000Z"
    },
    "response_message": "Credit Life Claims saved successfully",
    "response_code": ""
}

Archive Credit Life Claims

ARCHIVE CREDIT LIFE CLAIM

PUT https://sandbox.insurpass.com/api/merchant/credit_life_claims/{id}/archive

This endpoint allows a merchant to temporarily halt their customer's credit life claims request.

Headers

Name
Type
Description

Authorization*

String

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

Content-Type*

String

application/json

{
    "success": true,
    "data": {
        "current_page": 1,
        "data": [
            {
                "id": 1,
                "claim_id": "5cf3c24e-4c63-4b7d-8689-7250618befcd",
                "claim_number": "TGC7582803",
                "loan_balance": "100.00",
                "claim_created_at": "2021-07-08T15:01:02.000000Z",
                "status": "Pending",
                "policy_id": 4,
                "merchant_id": 1,
                "created_at": "2021-07-08T15:00:57.000000Z",
                "updated_at": "2021-07-08T15:00:57.000000Z",
                "company_id": "1a9b1e43-8946-4bb7-80d5-bbeef80ecc8e"
            }
        ],
        "first_page_url": "http://sandbox.insurpass.com/merchant/credit_life_claims?page=1",
        "from": 1,
        "last_page": 1,
        "last_page_url": "http://sandbox.insurpass.com/merchant/credit_life_claims?page=1",
        "next_page_url": null,
        "path": "http://sandbox.insurpass.com/merchant/credit_life_claims",
        "per_page": 15,
        "prev_page_url": null,
        "to": 1,
        "total": 1
    },
    "response_message": "Archived",
    "response_code": ""
}
PreviousCredit Life PolicyNextCustomer Journey Guidebook

Last updated 3 years ago

Was this helpful?