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

Was this helpful?

  1. Getting Acquainted with Insurpass API

Before you start

PreviousIntroductionNextAccess to Insurpass API

Last updated 2 years ago

Was this helpful?

Insurpass is organized around and uses as the transport format for requests (using methods such as GET, PUT, POST, DELETE, etc.) and responses (structured in ).

We recommend that you use one of our autogenerated which is made available for several common programming languages, however, the raw HTTP documentation is helpful if your language of choice isn't supported or if you prefer not to use an SDK.

Before you can start building with Insurpass, you'll need to be given access. This access comes in the form of an API key and you will need to request one by signing up .

You can use Insurpass' API in test mode where you can pull test data from all endpoints without affecting your live data. The API key you use to authenticate the request will determine whether the request is in live mode or test mode.

Insurpass' latest version is V1 (version one). As we release new versions, we will communicate changes early enough and limit any modifications that can cause backwards-incompatible changes to applications.

Are there terms you do not understand? Check them out in our , we're sure it'll be of help.

We have also created a Customer Journey Guidebook and UI Sample Kit that serves as a complementary document to this API documentation, it highlights in detail the workflow to adhere to while providing insurance services within your app/platform. Our Customer Journey Guidebook also details User Interface Sample Kit you can build into your frontend component. You can view it .

REST
HTTP protocol
JSON
SDKs
here
Glossary
here