Introduction
Integrate | Underwrite | Manage
Insurerity Digital empowers insurance companies and brokers across Africa to effectively manage and underwrite policies.
We make it very simple for developers to gain access to the extensive functionality and benefit of insurerity’s software through our API. We do all the heavy lifting for you, from automating policy purchase and claims processing to integrating with the National Insurance Commission Motor Insurance Database (NICMID).
This developer-friendly tutorial will help you simply integrate our API and personalize it to suit your brand and business.
Overview
param
Many API methods take optional parameters. For GET requests, any parameters not specified as a segment in the path can be passed as an HTTP query string parameter:
"curl" -i "https://api.insurerity.com/v1/users?name=Doe"
For often POST, PATCH, PUT, and DELETE requests, parameters
not included in the URL should be encoded as JSON with a Content-Type of application/json:
Status Codes
2xx Success
A 2xx status code indicates the request was received and processed successfully.
| Status Code | Description |
|---|---|
| 200 | OK - The request is successful |
| 201 | ACCEPTED - The request is successful and has been accepted for further processing. You will receive a notification once the request has completed. |
4xx Client Errors
A 4xx status code indicates that the request failed due to a client error. The response body generally includes more details about the failure.
| Status Code | Description |
|---|---|
| 400 | Bad Request - The request failed. This will usually occur when validations fail. E.g Missing required fields or invalid JSON |
| 401 | Unauthorized Request - You are not authorized to make this request. This usually occurs when you use an invalid secret key. E.g Missing required fields or invalid JSON |
| 403 | Forbidden Request - You are not forbidden to make this request. This usually occurs when you don't have sufficient right to an endpoint or resource. E.g Missing required fields or invalid JSON |
| 404 | Not Found Request - The request is not found. This will occur when the information request is not found. E.g Querying for a non existent user |
| 409 | Conflict Request - The request is conflicting with another information. This occurs when information provided matches an existing information in the system. |
5xx Server Errors
A 5xx status codes is returned if something goes wrong on Insurerity's end
| Status Code | Description |
|---|---|
| 500 | Internal Server Error - Something has gone wrong on Insurerity's end while attempting to process the request. Our engineering team has been notified of the issue. |
| 503 | Service Unavailable Error - The service you're trying to access is currently not available. |
Http verbs
The Insurerity platform API uses standard HTTP verbs with RESTful semantics for all actions.
Pagination
Requests that return multiple items will be paginated to 100 items by default and will have .
You can specify further pages with the page parameter.
For some resources, you can also set a custom page size up to 100 with the limit parameter.
The page parameter also specificies the current page count you are on example page=1
You can traverse the results by using the prevPage for previous page and nextPage for next page.
For you to confirm the availability of a previous page and next page. you can use the hasPrevPage or hasNextPage respectively which returns a boolean
Reference Documentation
For a complete description of functionality and examples provided by Insurerity's API check out our reference documentation.
Before you begin
The following actions are required.
- An account with Insurerity Digital
- Create an app
- Get your API Key
- And amazing developers
Insurerity's Apps
You can choose from the applications below.
USSD
No internet? No problem. Use insurerity to extend the scope of the microinsurance policies and programs to other demographics that do not have internet access. Using our USSD gateways,you can provide microinsurance services to a wider demographic of clients.Mobile App
Insurerity’s mobile app is a software application developed specifically for use on small and wireless computing devices, such as smartphones and tablets.Website & Web App
Insurerity's web application developed for everyone connected to the internet. you can provide microinsurance services to a wider demographic of clients with just a click of a browser.Embedded & Widget
Use insurerity to extend the scope of the microinsurance policies and programs to your personal software application. Using just an embeddable url, you can provide microinsurance services on already existing applications with minimal effort.
Want to Kickstart?
Start by looking up each API reference and performing your first request.