Konpare Developer Developer
Go to Konpare

Introduction

Welcome to the KONPARE API Documentation for Developers. Find the detailed and step-by-step guidance about KONPARE Product API Solution.

Get Started

To begin with the API Integration you’ll need a ‘Secretkey’. You need to generate the Secretkey from the agent portal. First you’ll need to sign up on www.konpare.online and activate your account by registering all the business details & signing an agreement. Once your account is activated, then from “API Key” in the menu in the portal, click on ‘Generate Key’ to get your Secretkey.

POST OSHC - Get Quote

This API will allow developers to receive all quotes from the listed providers added to the account. The providers' response will be received as per the parameters set such as cover type, start date, end date.

Api Name: https://api.konpare.online/api/v1/tauthprovider
API Content Type : JSON
Request
ATTRIBUTE DESCRIPTION
covervalue
string
mandatory
Description: The cover value should be numeric. Cover type values will be as follows: ‘1' for Single and '2’ for Couple
Example: 1
startdate
string
mandatory
Description: startdate param is used for the cover start date. The date has to be today’s or in the future and must be in the format DD-MMM-YYYY. If the correct format is not entered, the response will fail.
Example: 18-Dec-2020
Enddate
string
mandatory
Description: enddate param is for Cover expiring date and the format has to be DD-MMM-YYYY
Example: 17-Dec-2021
skey
string
mandatory
Description: The secret key that you will receive from the portal.
Learn more.
Example: 2rdChahahhau0f9EmxMEKxgDZzg2ZBkD531bdrBZFH04zSaT1Y=
Response
ATTRIBUTE DESCRIPTION
flag
boolean
Description: This parameter indicate the status of API call.
Example: true/false
message
string
Description: This parameter is the result message which contains information about the result.
Example: success/failed
data
string
Description: This api gives the information about the result of the app.
providerid
int
Description: Provider type like nib/ahm/medibanketc...
Example: 1,2,3
provider
string
Description: Name of provider
Example: Nib/ Ahm/ Medibank etc...
Approved_Insurer_for_Visa
string
Description: Immigration approved
Example: message print
Approved_Insurer_for_Visa_flag
boolean
Description: true
Example: true/false
Policy_Certificate
string
Description: Delivered instantly.
Example: message print
mobile_app_support_android
string
Description: https://play.google.com/store/apps/details?id=au.com.ahm.oshc
Example: message print
mobile_app_support_apple
string
Description: https://itunes.apple.com/au/app/id1456559825
Example: message print
online_membership_account
boolean
Description: true
Example: true/false
home_doctor_services
boolean
Description: true
Example: true/false
support_24_7
string
Description: 1800 006 745
Example: message print
on_campus_support
boolean
Description: false
Example: true/false
doctor_on_demand
boolean
Description: false
Example: true/false
sonder
boolean
Description: undefined
Example: true/false
members_exclusive_discounts
string
Description: 10% discount on AHM travel insurance
Example: message print
members_exclusive_discounts_flag
boolean
Description: true
Example: true/false
members_exclusive_discounts_tooltip
boolean
Description: true
Example: true/false
Multilingual_OSHC_Customer_Service_team
boolean
Description: true
Example: true/false
doctor_visits
string
Description: General Practitioner (GP) consultations
Example: message print
pathology
string
Description: 85% of the MBS fee
Example: message print
radiology
string
Description: 85% of the MBS fee
Example: message print
specialist_consultations
string
Description: 85% of the MBS fee
Example: message print
specialist_consultations
string
Description: 85% of the MBS fee
Example: message print
specialist_consultations
string
Description: 85% of the MBS fee
Example: message print
public_hospital
string
Description: 100% of the cost of overnight and same-day accommodation in a shared or private room
Example: message print
private_hospital
string
Description: 100% of the cost of overnight and same-day accommodation in a shared or private room
Example: message print
private_room
string
Description: Yes if available
Example: message print
public_hospital_flag
boolean
Description: true
Example: true/false
private_hospital_flag
boolean
Description: true
Example: true/false
private_room_flag
boolean
Description: true
Example: true/false
public_hospital_accident_and_emergency
string
Description: public_hospital_accident_and_emergency
Example: message print
contracted_private_hospitals_accident_and_emergency
string
Description: 100% of any facility fee charged by the contracted private hospital for attending their accident and emergency department
Example: message print
non_contract_private_hospitals_accident_and_emergency
string
Description: 100% of any facility fee charged by the non-contracted private hospital for attending their accident and emergency department
Example: message print
public_hospital_accident_and_emergency_flag
boolean
Description: true
Example: true/false
contracted_private_hospitals_accident_and_emergency_flag
boolean
Description: true
Example: true/false
non_contract_private_hospitals_accident_and_emergency_flag
boolean
Description: true
Example: true/false
non_contract_private_hospitals_accident_and_emergency_tooltip
boolean
Description: false
Example: true/false
non_contract_private_hospitals_accident_and_emergency_tooltip_text
string
Description: ==
Example: message print
ambulance_services
boolean
Description: true
Example: true/false
surgically_implanted_prostheses
string
Description: 100% of the benefit as listed in the Australian Government’s Prostheses List
Example: message print
mri
boolean
Description: true
Example: true/false
prescription_medicines
string
Description: Maximum benefit of $50 per prescribed item Co-Payment of $41 for each prescription item Annual limits of: - Single Policy: $300 pa - Non-Single Policy: $600 pa (max $300 per person)
Example: message print
surgically_implanted_prostheses_flag
boolean
Description: true
Example: true/false
psychiatric_conditions
string
Description: 2 months
Example: message print
pregnancy_and_birth_related_services
string
Description: 12 months
Example: message print
other_pre_exisiting_conditions
string
Description: 12 months
Example: message print
refund_policy
string
Description: Limited refund admin fee may apply. Refunds should be requested by phone
Example: message print
best_choice_for
string
Description: Couple & Single Plans
Example: message print
mobile_app_to_launch_claims
string
Description:
Example: message print
helpline_24_7
string
Description: 1800 006 745
Example: message print
on_campus_support_tool_tip
string
Description:
Example: message print
policy_certificate_tool_tip
string
Description: Instantly on this site
Example: message print
home_doctor_tool_tip
string
Description:
Example: message print
single_parent_cover
string
Description:
Example: message print
emergency_assistance
string
Description:
Example: message print
logo
string
Description: Provider logo
Example: https://konpare.online/images/ahm-logo.png
link
string
Description: https://konpare.online/summary
Example: message print
providerName
string
Description: AHM
Example: message print
price
string
Description: Policy price based on Start date and end date
Example: $1745.90
pdfFilePath
string
Description: brochure Url
Example: https://konpare.online/static/oshc/ahm_OSHC_Cover_Summary.pdf
isActive
true
Description: Active/inactive
Example: message print
commissionpercentge
string
Description: Provider commissionpercentge
Example: 147.67
getqouteurl
string
Description: This is summary page url it will redirect to payment summary form
Example: http://kondeskvisa.demo.konpare.online/summary?crmcode=qy088tpXmWDDWsZ6r9hY-ZS-WPgIPkfCEvGiZY0dAMhgDHwqOpA9ZSCacidcakAsgll8noGeuqXcDF17ywHmhCYjzZ3oUSjuRRDXOXijUDeOUDUoS2goYLGfVDvW32dOGWLad_XXchFAGxwzLrCMgYCQyNpnAGV1_OKE-K4UKyPeFR1z78IXN22wiW57sJy5
https://api.konpare.online/api/v1/tauthprovider
Request
Copy to Clipboard
var http = require('follow-redirects').http; var fs = require('fs'); var options = {   'method': 'POST',   'hostname': 'https://api.konpare.online',   'path': '/api/v1/tauthprovider',   'headers':{     'Content-Type' : 'application/json'   },   'maxRedirects':20 }; var req = http.request(options, function (res) { var chunks = [];   res.on("data", function (chunk) {     chunks.push(chunk); });   res.on("end", function (chunk) {   var body = Buffer.concat(chunks);   console.log(body.toString()); });   res.on("error", function (error) {   console.error(error);  }); }); var postData = ({   "skey": "secretkey pass",  "covervalue":" "4"",  "startdate": "18-Dec-2020",  "enddate":"17-Dec-2021" }); req.write(postData); req.end();
Copy to Clipboard
var client = "new RestClient("https://api.konpare.online/api/v1/tauthprovider");"; client.Timeout = -1; var request = new RestRequest(Method.POST); request.AddHeader("Content-Type" : "application/json"); var body = @"{    " @" ""skey"":""secretkey pass"",    " @" ""covervalue"":""4"",    " @" ""startdate"":""18-Dec-2020"",    " @" ""enddate"":""17-Dec-2021"",    " @"}    " @"";
Copy to Clipboard
OkHttpClient client = new OkHttpClient().newBuilder().build(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{ \"skey\":\"Your secretkey pass\", \"covervalue\":\"4\", \"startdate\":\"18-Dec-2020\", \"enddate\":\"17-Dec-2021\"  } "); Request request = new Request.Builder() .url("https://api.konpare.online/api/v1/tauthprovider") .method("POST", body) .addHeader("Content-Type", "application/json") .build(); Response response = client.newCall(request).execute();
Copy to Clipboard
$curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL => 'https://api.konpare.online/api/v1/tauthprovider', 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 =>'{ "skey":"Your secretkey pass", "covervalue":"4", "startdate":"18-Dec-2020", "enddate":"17-Dec-2021" } ', CURLOPT_HTTPHEADER => array( 'Content-Type: application/json'   ), )); $response = curl_exec($curl); curl_close($curl); echo $response;
Copy to Clipboard
import requests import json url = "https://api.konpare.online/api/v1/tauthprovider" payload = json.dumps({ "skey": "Your secretkey pass", "covervalue":"4", "startdate": "18-Dec-2020", "enddate": "17-Dec-2021" }) headers = { 'Content-Type': 'application/json' } response = requests.request("POST", url, headers=headers, data=payload) print(response.text)
Copy to Clipboard
require "uri" require "json" require "net/http" url = URI("https://api.konpare.online/api/v1/tauthprovider") http = Net::HTTP.new(url.host, url.port); request = Net::HTTP::Post.new(url) request["Content-Type"] = "application/json" request.body = JSON.dump({ "skey": "Your secretkey pass", "covervalue":"4", "startdate": "18-Dec-2020", "enddate": "17-Dec-2021" }) response = http.request(request) puts response.read_body
Response
Copy to Clipboard
{ "flag": true, "message": "success", "data": "5", "outdata": [ {   "providerid": "4",   "provider": "ahm",   "approved_Insurer_for_Visa": "Immigration approved",   "approved_Insurer_for_Visa_flag": true,   "Policy_Certificate": "Delivered instantly",   "mobile_app_support_android": "https://play.google.com/store/apps/details?id=au.com.ahm.oshc",   "mobile_app_support_apple": "https://itunes.apple.com/au/app/id1456559825",   "online_membership_account": true,   "home_doctor_services": true,   "support_24_7": "1800 006 745",   "on_campus_support": false,   "doctor_on_demand": false,   "sonder": false,   "members_exclusive_discounts": "10% discount on AHM travel insurance",   "members_exclusive_discounts_flag": true,   "members_exclusive_discounts_tooltip": true,   "multilingual_OSHC_Customer_Service_team": true,   "doctor_visits": "General Practitioner (GP) consultations",   "pathology": "85% of the MBS fee",   "radiology": "85% of the MBS fee",   "specialist_consultations": "85% of the MBS fee",   "public_hospital": "100% of the cost of overnight and same-day accommodation in a shared or private room",   "private_hospital": "100% of the cost of overnight and same-day accommodation in a shared or private room",   "private_room": "Yes if available",   "public_hospital_flag": true,   "private_hospital_flag": true,   "private_room_flag": true,   "public_hospital_accident_and_emergency": "100% of charges raised by the Public hospital for attending their accident and emergency department",   "contracted_private_hospitals_accident_and_emergency": "100% of any facility fee charged by the contracted private hospital for attending their accident and emergency department",   "non_contract_private_hospitals_accident_and_emergency": "100% of any facility fee charged by the non-contracted private hospital for attending their accident and emergency department",   "public_hospital_accident_and_emergency_flag": true,   "contracted_private_hospitals_accident_and_emergency_flag": true,   "non_contract_private_hospitals_accident_and_emergency_flag": true,   "non_contract_private_hospitals_accident_and_emergency_tooltip": false,   "non_contract_private_hospitals_accident_and_emergency_tooltip_text": "",   "ambulance_services": true,   "surgically_implanted_prostheses": "100% of the benefit as listed in the Australian Government’s Prostheses List",   "mri": true,   "prescription_medicines": "Maximum benefit of $50 per prescribed item
Co-Payment of $41 for each prescription item
Annual limits of:
- Single Policy: $300 pa
- Non-Single Policy: $600 pa (max $300 per person)",   "surgically_implanted_prostheses_flag": true,   "psychiatric_conditions": "2 months",   "pregnancy_and_birth_related_services": "12 months",   "other_pre_exisiting_conditions": "12 months",   "refund_policy": "Limited refund admin fee may apply. Refunds should be requested by phone.",   "best_choice_for": "Couple & Single Plans",   "mobile_app_to_launch_claims": "",   "helpline_24_7": "1800 006 745",    "on_campus_support_tool_tip": "",   "policy_certificate_tool_tip": "Instantly on this site",   "home_doctor_tool_tip": "",   "single_parent_cover": "",   "emergency_assistance": "",   "logo": "https://konpare.online/images/ahm-logo.png",   "link": "https://konpare.online/summary",   "providerName": "AHM",   "price": "$1476.70",   "pdfFilePath": "https://konpare.online/static/oshc/ahm_OSHC_Cover_Summary.pdf",   "isActive": true,   "commissionpercentge": 147.6700,   "getqouteurl": "http://kondeskvisa.demo.konpare.online/summary?crmcode=qy088tpXmWDDWsZ6r9hY-ZS-WPgIPkfCEvGiZY0dAMhgDHwqOpA9ZSCacidcakAsgll8noGeuqXcDF17ywHmhCYjzZ3oUSjuRRDXOXijUDcM2rYTmAr-wskxzSEPdj2vrWqTSaCO-2Fw_I42vk0Naf-_89-DkZG9-WKV7_bFDKvlF783XyXx_UD7b2WNBAoQ" }   ],   "emaillink": null,   "other": null  }

POST Purchase Policy

This API will authenticate the user to purchase the policy. To purchase the policy you will have to pass all the parameters. Once the data is posted you’ll receive the response in JSON format. It will contain a parameter with a payment link. To collect the payment you need to redirect it to the payment link.

Api Name: https://api.konpare.online/api/v1/tsaveinquiry
API Content Type : JSON
Request
ATTRIBUTE DESCRIPTION
Secrete key which is genrated by konpare crm.
ATTRIBUTE DESCRIPTION
skey
string
mandatory
Description: The secret key that you will receive from the portal.
Learn more.
Example: 8ZQKnmGB70MNTFR1G2abBtjfU0V1ssshha++Gq8PnmosbbGxM=
List Of Applicant details.
ATTRIBUTE DESCRIPTION
title
string
Not mandatory
Description: Student title
Example: Mr. , Ms. , Dr etc...
leadfirstname
string
mandatory
Description: Mention Student Firstname
Example: ABC
leadlastname
string
mandatory
Description: Mention Student Lastname
Example: DEF
gender
string
mandatory
Description: Mention type of gender
Example: Male/ Female/ Other
dateofbirth
string
mandatory
Description: Mention Date of Birth (Date formate DD/MM/YYYY)
Example: 01/01/1991
emailaddress
string
mandatory
Description: Mention Student Email Address
Example: abc123@gmail.com
phoneno
string
mandatory
Description: Mention Student phone number
Example: 1235678965
maritalstatus
string
Not mandatory
Description: Mention marial satus of student
Example: single/merride/windows etc..
leadfrom
string
mandatory
Description: Mention Lead come out source like facebook, linked in, twitter
Example: FB, Whats up/, WeChat etc...
ipaddress
string
mandatory
Description: Mention Student system ip address to track inquiry location wise
Example: 111.202.112:58
productid
int
mandatory
Description: Mention type of insurance id
Example: Nib, Bupa, Ahm, Medibank, Allianz
useridf
int
Not mandatory
Description: Mention Your System user Id
Example: Yogesh your system account and yogesh id 105 mention 105 in useridf
leadtype
string
mandatory
Description: Mention lead type
Example: Inquiry/ Email quote
leadsource
string
mandatory
Description: Mention lead source type
Example: CRM, Widget and whitelable
notes
string
Not mandatory
Description: Mention Notes to easily identify inquiry
Example: your inquiry has been book
createdby
int
Not mandatory
Description: Mention Your System user Id
Example: Yogesh your system account and yogesh id 105 mention 105 in useridf
This parameter is an array of object and should contain the details of recipients i.e. role, lastname,givenname,relationshipid,passportno,passportissuingcountry and dateofbirth.
ATTRIBUTE DESCRIPTION
Mention lastname
string
mandatory
Description: Last Name
Example: abc
givenname
string
mandatory
Description: Mention First Name
Example: pqr
relationshipid
string
mandatory
Description: pass relationshipid based on realtionship
Example: Son=1,Partner=3,Daughter=18
passportno
string
mandatory
Description: passport no
Example: appao78745
passportissuingcountry
string
mandatory
Description: County Name
Example: India,Au
dateofbirth
string
Description: dateofbirth
Example: 08-Oct-1993
lastname
string
mandatory
Description: Mention secoudary applicant last name
Example:
givenname
string
Description: Mention secoundary applicant first name
Example:
relationship
string
Description: Mention relationship name
Example: Son/dauter, father, mother
passportno
string
Description: Mention Passport number
Example:
passportissuingcountry
string
mandatory
Description: Mention passport issue country
Example: India/ Austrlia etc...
dateofbirth
string
mandatory
Description: Mention secondary applicant date of birth (DD/MM/YYYY)
Example: 18-Sep-1992
insuranceproviderid
string
mandatory
Description: Insurance Product Id
Example: Nib for 1, Ahm for 2 etc
insurancetype
string
Not mandatory
Description: Mention Insurance type OSHC fix
Example: OSHC
covertype
string
mandatory
Description: Mention Covert Type
Example: Single, Couple, Family etc...
insurancestartdate
string
mandatory
Description: Mention Insurance Start date
Example: 19-Sep-1992
insuranceenddate
string
mandatory
Description: Mention Insurance End date
Example: 19-Sep-1992
addressline1
string
mandatory
Description: Mention Address line 1 if living austrlia
Example:
addressline2
string
mandatory
Description: Mention Address line 2 if living austrlia
Example:
country
string
mandatory
Description: Mention Country if living austrlia
Example:
city
string
mandatory
Description: Mention City if living austrlia
Example:
state
string
mandatory
Description: Mention State if living austrlia
Example:
zipcode
string
mandatory
Description: Mention Zip code if living austrlia
Example:
isliveinaustralia
string
mandatory
Description: If isliveinaustralia is false then addressline1 addressline2,zipcode,city,state etc not mandatory Mention check box true false living austrlia
Example:
australianumber
string
mandatory
Description: mention Austrlia number
Example:
studentnumber
string
Not mandatory
Description: Mention Student number
Example:
coestartdate
string
mandatory
Description: Mention COE start date
Example: dd/mm/yyyy
coeenddate
string
mandatory
Description: Mention COE end date
Example: dd/mm/yyyy
insuranceamount
string
mandatory
Description: Mention Insurance Amount
Example:
insuranceaudamount
string
mandatory
Description: Mention Insurance AMount
Example:
isemailquote
boolen
mandatory
Description: Mention True/false to send email to the student for quote information
Example: true
currentresidentcountry
string
mandatory
Description: Mention current resident country
Example:
singlename
boolen
mandatory
Description: Mention true/false to take single name as a full name
Example: abc def not pass last name
referencename
string
mandatory
Description: Mention Rerrence name of employee
Example: Pass any name
List Of External parameter details.
ATTRIBUTE DESCRIPTION
title
string
mandatory
Description: Page Meta data 1
Example: student name xyz and id 123
Other
string
mandatory
Description: Google rank page 5
terere
string
mandatory
Description: dsfsfds
fsdfsdfds
string
mandatory
Description: sfdfsd
SuccessUrl
string
mandatory
Description: Mention Success URL of return page after success payment
Example: https://yourdomain.com/yourpage-successpage
CancelUrl
string
mandatory
Description: Mention Fail URL of return fail or cancel payment
Example: https://yourdomain.com/yourpage-successpage
Response
ATTRIBUTE DESCRIPTION
flag
boolean
Description: Return Api success and fail response
Example: true/false
message
string
Description: Return Message of api response
Example: message print
data
string
Description: Stripe payment link to take payment for this url
Example: https://checkout.stripe.com/pay/cs_test_a1nRWFEoL8IG05XlquP5iYC8MLDG77g4wcWny6qXwSfsOLpPUTaSq3fim5#fidkdWxOYHwnPyd1blpxYHZxWmpSZDRqYGhRYTcxc25scUZ3QEJfUGRoaTU1bmtgUUxDdHwnKSdobGF2Jz9%2BJ2JwbGEnPydLRCcpJ2hwbGEnPyc9NzU3ZjM0PCgyZzZkKDE8Z2coZDJjYShnMjcxYTxhNTMxM2A0MWA2ZmAnKSd2bGEnPyc2ZzY1Z2A8PCg9NDJmKDExYTEoPGY0YCg3MDU0NWQ9NWFgYzY8Nzw0PDEneCknZ2BxZHYnP15YKSdpZHxqcHFRfHVgJz8ndmxrYmlgWmxxYGgnKSdga2RnaWBVaWRmYG1qaWFgd3YnP3F3cGApJ3dgY2B3d2B3SndsYmxrJz8nbXFxdT8qKm1wdmBgYGArYWBoaituamt1ZHdgK2praWxrYCd4JSUl
outdata
string
Description: Last inserted record id return
Example: last inserted record 10001
emaillink
string
Description: Emial quote link return
Example: http://testwedmb.demo.konpare.online/summary?crmcode=69GaXFokNUw7I-ZZb6zLoaa4HC9STkhls8p17nBgUbx9-bzvKZDvGSpEZPkrd2fAvBt1H0GKESquQFMnLqiibP4pnT_v2VhHqygPjQoRiZSBGM6zhGvR-yLkUzAgtmoUAehNsZZS32GbSHW4nR3DKHNXp434QoWtb_DGytpHR1T2yhQ0z96DA9IRu9eFa4vcLNLDIqV_IV8nRTeMh_Kba9eh1cN9ddXdaAe8acEH5vXyQHN7K9K0G_dUXDVTg-OHgtTvQHa9VHILpV4i2Zor5w3TlUT_hv1398yZErMY1A2MsGbmAKbED3ujWD0wXSFEn5dRgiBIobRDjnspKZPbjQ==
other
string
Description: Lead code return
Example: LEAD0001
https://api.konpare.online/api/v1/tsaveinquiry
Request
Copy to Clipboard
var http = require('follow-redirects').http; var fs = require('fs'); var options = {   'method': 'POST',   'hostname': 'https://api.konpare.online',   'path': '/api/v1/tsaveinquiry',   'headers':{     'Content-Type' : 'application/json'   },   'maxRedirects':20 }; var req = http.request(options, function (res) { var chunks = [];   res.on("data", function (chunk) {     chunks.push(chunk); });   res.on("end", function (chunk) {   var body = Buffer.concat(chunks);   console.log(body.toString()); });   res.on("error", function (error) {   console.error(error);  }); }); var postData = JSON.stringify({   "secretkey": { "skey": "secretkey pass" },  "purchasepolicy": {   "leadid": 0,  "title": "Mr.",  "leadcode":null  "leadfirstname":"Suraj Thakkar",  "leadlastname": null,  "gender":"Male"  "dateofbirth":"08-Oct-1993",  "emailaddress": "test@gmail.com",  "phoneno":"7016284255"  "maritalstatus":null,  "companyid": "32",  "branchid":"0"  "isactive":true,  "leadfrom": "Konpare-Web",  "ipaddress":"110.175.32.102"  "productid":3,  "useridf": 0,  "leadtype":"Inquiry"  "leadsource":"mobile-whitelabel",  "notes": "Provider:NIB, CoverType:Single, StartDate:31-08-2021, EndDate:08-07-2022",  "createdby":0  "listsecondaryapplicant":[],  "insuranceproviderid": 3,  "insurancetype":"OSHC"  "covertype":"Single",  "insuranceprovider": null,  "insuranceplan":""  "insurancestartdate":"31-Aug-2021",  "insuranceenddate": "08-July-2022",  "addressline1":"29 plane street"  "addressline2":" ",  "country": "",  "city":"Thomastown"  "state":"VICTORIA",  "zipcode": "3074",  "passportnumber":"rt64654655"  "passportissuingcountry":"India",  "university": "Other",  "isliveinaustralia":true  "australianumber":"0434020708",  "studentnumber": "A00066452",  "coestartdate":"31-Aug-2021",  "coeenddate":"08-Jul-2022"  "insuranceamount":"440.24",  "insuranceaudamount": "440.24",  "isbuyinsurance":false  "isemailquote":"false"  "currentresidentcountry":"Australia",  "singlename": true,  "merchantname":null  "policynumber":""  "isextension":false,  "referencename": null },  "metadata":{   "title": "Page Meta data 1",   "other": "Google rank page 5",   "terere": "dsfsfds",   "fsdfsdfds": "sfdfsd" },   "SuccessUrl": "https://yourdomain.com/yourpage-successpage",   "CancelUrl": "https://yourdomain.com/yourpage-cancelpage" }); req.write(postData); req.end();
Copy to Clipboard
var client = new RestClient("https://api.konpare.online/api/v1/tsaveinquiry");"; client.Timeout = -1; var request = new RestRequest(Method.POST); request.AddHeader("Content-Type" : "application/json"); var body = @"{    " @" ""secretkey"": {    " @" ""skey"": ""Your secretkey pass""   " @" },   " @" ""purchasepolicy"": {   " @" ""leadid"": 0,   " @" ""title"": ""Mr."",   " @" ""leadcode"": null,   " @" ""leadfirstname"": ""Suraj Thakkar"",    " @" ""leadlastname"": null,   " @" ""gender"": ""female"",    " @" ""dateofbirth"": ""08-Oct-1993"",   " @" ""emailaddress"": ""test@gmail.com"",    " @" ""phoneno"": ""1234567890"",   " @" ""maritalstatus"": null,   " @" ""companyid"": 32,    " @" ""branchid"": 0,    " @" ""isactive"": true,   " @" ""leadfrom"": ""Konpare-Web"",   " @" ""ipaddress"": ""110.175.32.102"",   " @" ""productid"": 3,   " @" ""useridf"": 0,   " @" ""leadtype"": ""Inquiry"",   " @" ""leadsource"": ""mobile-whitelabel"",   " @" ""notes"": ""Provider:NIB, CoverType:Single, StartDate:31-08-2021, EndDate:08-07-2022"",   " @" ""createdby"": 0,   " @" ""listsecondaryapplicant"": [],   " @" ""insuranceproviderid"": 3,   " @" ""insurancetype"": ""OSHC"",   " @" ""covertype"": ""Single"",   " @" ""insuranceprovider"": null,   " @" ""insuranceplan"": """",   " @" ""insurancestartdate"": ""31-Aug-2021"",   " @" ""insuranceenddate"": ""08-July-2022"",   " @" ""addressline1"": ""29 plane street"",   " @" ""addressline2"": """",   " @" ""country"": """",   " @" ""city"": ""Thomastown "",    " @" ""state"": ""VICTORIA"",   " @" ""zipcode"": ""3074"",   " @" ""passportnumber"": ""rt64654655"",    " @" ""passportissuingcountry"": ""India"",   " @" ""university"": ""Other"",   " @" ""isliveinaustralia"": true,   " @" ""australianumber"": ""0434020708"",   " @" ""studentnumber"": ""A00066452"",   " @" ""coestartdate"": ""31-Aug-2021"",   " @" ""coeenddate"": ""08-Jul-2022"",   " @" ""insuranceamount"": ""440.24"",   " @" ""insuranceaudamount"": ""440.24"",   " @" ""isbuyinsurance"": false,   " @" ""isemailquote"": ""false"",   " @" ""currentresidentcountry"": ""Australia"",   " @" ""singlename"": true,   " @" ""merchantname"": null,   " @" ""policynumber"": """",   " @" ""isextension"": false,   " @" ""referencename"": null   " @"    },    " @" ""metadata"":    " @" {   " @" ""title"":""Page Meta data 1"",    " @" ""other"":""Google rank page 5"",    " @" ""terere"":""dsfsfds"",    " @" ""fsdfsdfds"":""sfdfsd""   " @" }   " @" ,   " @" ""SuccessUrl"": ""https://yourdomain.com/yourpage-successpage"",    " @" ""CancelUrl"": ""https://yourdomain.com/yourpage-cancelpage""    " @"}    " @"";
Copy to Clipboard
OkHttpClient client = new OkHttpClient().newBuilder().build(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{ \"secretkey\": { \"skey\": \"Your secretkey pass\" }, \"purchasepolicy\": { \"leadid\": 0, \"title\": \"Mr.\", \"leadcode\": null, \"leadfirstname\": \"Suraj Thakkar\", \"leadlastname\": null, \"gender\": \"female\", \"dateofbirth\": \"08-Oct-1993\", \"emailaddress\": \"test@gmail.com\", \"phoneno\": \"1234567890\", \"maritalstatus\": null, \"companyid\": 32, \"branchid\": 0, \"isactive\": true, \"leadfrom\": \"Konpare-Web\", \"ipaddress\": \"110.175.32.102\", \"productid\": 3, \"useridf\": 0, \"leadtype\": \"Inquiry\", \"leadsource\": \"mobile-whitelabel\", \"notes\": \"Provider:NIB, CoverType:Single, StartDate:31-08-2021, EndDate:08-07-2022\", \"createdby\": 0, \"listsecondaryapplicant\": [], \"insuranceproviderid\": 3, \"insurancetype\": \"OSHC\", \"covertype\": \"Single\", \"insuranceprovider\": null, \"insuranceplan\": \"\", \"insurancestartdate\": \"31-Aug-2021\", \"insuranceenddate\": \"08-July-2022\", \"addressline1\": \"29 plane street\", \"addressline2\": \"\", \"country\": \"\", \"city\": \"Thomastown \", \"state\": \"VICTORIA\", \"zipcode\": \"3074\", \"passportnumber\": \"rt64654655\", \"passportissuingcountry\": \"India\", \"university\": \"Other\", \"isliveinaustralia\": true, \"australianumber\": \"0434020708\", \"studentnumber\": \"A00066452\", \"coestartdate\": \"31-Aug-2021\", \"coeenddate\": \"08-Jul-2022\", \"insuranceamount\": \"440.24\", \"insuranceaudamount\": \"440.24\", \"isbuyinsurance\": false, \"isemailquote\": \"false\", \"currentresidentcountry\": \"Australia\", \"singlename\": true, \"merchantname\": null, \"policynumber\": \"\", \"isextension\": false, \"referencename\": null  }, \"metadata\": { \"title\":\"Page Meta data 1\", \"other\":\"Google rank page 5\", \"terere\":\"dsfsfds\", \"fsdfsdfds\":\"sfdfsd\" } , \"SuccessUrl\": \"https://yourdomain.com/yourpage-successpage\", \"CancelUrl\": \"https://yourdomain.com/yourpage-cancelpage\"\ r\n }  "); Request request = new Request.Builder() .url("https://api.konpare.online/api/v1/tsaveinquiry") .method("POST", body) .addHeader("Content-Type", "application/json") .build(); Response response = client.newCall(request).execute();
Copy to Clipboard
$curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL => 'https://api.konpare.online/api/v1/tauthprovider', 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 => '{ "secretkey": { "skey": "Your secretkey pass" }, "purchasepolicy": { "leadid":0, "title": "Mr.", "leadcode": null, "leadfirstname": "Suraj Thakkar", "leadlastname": null, "gender": "female", "dateofbirth": "08-Oct-1993", "emailaddress": "test@gmail.com", "phoneno": "1234567890", "maritalstatus": null, "companyid": 32, "branchid": 0, "isactive": true, "leadfrom": "Konpare-Web", "ipaddress": "110.175.32.102", "productid": 3, "useridf": 0, "leadtype": "Inquiry", "leadsource": "mobile-whitelabel", "notes": "Provider:NIB, CoverType:Single, StartDate:31-08-2021, EndDate:08-07-2022", "createdby": 0, "listsecondaryapplicant": [], "insuranceproviderid": 3, "insurancetype": "OSHC", "covertype": "Single", "insuranceprovider": null, "insuranceplan": "", "insurancestartdate": "31-Aug-2021", "insuranceenddate": "08-July-2022", "addressline1": "29 plane street", "addressline2": "", "country": "", "city": "Thomastown ", "state": "VICTORIA", "zipcode": "3074", "passportnumber": "rt64654655", "passportissuingcountry": "India", "university": "Other", "isliveinaustralia": true, "australianumber": "0434020708", "studentnumber": "A00066452", "coestartdate": "31-Aug-2021", "coeenddate": "08-Jul-2022", "insuranceamount": "440.24", "insuranceaudamount": "440.24", "isbuyinsurance": false, "isemailquote": "false", "currentresidentcountry": "Australia", "singlename": true, "merchantname": null, "policynumber": "", "isextension": false, "referencename": null }, "metadata": { "title":"Page Meta data 1", "other":"Google rank page 5", "terere":"dsfsfds", "fsdfsdfds":"sfdfsd" } , "SuccessUrl": "https://yourdomain.com/yourpage-successpage", "CancelUrl": "https://yourdomain.com/yourpage-cancelpage" } ', CURLOPT_HTTPHEADER => array( 'Content-Type: application/json'   ), )); $response = curl_exec($curl); curl_close($curl); echo $response;
Copy to Clipboard
import requests import json url = "https://api.konpare.online/api/v1/tsaveinquiry" payload = json.dumps({ secretkey": { "skey": "Your secretkey pass" }, "purchasepolicy": { "leadid": 0, "title": "Mr.", "leadcode": None, "leadfirstname": "Suraj Thakkar", "leadlastname": None, "gender": "female", "dateofbirth": "08-Oct-1993", "emailaddress": "test@gmail.com", "phoneno": "1234567890", "maritalstatus": None, "companyid": 32, "branchid": 0, "isactive": True, "leadfrom": "Konpare-Web", "ipaddress": "110.175.32.102", "productid": 3, "useridf": 0, "leadtype": "Inquiry", "leadsource": "mobile-whitelabel", "notes": "Provider:NIB, CoverType:Single, StartDate:31-08-2021, EndDate:08-07-2022", "createdby": 0, "listsecondaryapplicant": [], "insuranceproviderid": 3, "insurancetype": "OSHC", "covertype": "Single", "insuranceprovider": None, "insuranceplan": "", "insurancestartdate": "31-Aug-2021", "insuranceenddate": "08-July-2022", "addressline1": "29 plane street", "addressline2": "", "country": "", "city": "Thomastown", "state": "VICTORIA", "zipcode": "3074", "passportnumber": "rt64654655", "passportissuingcountry": "India", "university": "Other", "isliveinaustralia": True, "australianumber": "0434020708", "studentnumber": "A00066452", "coestartdate": "31-Aug-2021", "coeenddate": "08-Jul-2022", "insuranceamount": "440.24", "insuranceaudamount": "440.24", "isbuyinsurance": False, "isemailquote": "false", "currentresidentcountry": "Australia", "singlename": True, "merchantname": None, "policynumber": "", "isextension": False, "referencename": None }, "metadata": { "title": "Page Meta data 1", "other": "Google rank page 5", "terere": "dsfsfds", "fsdfsdfds": "sfdfsd" }, "SuccessUrl": "https://yourdomain.com/yourpage-successpage", "CancelUrl": "https://yourdomain.com/yourpage-cancelpage" }) headers = { 'Content-Type': 'application/json' } response = requests.request("POST", url, headers=headers, data=payload) print(response.text)
Copy to Clipboard
require "uri" require "json" require "net/http" url = URI("https://api.konpare.online/api/v1/tsaveinquiry") http = Net::HTTP.new(url.host, url.port); request = Net::HTTP::Post.new(url) request["Content-Type"] = "application/json" request.body = JSON.dump({ secretkey": { "skey": "Your secretkey pass" }, "purchasepolicy": { "leadid": 0, "title": "Mr.", "leadcode": nil, "leadfirstname": "Suraj Thakkar", "leadlastname": nil, "gender": "female", "dateofbirth": "08-Oct-1993", "emailaddress": "test@gmail.com", "phoneno": "1234567890", "maritalstatus": nil, "companyid": 32, "branchid": 0, "isactive": True, "leadfrom": "Konpare-Web", "ipaddress": "110.175.32.102", "productid": 3, "useridf": 0, "leadtype": "Inquiry", "leadsource": "mobile-whitelabel", "notes": "Provider:NIB, CoverType:Single, StartDate:31-08-2021, EndDate:08-07-2022", "createdby": 0, "listsecondaryapplicant": [], "insuranceproviderid": 3, "insurancetype": "OSHC", "covertype": "Single", "insuranceprovider": nil, "insuranceplan": "", "insurancestartdate": "31-Aug-2021", "insuranceenddate": "08-July-2022", "addressline1": "29 plane street", "addressline2": "", "country": "", "city": "Thomastown", "state": "VICTORIA", "zipcode": "3074", "passportnumber": "rt64654655", "passportissuingcountry": "India", "university": "Other", "isliveinaustralia": True, "australianumber": "0434020708", "studentnumber": "A00066452", "coestartdate": "31-Aug-2021", "coeenddate": "08-Jul-2022", "insuranceamount": "440.24", "insuranceaudamount": "440.24", "isbuyinsurance": False, "isemailquote": "false", "currentresidentcountry": "Australia", "singlename": True, "merchantname": nil, "policynumber": "", "isextension": False, "referencename": nil }, "metadata": { "title": "Page Meta data 1", "other": "Google rank page 5", "terere": "dsfsfds", "fsdfsdfds": "sfdfsd" }, "SuccessUrl": "https://yourdomain.com/yourpage-successpage", "CancelUrl": "https://yourdomain.com/yourpage-cancelpage" }) response = http.request(request) puts response.read_body
Response
Copy to Clipboard
{   "flag": true,   "message": "success",   "data": "https://checkout.stripe.com/pay/cs_test_a1snqJStlzW8YC4iFCK0dFYhP1u3DCerDULDlD0vO0OZrCoufiRs4sUO0m#fidkdWxOYHwnPyd1blpxYHZxWmpSZDRqYGhRYTcxc25scUZ3QEJfUGRoaTU1bmtgUUxDdHwnKSdobGF2Jz9%2BJ2JwbGEnPydLRCcpJ2hwbGEnPyc9NzU3ZjM0PCgyZzZkKDE8Z2coZDJjYShnMjcxYTxhNTMxM2A0MWA2ZmAnKSd2bGEnPyc2ZzY1Z2A8PCg9NDJmKDExYTEoPGY0YCg3MDU0NWQ9NWFgYzY8Nzw0PDEneCknZ2BxZHYnP15YKSdpZHxqcHFRfHVgJz8ndmxrYmlgWmxxYGgnKSdga2RnaWBVaWRmYG1qaWFgd3YnP3F3cGApJ3dgY2B3d2B3SndsYmxrJz8nbXFxdT8qKm1wdmBgYGArYWBoaituamt1ZHdgK2praWxrYCd4JSUl",   "outdata": 1108,   "emaillink": "http://testwedmb.demo.konpare.online/summary?crmcode=69GaXFokNUw7I-ZZb6zLoaa4HC9STkhls8p17nBgUbx9-bzvKZDvGSpEZPkrd2fAvBt1H0GKESquQFMnLqiibP4pnT_v2VhHqygPjQoRiZSBGM6zhGvR-yLkUzAgtmoUAehNsZZS32GbSHW4nR3DKHNXp434QoWtb_DGytpHR1T2yhQ0z96DA9IRu9eFa4vcLNLDIqV_IV8nRTeMh_Kba9eh1cN9ddXdaAe8acEH5vXyQHN7K9K0G_dUXDVTg-OHgtTvQHa9VHILpV4i2Zor5w3TlUT_hv1398yZErMY1A2MsGbmAKbED3ujWD0wXSFEn5dRgiBIobRDjnspKZPbjQ==",   "other": "LEAD00010" }
Copy to Clipboard
Dictionary <string, object> body = new Dictionary<string, object>(); Dictionary <string, object> requestBody = new Dictionary<string, object>(); body.Add("client_id" : "YOUR CLIENT ID"); body.Add("authorization_id" : "YOUR AUTHENTICATION ID"); requestBody.Add("body", body); string post_data = JsonConvert.SerializeObject(requestBody); string url = "https://console.konsign.com/api/oauth/auth"; HttpWebRequest webRequest = (HttpWebRequest)WebRequest.Create(url); webRequest.Method = "POST"; webRequest.ContentType = "application/json"; webRequest.ContentLength = post_data.Length; using (StreamWriter requestWriter = new StreamWriter(webRequest.GetRequestStream())) {   requestWriter.Write(post_data); } string responseData = string.Empty; using (StreamReader responseReader = new StreamReader(webRequest.GetResponse().GetResponseStream())) {   responseData = responseReader.ReadToEnd();   Console.WriteLine(responseData);

POST Get OVHC Quote

This API will allow developers to receive all quotes from the listed providers added to the account. The providers response will be received as per the parameters set such as cover type, start date, end date.

Api Name: https://api.konpare.online/api/v1/tovhcauthprovider
API Content Type : JSON
Request
ATTRIBUTE DESCRIPTION
covervalue
string
mandatory
Description: The cover value should be numeric. Cover type values will be as follows: ‘1' for Single and '2’ for Couple
Example: 1
providerid
string
mandatory
Description: Please enter provider id
Example: 1
startdate
string
mandatory
Description: startdate param is used for the cover start date. The date has to be today’s or in the future and must be in the format DD-MMM-YYYY. If the correct format is not entered, the response will fail.
Example: 22-Jan-2021
skey
string
mandatory
Description: The secret key that you will receive from the portal.
Learn more.
Example: Qx2a9uWWgVW9XEy27LhpfN3zdywz9OL+54DSc7+lRJY=
Response
ATTRIBUTE DESCRIPTION
flag
boolean
Description: This parameter indicate the status of API call.
Example: true/false
message
string
Description: This parameter is the result message which contains information about the result.
Example: success/failed
This api gives the information about the result of the app.
ATTRIBUTE DESCRIPTION
id
int
Description: This parameter is the id of provider
Example: 1
name
string
Description: This parameter is the Provider name.
Example: Allianz
description
string
Description: This parameter is the result message which contains information about the result.
Example: B
typeofagent
string
Description: This parameter is the typeofagent.
Example: 2
providerurl
string
Description: This parameter is the providerurl
Example: https://searchmyanzsco.com.au
providerid
int
Description: Provider id
Example: 1
isworking
string
Description: isworking or not.
Example: 1
covertypeid
string
Description: This parameter is the result covertype.
Example: 1
planid
int
Description: planid.
Example: 1
planname
string
Description: This parameter is the result message which contains information about the result.
Example: Budget Working Cover
price
string
Description: price.
Example: 70.20
broserurl
string
Description: broserurl.
Example: https://payment.ovhcallianzassistance.com.au/Content/files/PolicyDocuments/imp2594-ovhc-policy-workers.pdf
tagline
string
Description: This parameter is the result message which contains information about the result.
Example: ""
offer
string
Description: This parameter is the result message which contains information about the result.
Example: null
offertext
string
Description: This parameter is the result message which contains information about the result.
Example: null
logourl
string
Description: This parameter is the logo url.
Example: https://konpare.online/uploadedfiles/ovhc/allianz-logo.png
compareid
string
Description: This parameter is the result message which contains information about the result.
Example: 4
covertypename
string
Description: This parameter is the covertype.
Example: single
covertypenumber
string
Description: This parameter is the result message which contains information about the result.
Example: 1
outdata
string
Description: other data
Example: null
emaillink
string
Description: Name of Email link
Example: null
other
string
Description: other
Example: null
https://api.konpare.online/api/v1/tovhcauthprovider
Request
Copy to Clipboard
var http = require('follow-redirects').http; var fs = require('fs'); var options = {   'method': 'POST',   'hostname': 'https://api.konpare.online',   'path': '/api/v1/tovhcauthprovider',   'headers':{     'Content-Type' : 'application/json'   },   'maxRedirects':20 }; var req = http.request(options, function (res) { var chunks = [];   res.on("data", function (chunk) {     chunks.push(chunk); });   res.on("end", function (chunk) {   var body = Buffer.concat(chunks);   console.log(body.toString()); });   res.on("error", function (error) {   console.error(error);  }); }); var postData = ({   "covervalue":" "1"",,  "providerid":"''",  "startdate": "2021-01-22",  "skey": "secretkey pass" }); req.write(postData); req.end();
Copy to Clipboard
var client = "new RestClient("https://api.konpare.online/api/v1/tovhcauthprovider");"; client.Timeout = -1; var request = new RestRequest(Method.POST); request.AddHeader("Content-Type" : "application/json"); var body = @"{    " @" ""covervalue"":""1"",    " @" ""providerid"":"''",    " @" ""startdate"":""2021-01-22"",    " @" ""skey"":""secretkey pass"",    " @"}    " @"";
Copy to Clipboard
OkHttpClient client = new OkHttpClient().newBuilder().build(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{ \"covervalue\":\"1\", \"providerid\":\"''\", \"startdate\":\"2021-01-22\", \"skey\":\"Your secretkey pass\"  } "); Request request = new Request.Builder() .url("https://api.konpare.online/api/v1/tovhcauthprovider") .method("POST", body) .addHeader("Content-Type", "application/json") .build(); Response response = client.newCall(request).execute();
Copy to Clipboard
$curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL => 'https://api.konpare.online/api/v1/tovhcauthprovider', 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 =>'{ "covervalue":"1", "providerid":"''", "startdate":"2021-01-22" "skey":"Your secretkey pass" } ', CURLOPT_HTTPHEADER => array( 'Content-Type: application/json'   ), )); $response = curl_exec($curl); curl_close($curl); echo $response;
Copy to Clipboard
import requests import json url = "https://api.konpare.online/api/v1/tovhcauthprovider" payload = json.dumps({ "covervalue":"1", "providerid": "''", "startdate": "2021-01-22", "skey": "Your secretkey pass" }) headers = { 'Content-Type': 'application/json' } response = requests.request("POST", url, headers=headers, data=payload) print(response.text)
Copy to Clipboard
require "uri" require "json" require "net/http" url = URI("https://api.konpare.online/api/v1/tovhcauthprovider") http = Net::HTTP.new(url.host, url.port); request = Net::HTTP::Post.new(url) request["Content-Type"] = "application/json" request.body = JSON.dump({ "covervalue":"1", "providerid": "''", "startdate": "2021-01-22", "skey": "Your secretkey pass" }) response = http.request(request) puts response.read_body
Response
Copy to Clipboard
{ "flag": true, "message": "success", "data": [ {   "id":"1",   "name": "Allianz",   "description": "B",   "typeofagent": 2,   "providerurl": "https://searchmyanzsco.com.au",   "providerid": 1,   "isworking": 1,   "covertypeid":1,   "planid": 1,   "planname": "Budget Working Cover",   "price": 70.20,   "broserurl": "https://payment.ovhcallianzassistance.com.au/Content/files/PolicyDocuments/imp2594-ovhc-policy-workers.pdf",   "tagline": "",   "offer": null,   "offertext": null,   "logourl":"https://konpare.online/uploadedfiles/ovhc/allianz-logo.png",   "compareid": 4,   "covertypename"": "Single",   "covertypenumber": 1   ],   "outdata": null,   "emaillink": null,   "other": null  }

POSTSend OVHC Quotemail

This API is used to send the policy quote via email. The response will be received as per the parameters such as cover type, email id, start date, etc.

Api Name: https://api.konpare.online/api/v1/ovhcemailquote
API Content Type : JSON
Request
ATTRIBUTE DESCRIPTION
skey
string
mandatory
 Description: The secret key that you will receive from the portal.
Learn more.
Example: 2rdCu0f9EmxMEKxgDZzg2ZBkD531bdrBZFH04zSaT1Y=
fname
string
mandatory
Description: Please enter firstname
Example: abc
lname
string
mandatory
Description: Please enter lastname
Example: xyz
emailid
string
mandatory
Description: Please enter emailid
Example: mikecaj459@cyadp.com
phoneno
string
mandatory
Description: Please enter Phoneno
Example: 1234567890
covertype
string
mandatory
Description: The cover value should be numeric. Cover type values will be as follows: ‘1' for Single and '2’ for Couple
Example: 1
startdate
string
mandatory
Description: startdate param is used for the cover start date. The date has to be today’s or in the future and must be in the format DD-MMM-YYYY. If the correct format is not entered, the response will fail.
Example: 09-Nov-2021
This api gives the information about the result of the app.
ATTRIBUTE DESCRIPTION
providerName
string
mandatory
Description: Provider Name
Example: Ahm
Price
string
mandatory
Description: Plan Price.
Example: 70.20
providerlogo
string
mandatory
Description: Provider Logo Url .
Example: https://konpare.online/images/ahm-logo.png
Response
ATTRIBUTE DESCRIPTION
flag
boolean
Description: This parameter indicate the status of API call.
Example: true/false
message
string
Description: This parameter is the result message which contains information about the result.
Example: success/failed
data
string
Description: data
Example: 177
https://api.konpare.online/api/v1/ovhcemailquote
Request
Copy to Clipboard
var http = require('follow-redirects').http; var fs = require('fs'); var options = {   'method': 'POST',   'hostname': 'https://api.konpare.online',   'path': '/api/v1/ovhcemailquote',   'headers':{     'Content-Type' : 'application/json'   },   'maxRedirects':20 }; var req = http.request(options, function (res) { var chunks = [];   res.on("data", function (chunk) {     chunks.push(chunk); });   res.on("end", function (chunk) {   var body = Buffer.concat(chunks);   console.log(body.toString()); });   res.on("error", function (error) {   console.error(error);  }); }); var postData = ({   "skey":""secretkey pass"",  "fname":"abc",  "lname": "xyz",  "emailid": "mikecaj459@cyadp.com",  "phoneno": "1234567890",  "covertype": "single",  "startdate": "09-Nov-2021",  "providerdetails": {    "providerName": "Ahm",    "price": "70.20",    "providerlogo": "https://konpare.online/images/ahm-logo.png" } }); req.write(postData); req.end();
Copy to Clipboard
var client = "new RestClient("https://api.konpare.online/api/v1/ovhcemailquote");"; client.Timeout = -1; var request = new RestRequest(Method.POST); request.AddHeader("Content-Type" : "application/json"); var body = @"{    " @" "skey":""secretkey pass"",    " @" "fname":"abc",    " @" "lname": "xyz",    " @" "emailid": "mikecaj459@cyadp.com",    " @" "phoneno": "1234567890",    " @" "covertype": "single",    " @" "startdate": "09-Nov-2021",    " @" "providerdetails": {    " @" "providerName": "Ahm",    " @" "price": "70.20",    " @" "providerlogo": "https://konpare.online/images/ahm-logo.png"    " } @"}    " @"";
Copy to Clipboard
OkHttpClient client = new OkHttpClient().newBuilder().build(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{ \"skey\":\"Your secretkey pass\", \"fname\":\"abc\", \"lname\":\"xyz\", \"emailid\":\"abc@123gmail.com\", \"phoneno\":\"1234567890\", \"covertype\":\"single\", \"startdate\":\"09-Nov-2021\", \"providerdetails\":\"{\", \"providerName\":\Ahm"\", \"price\":\"70.20\", \"providerlogourl\":\"https://konpare.online/images/ahm-logo.png\"  } } "); Request request = new Request.Builder() .url("https://api.konpare.online/api/v1/ovhcemailquote") .method("POST", body) .addHeader("Content-Type", "application/json") .build(); Response response = client.newCall(request).execute();
Copy to Clipboard
$curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL => 'https://api.konpare.online/api/v1/ovhcemailquote', 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 =>'{ "skey":""secretkey pass"", "fname":"abc", "lname": "xyz", "emailid": "mikecaj459@cyadp.com", "phoneno": "1234567890", "covertype": "single", "startdate": "09-Nov-2021", "providerdetails": { "providerName": "Ahm", "price": "70.20", "providerlogo": "https://konpare.online/images/ahm-logo.png" } } ', CURLOPT_HTTPHEADER => array( 'Content-Type: application/json'   ), )); $response = curl_exec($curl); curl_close($curl); echo $response;
Copy to Clipboard
import requests import json url = "https://api.konpare.online/api/v1/ovhcemailquote" payload = json.dumps({ "skey":""secretkey pass"", "fname":"abc", "lname": "xyz", "emailid": "mikecaj459@cyadp.com", "phoneno": "1234567890", "covertype": "single", "startdate": "09-Nov-2021", "providerdetails": { "providerName": "Ahm", "price": "70.20", "providerlogo": "https://konpare.online/images/ahm-logo.png" } }) headers = { 'Content-Type': 'application/json' } response = requests.request("POST", url, headers=headers, data=payload) print(response.text)
Copy to Clipboard
require "uri" require "json" require "net/http" url = URI("https://api.konpare.online/api/v1/ovhcemailquote") http = Net::HTTP.new(url.host, url.port); request = Net::HTTP::Post.new(url) request["Content-Type"] = "application/json" request.body = JSON.dump({ "skey":""secretkey pass"", "fname":"abc", "lname": "xyz", "emailid": "mikecaj459@cyadp.com", "phoneno": "1234567890", "covertype": "single", "startdate": "09-Nov-2021", "providerdetails": { "providerName": "Ahm", "price": "70.20", "providerlogo": "https://konpare.online/images/ahm-logo.png" } }) response = http.request(request) puts response.read_body
Response
Copy to Clipboard
{ "flag": true, "message": "success", "data": "177" }

POST Set webhook

This API documentation will allow you to set a webhook.

API Content Type : JSON

Introduction

A webhook is an endpoint on your server that receives requests. Following this documentation will help you to set up and deploy a webhook. This setup guide will deploy a webhook to listen to events from KONPARE. You can use webhook to receive responses post any events. E.g., after the payment event receives responses such as payment success response params, payment failed params and policy certificate.

Setup an endpoint

The webhook will notify you about events that happen on your account. Follow the below steps to add a new endpoint to your server and make sure it’s publicly accessible so we can send authenticated POST requests.

Steps:-

1: Login into KONPARE Agent Portal
2: select Webhook under the Developer Menu
3: Click on +Add endpoint button
4: Enter your endpoint full url and select event type and click on Add endpoint button select
Response For upload policy
ATTRIBUTE DESCRIPTION
applicantinsuranceid
string
Description: Retunr apliicant last inserted id
Example: 2331
leadcode
string
Description: retunr applicant lead code
Example: LEAD00228
name
string
Description: Retunr name of applicant
Example: Dhruv Dineshbhai Patel
emailaddress
string
Description: Retunr applicantemail adress
Example: abc123@gmail.com
date
string
Description: return purchase date
Example: 06-Sep-2021 4:11 AM
policynumber
string
Description: retunr policy number
Example: P003413619
policystartdate
string
Description: retunr policy startdate
Example: 29-Sep-2021
policyenddate
string
Description: retunr policy endate
Example: 30-Aug-2023
reciptfile
string
Description: Retunr base 64 string
Example: message print
policyfile
string
Description: Retunr base 64 string
Example: message print
metadata
string
Description: retunr array of object
Example: "array1":"value1"
Response upload policy
Copy to Clipboard
{   "applicantinsuranceid": "Retunr apliicant last inserted id",   "leadcode": "retunr applicant lead code",   "name": "Retunr name of applicant",   "emailaddress": "Retunr applicantemail adress",   "date": "Return purchase date",   "policynumber": "retunr policy number",   "policystartdate": "retunr policy startdate",   "policyenddate": "retunr policy endate",   "reciptfile": "Retunr base 64 string",   "policyfile": "Retunr base 64 string", "metadata": {   "array1": "value1" }
Response For Payment success
ATTRIBUTE DESCRIPTION
skey
string
Description: The secret key that you will receive from the portal.
Learn more.
Example: XCwZVAAWsS6W1egbpegempmFofADONrP+IeMtwVX6aU=
aaplicantid
int
Description: Retunr apliicant id
Example: 2331
title
string
Description: Student title
Example: Mr.
leadcode
string
Description: return leadcode
Example: LEAD00224
leadfirstname
string
Description: Mention Student Fisrname
Example: Sampath Ranathunga Bandara
leadlastname
string
Description: Mention Student last name
Example: BINIKONARA MUDIYANSELAGE
gender
string
Description: Mention type of gender
Example: Male
dateofbirth
string
Description: Mention Date of Birth (Date formate DD/MM/YYYY)
Example: 23-Sep-1985
emailaddress
string
Description: Mention Student Email Address
Example: bmsrbandara01@gmail.com
phoneno
string
Description: Mention Student phone number
Example: 0452325065
companyid
int
Description: Return company id
Example: 58
ipaddress
string
Description: Ip address of the system
Example: 111.93.89.2
useridf
int
Description: return userid which is Purchase in crm
Example: 0
leadsource
string
Description: Mention lead source type
Example: Api
notes
string
Description: Mention Notes to easily identify inquiry
Example: Provider:Allianz, CoverType:Single, StartDate:29-09-2021, EndDate:30-08-2023
insuranceproviderid
int
Description: Insurance Product Id
Example: 1
insurancetype
string
Description: Mention Insurance type OSHC fix
Example: OSHC
covertype
string
Description: Mention Covert Type
Example: Single
insurancestartdate
string
Description: Mention Insurance Start date
Example: 29-Sep-2021
insuranceenddate
string
Description: Mention Insurance End date
Example: 30-Aug-2023
addressline1
string
Description: Mention Address line 1 if living austrlia
Example: Unit 2/ 16 Pennell Avenue
addressline2
string
Description: Mention Address line 2 if living austrlia
Example: ""
country
string
Description: Mention Country if living austrlia
Example:
city
string
Description: Mention City if living austrlia
Example: ST ALBANS
state
string
Description: Mention State if living austrlia
Example: VICTORIA
zipcode
string
Description: Mention Zip code if living austrlia
Example: 3021
passportnumber
string
Description: passport no
Example: N3490898
passportissuingcountry
string
Description: County Name
Example: SRI LANKA
university
string
Description: return university name
Example: OTHER - VIC
isliveinaustralia
boolean
Description: Mention check box true false living austrlia
Example: true
australianumber
string
Description: mention Austrlia number
Example: 0452325065
studentnumber
string
Description: Mention Student number
Example: ""
coestartdate
string
Description: Mention COE start date
Example: 06-Sep-2021
coeenddate
string
Description: Mention COE end date
Example: 30-Jun-2023
insuranceaudamount
string
Description: Mention Insurance AMount
Example: 1032.9
isbuyinsurance
boolean
Description: Mention if insurance buy giving true other wise false
Example: false
currentresidentcountry
string
Description: Mention current resident country
Example: Australia
singlename
boolen
Description: Mention true/false to take single name as a full name
Example: false
listsecondaryapplicant
string
Description: list of secondary applicant details
Example: []
metadata
int
Description: retunr array of object
Example: "array1":"value1"
SuccessUrl
string
Description: url
Example: https://yourdomain.com/yourpage-successpage
CancelUrl
string
Description: url
Example: https://yourdomain.com/yourpage-cancelpage
Response payment success
Copy to Clipboard
{​​​​​​​​   "skey": "Secrete key which is genrated by konpare crm.",   "aaplicantid": Retunr apliicant id,   "title": "Student title",   "leadcode": "return leadcode",   "leadfirstname": "Mention Student Fisrname",   "leadlastname": "Mention Student last name",   "gender": "Mention type of gender",   "dateofbirth": "Mention Date of Birth (Date formate DD/MM/YYYY)",   "emailaddress": "Mention Student Email Address",   "phoneno": "Mention Student phone number",   "companyid": "Return company id",   "ipaddress": "Return ipaddress",   "useridf": return userid which is Purchase in crm,   "leadsource": "Mention lead source type",   "notes": "Mention Notes to easily identify inquiry",   "insuranceproviderid": Insurance Product Id,   "insurancetype": "Mention Insurance type OSHC fix",   "covertype": "Mention Covert Type",   "insurancestartdate": "Mention Insurance Start date",   "insuranceenddate": "Mention Insurance End date",   "addressline1": "Mention Address line 1 if living austrlia",   "addressline2": "Mention Address line 2 if living austrlia",   "country": "Mention Country if living austrlia",   "city": "Mention City if living austrlia",   "state": "Mention State if living austrlia",   "zipcode": "Mention Zip code if living austrlia",   "passportnumber": "passport no",   "passportissuingcountry": "County Name",   "university": "return university name",   "isliveinaustralia": Mention check box true false living austrlia,   "australianumber": "mention Austrlia number",   "studentnumber": "Mention Student number",   "coestartdate": "Mention COE start date",   "coeenddate": "Mention COE end date",   "insuranceaudamount": "Mention Insurance AMount",   "isbuyinsurance": Mention true/false,   "currentresidentcountry": "Mention current resident country",   "singlename": Mention true/false to take single name as a full name,   "listsecondaryapplicant": [], "metadata": {​​​​​​​​   "array1": "value1" }​​​​​​​​,   "SuccessUrl": "https://yourdomain.com/yourpage-successpage",   "CancelUrl": "https://yourdomain.com/yourpage-cancelpage" }​​​​​​​​
Response For payment fail
ATTRIBUTE DESCRIPTION
flag
boolean
Description: true
Example: true/false
message
string
Description: Policy Webhook
Example: message print
data
string
Description: 130
Example: https://checkout.stripe.com/pay/cs_test_a1nRWFEoL8IG05XlquP5iYC8MLDG77g4wcWny6qXwSfsOLpPUTaSq3fim5#fidkdWxOYHwnPyd1blpxYHZxWmpSZDRqYGhRYTcxc25scUZ3QEJfUGRoaTU1bmtgUUxDdHwnKSdobGF2Jz9%2BJ2JwbGEnPydLRCcpJ2hwbGEnPyc9NzU3ZjM0PCgyZzZkKDE8Z2coZDJjYShnMjcxYTxhNTMxM2A0MWA2ZmAnKSd2bGEnPyc2ZzY1Z2A8PCg9NDJmKDExYTEoPGY0YCg3MDU0NWQ9NWFgYzY8Nzw0PDEneCknZ2BxZHYnP15YKSdpZHxqcHFRfHVgJz8ndmxrYmlgWmxxYGgnKSdga2RnaWBVaWRmYG1qaWFgd3YnP3F3cGApJ3dgY2B3d2B3SndsYmxrJz8nbXFxdT8qKm1wdmBgYGArYWBoaituamt1ZHdgK2praWxrYCd4JSUl
outdata
string
Description: blank
Example: message print
emaillink
string
Description: null
Example: message print
other
string
Description: null
Example: message print
Response payment fail
Copy to Clipboard
const https = require('https'); var authParam = {}; authParam.body = {   'client_id' :'YOUR CLIENT ID'   'authorization_id' : 'YOUR AUTHORIZATION ID' } var postData = JSON.stringyfy(authParam); var options = {   hostname: console.konsign.com,   port: 443,   path: '/api/oauth/auth'   method: 'POST',   headers:{     'Content-Type' : 'application/json'     'Content-Length' : postData.length   } } var response = ""; var post_req = https.request(options, function(post_res) {   post_res.on('data', function (chunk) {     response += chunk;   });   post_res.on('end', function(){     console.log('Response: ', response);   }); }); post_req.write(post_data); post_req.end();
Response Codes and Messages
Status Code Status Description
200
true
 Success
401
false
 Your Session has expired
409
false
 Conflict has occured
422
false
 Invalid parameter
500
false
 System error