NAV Navigation
Curl Python

Zopper API Suite v3.1.5

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Welcome to the new Era Of Insurance

Base URLs:

Terms of service Email: Support License: Zopper API

Authentication

Listing

Manufacturer List

Code samples

# You can also use wget
curl -X GET https://cms-dev.theblackswan.in/dropdown/manufacturer?type=string \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'
import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('https://cms-dev.theblackswan.in/dropdown/manufacturer', params={
  'type': 'string'
}, headers = headers)

print(r.json())

GET /dropdown/manufacturer

This is a Manufacturer Listing API
For Two Wheeler: type(value)=2
For Four Wheeler: type(value)=4
For GCV Wheeler: type(value)=5

Parameters

Name In Type Required Description
type query string true Pass key from API description

Example responses

200 Response

{
    "status": 0,
    "message": "string",
    "data": [
        {
            "code": 0,
            "name": "string"
        }
    ]
}

Responses

Status Meaning Description Schema
200 OK Returns a list of Manufacturers with code Inline
400 Bad Request Returns Error Response Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
» status integer false none 200
» message string false none Success
» data [object] false none none
»» code integer false none none
»» name string false none none

Status Code 400

Name Type Required Restrictions Description
» status integer false none 200
» message string false none Some thing went wrong
» data object false none none

Model List

Code samples

# You can also use wget
curl -X GET https://cms-dev.theblackswan.in/dropdown/model?manufacturer=string \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'
import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('https://cms-dev.theblackswan.in/dropdown/model', params={
  'manufacturer': 'string'
}, headers = headers)

print(r.json())

GET /dropdown/model

This is a Model Listing API
Eg. manufacturer: 8439
manufacturer=<manufacturer_code from /dropdown/manufacturer API>

Parameters

Name In Type Required Description
manufacturer query string true Pass value from Manufacturer API

Example responses

200 Response

{
    "status": 0,
    "message": "string",
    "data": [
        {
            "code": 0,
            "name": "string"
        }
    ]
}

Responses

Status Meaning Description Schema
200 OK Returns a list of Models with code Inline
400 Bad Request Returns Error Response Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
» status integer false none 200
» message string false none Success
» data [object] false none none
»» code integer false none none
»» name string false none none

Status Code 400

Name Type Required Restrictions Description
» status integer false none 200
» message string false none Some thing went wrong
» data object false none none

Varient List

Code samples

# You can also use wget
curl -X GET https://cms-dev.theblackswan.in/dropdown/variant?model=string \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'
import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('https://cms-dev.theblackswan.in/dropdown/variant', params={
  'model': 'string'
}, headers = headers)

print(r.json())

GET /dropdown/variant

This is a Varient Listing API
Eg. model=24636
model=<model from /dropdown/model API>

Parameters

Name In Type Required Description
model query string true Pass value from Model API

Example responses

200 Response

{
    "status": 0,
    "message": "string",
    "data": [
        {
            "code": 0,
            "name": "string"
        }
    ]
}

Responses

Status Meaning Description Schema
200 OK Returns a list of Variants with code Inline
400 Bad Request Returns Error Response Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
» status integer false none 200
» message string false none Success
» data [object] false none none
»» code integer false none none
»» name string false none none

Status Code 400

Name Type Required Restrictions Description
» status integer false none 200
» message string false none Some thing went wrong
» data object false none none

Insurer List

Code samples

# You can also use wget
curl -X GET https://cms-dev.theblackswan.in/insurer/listing?insurer_type=string \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'
import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('https://cms-dev.theblackswan.in/insurer/listing', params={
  'insurer_type': 'string'
}, headers = headers)

print(r.json())

GET /insurer/listing

This API is to list of available as a previous Insurer
For Motor Insurers:- insurer_type=motor
For Health Insurers:- insurer_type=health
For Life Insurers:- insurer_type=life

Parameters

Name In Type Required Description
insurer_type query string true motor

Example responses

200 Response

{
    "status": 0,
    "message": "string",
    "data": [
        {
            "code": 0,
            "name": "string"
        }
    ]
}

Responses

Status Meaning Description Schema
200 OK Returns a list of Insurers with code Inline
400 Bad Request Returns Error Response Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
» status integer false none 200
» message string false none Success
» data [object] false none none
»» code integer false none none
»» name string false none none

Status Code 400

Name Type Required Restrictions Description
» status integer false none 200
» message string false none Some thing went wrong
» data object false none none

Pincode List

Code samples

# You can also use wget
curl -X GET https://cms-dev.theblackswan.in/dropdown/pincode?pincode=string \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'
import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('https://cms-dev.theblackswan.in/dropdown/pincode', params={
  'pincode': 'string'
}, headers = headers)

print(r.json())

GET /dropdown/pincode

This is a Pincode Listing API
Eg. pincode=133
Accepts minimum 3 digits

Parameters

Name In Type Required Description
pincode query string true 133

Example responses

200 Response

{
    "status": 0,
    "message": "string",
    "data": [
        {
            "area": 0,
            "area_name": "string",
            "pincode": 0,
            "city": 0,
            "state": "string",
            "city_name": "string",
            "state_name": "string"
        }
    ]
}

Responses

Status Meaning Description Schema
200 OK Returns a list of pincodes with other details Inline
400 Bad Request Returns Error Response Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
» status integer false none 200
» message string false none none
» data [object] false none none
»» area integer false none none
»» area_name string false none none
»» pincode integer false none none
»» city integer false none none
»» state string false none none
»» city_name string false none none
»» state_name string false none none

Status Code 400

Name Type Required Restrictions Description
» status integer false none 200
» message string false none Some thing went wrong
» data object false none none

Motor

Motor Quotation Collection API

Code samples

# You can also use wget
curl -X GET https://cms-dev.theblackswan.in/policy/quotation/v2 \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'
import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('https://cms-dev.theblackswan.in/policy/quotation/v2', headers = headers)

print(r.json())

GET /policy/quotation/v2

This request responds the with insurers quotations response. This is a pooling API. You can hit after every 4-5 seconds to fetch quotations responses

Example responses

200 Response

{
    "status": 0,
    "message": "string",
    "data": {
        "max_idv": 0,
        "min_idv": 0,
        "retryable": true,
        "request_id": "string",
        "sub_request_id": "string",
        "result": [null]
    }
}

Responses

Status Meaning Description Schema
200 OK none Inline
400 Bad Request Returns Error Response None

Response Schema

Status Code 200

Name Type Required Restrictions Description
» status integer false none 200
» message string false none Some thing went wrong
» data object false none none
»» max_idv integer false none none
»» min_idv integer false none none
»» retryable boolean false none none
»» request_id string false none none
»» sub_request_id string false none none
»» result [any] false none none

Motor Quotation Pool Initiation API

Code samples

# You can also use wget
curl -X POST https://cms-dev.theblackswan.in/policy/quotation/v2 \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://cms-dev.theblackswan.in/policy/quotation/v2', headers = headers)

print(r.json())

POST /policy/quotation/v2

Body parameter

{
    "request_id": "string",
    "make": "string",
    "model": "string",
    "variant": "string",
    "product_type": "string",
    "loan": 0,
    "is_vehicle_new": 0,
    "registration_date": "string",
    "idv": 0,
    "trailer_idv": 0,
    "policy_type": "string",
    "previous_policy_end_date": "string",
    "previous_policy_type": "string",
    "previous_policy_claim": "string",
    "previous_insurer": "string",
    "rto": "string",
    "ncb": "string",
    "manufacturing_year": "string",
    "category": 0,
    "add_ons": ["string"],
    "owner_type": "string",
    "additional_cover": {
        "ea": 0,
        "nea": 0,
        "Fuel_od": 0,
        "LLPD": 0,
        "pod": 0,
        "upa": 0
    },
    "fuel_type": "string"
}

Parameters

Name In Type Required Description
body body object true none
» request_id body string false none
» make body string false none
» model body string false none
» variant body string false none
» product_type body string false none
» loan body integer false none
» is_vehicle_new body integer false none
» registration_date body string false none
» idv body integer false none
» trailer_idv body integer false none
» policy_type body string false none
» previous_policy_end_date body string false none
» previous_policy_type body string false none
» previous_policy_claim body string false none
» previous_insurer body string false none
» rto body string false none
» ncb body string false none
» manufacturing_year body string false none
» category body integer false none
» add_ons body [string] false none
» owner_type body string false none
» additional_cover body object false none
»» ea body integer false none
»» nea body integer false none
»» Fuel_od body integer false none
»» LLPD body integer false none
»» pod body integer false none
»» upa body integer false none
» fuel_type body string false none

Example responses

201 Response

{
    "status": 0,
    "message": "string",
    "data": {
        "request_id": "string",
        "sub_request_id": "string",
        "count": 0,
        "retryable": true
    }
}

Responses

Status Meaning Description Schema
201 Created none Inline
tags Unknown none None

Response Schema

Status Code 201

Name Type Required Restrictions Description
» status integer false none 200
» message string false none none
» data object false none none
»» request_id string false none none
»» sub_request_id string false none none
»» count integer false none none
»» retryable boolean false none none

Motor Proposal Generation API

Code samples

# You can also use wget
curl -X POST https://cms-dev.theblackswan.in/policy/proposal \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://cms-dev.theblackswan.in/policy/proposal', headers = headers)

print(r.json())

POST /policy/proposal

Body parameter

{
    "unique_identifier": "string",
    "idv": {
        "nominee": "string",
        "relationship": "string",
        "nominee_age": 0,
        "nominee_last_name": "string",
        "nominee_dob": "string"
    },
    "common": true,
    "customer": true,
    "vehicle": true,
    "prev_policy": true
}

Parameters

Name In Type Required Description
body body object true none
» unique_identifier body string false none
» idv body object false none
»» nominee body string false none
»» relationship body string false none
»» nominee_age body integer false none
»» nominee_last_name body string false none
»» nominee_dob body string false none
» common body boolean false none
»» insurance_type body string false none
»» insurance_code body string false none
»» insurer_name body string false none
» customer body boolean false none
»» salutation body string false none
»» email body string false none
»» gender body string false none
»» marital_status body string false none
»» phone body string false none
»» landmark body string false none
»» address body string false none
»» address1 body string false none
»» state body string false none
»» city body string false none
»» pincode body string false none
»» area_code body string false none
»» dob body string false none
»» type body string false none
»» firstname body string false none
»» lastname body string false none
»» occupation body string false none
» vehicle body boolean false none
»» class body string false none
»» loan body string false none
»» is_vehicle_new body integer false none
»» rto body string false none
»» registration_date body string false none
»» registration_no body string false none
»» manufacturing_date body string false none
»» manufacturer_make body string false none
»» manufacturer_model body string false none
»» manufacturer_variant body string false none
»» chassis_number body string false none
»» engine_number body string false none
»» purchase_date body string false none
» prev_policy body boolean false none
»» claims body string false none
»» insurer_name body string false none
»» policy_no body string false none
»» end_date body string false none

Example responses

201 Response

{
    "status": 0,
    "message": "string",
    "data": {
        "registration_number": "string",
        "customer_phone": "string",
        "taxes": 0,
        "premium": 0,
        "premium_total": 0,
        "product": "string",
        "proposalno": "string",
        "quotationno": "string",
        "errcode": "string"
    }
}

Responses

Status Meaning Description Schema
201 Created none Inline
400 Bad Request Returns Error Response Inline

Response Schema

Status Code 201

Name Type Required Restrictions Description
» status integer false none 200
» message string false none none
» data object false none none
»» registration_number string false none none
»» customer_phone string false none none
»» taxes integer false none none
»» premium integer false none none
»» premium_total integer false none none
»» product string false none none
»» proposalno string false none none
»» quotationno string false none none
»» errcode string false none none

Status Code 400

Name Type Required Restrictions Description
» status integer false none 200
» message string false none Some thing went wrong
» data object false none none

Health

Quick Quote with Minimum Premiums

Code samples

# You can also use wget
curl -X POST https://cms-dev.theblackswan.in/health/offline-quotation \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://cms-dev.theblackswan.in/health/offline-quotation', headers = headers)

print(r.json())

POST /health/offline-quotation

This API responds with minimum premium for every Health Insurer.

Body parameter

{
    "include_proposer": true,
    "plan_type": "INDIVIDUAL",
    "adults": 0,
    "kids": 0,
    "duration_years": 1,
    "members": [
        {
            "type": "adult",
            "member_type": "proposer",
            "sum_insured": 0,
            "dob": null,
            "pincode": 0,
            "city_name": "string",
            "state_name": "string",
            "gender": "M",
            "proposer": true,
            "nationality": "INDIAN"
        }
    ]
}

Parameters

Name In Type Required Description
body body object true none
» include_proposer body boolean false True, If Proposer is a member in policy
» plan_type body string false Type of Policy
» adults body integer false Number of Adult Members
» kids body integer false Number of Kids in Policy
» duration_years body integer false Duration of Policy
» members body [object] false none
»» type body string false Classify this member as a child(dependent 25 years) or adult
»» member_type body string false Relation to policy proposer
»» sum_insured body integer false none
»» dob body date false Date of birth of member(format: “DD/MM/YYYY”)
»» pincode body integer false Pincode available in PINCODE Listing API
»» city_name body string false city_name correspond to available PINCODE’s
»» state_name body string false state_name correspond to available PINCODE’s
»» gender body string false Classify Member as a Male or Female
»» proposer body boolean false none
»» nationality body string false Nationalitiy of Member

Enumerated Values

Parameter Value
» plan_type INDIVIDUAL
» plan_type Family Floater
» duration_years 1
» duration_years 2
» duration_years 3
»» type adult
»» type kids
»» member_type proposer
»» member_type daughter
»» member_type father
»» member_type mother
»» member_type son
»» member_type spouse
»» gender M
»» gender F
»» nationality INDIAN
»» nationality

Example responses

200 Response

{
    "status": 0,
    "message": "string",
    "data": [
        {
            "unique_identifier": "string",
            "policy_highlights": "string",
            "sum_insured": 0,
            "premium": {
                "add_on": null,
                "gst": null,
                "basic": null
            },
            "insurer_code": "string",
            "insurance_name": "string",
            "brochure_url": "string",
            "insurer_logo": "string",
            "premium_total": 0,
            "insurer_id": 0,
            "cover_discount": {
                "any_room": 0,
                "super_ncb": 0,
                "unlimited_reload": 0
            }
        }
    ]
}

Responses

Status Meaning Description Schema
200 OK Returns a list of Quotation minimum Inline
400 Bad Request Returns Error Response Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
» status integer false none 200
» message string false none none
» data [object] false none none
»» unique_identifier string false none none
»» policy_highlights string false none Highlights HTML
»» sum_insured integer false none none
»» premium object false none none
»»» add_on float false none none
»»» gst float false none none
»»» basic float false none none
»» insurer_code string false none none
»» insurance_name string false none none
»» brochure_url string false none none
»» insurer_logo string false none none
»» premium_total integer false none none
»» insurer_id integer false none none
»» cover_discount object false none none
»»» any_room integer false none none
»»» super_ncb integer false none none
»»» unlimited_reload integer false none none

Status Code 400

Name Type Required Restrictions Description
» status integer false none 200
» message string false none Some thing went wrong
» data object false none Empty object or may contain some information about issue

Full Quote

Code samples

# You can also use wget
curl -X POST https://cms-dev.theblackswan.in/health/offline-quotation/{var} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://cms-dev.theblackswan.in/health/offline-quotation/{var}', headers = headers)

print(r.json())

POST /health/offline-quotation/{var}

Body parameter

{
    "include_proposer": true,
    "plan_type": "INDIVIDUAL",
    "adults": 0,
    "kids": 0,
    "duration_years": 1,
    "members": [
        {
            "type": "adult",
            "member_type": "proposer",
            "sum_insured": 0,
            "dob": null,
            "pincode": 0,
            "city_name": "string",
            "state_name": "string",
            "gender": "M",
            "proposer": true,
            "nationality": "INDIAN"
        }
    ]
}

Parameters

Name In Type Required Description
insurer_code path string true none
body body object true none
» include_proposer body boolean false True, If Proposer is a member in policy
» plan_type body string false Type of Policy
» adults body integer false Number of Adult Members
» kids body integer false Number of Kids in Policy
» duration_years body integer false Duration of Policy
» members body [object] false none
»» type body string false Classify this member as a child(dependent 25 years) or adult
»» member_type body string false Relation to policy proposer
»» sum_insured body integer false none
»» dob body date false Date of birth of member(format: “DD/MM/YYYY”)
»» pincode body integer false Pincode available in PINCODE Listing API
»» city_name body string false city_name correspond to available PINCODE’s
»» state_name body string false state_name correspond to available PINCODE’s
»» gender body string false Classify Member as a Male or Female
»» proposer body boolean false none
»» nationality body string false Nationalitiy of Member
var path string true none

Enumerated Values

Parameter Value
» plan_type INDIVIDUAL
» plan_type Family Floater
» duration_years 1
» duration_years 2
» duration_years 3
»» type adult
»» type kids
»» member_type proposer
»» member_type daughter
»» member_type father
»» member_type mother
»» member_type son
»» member_type spouse
»» gender M
»» gender F
»» nationality INDIAN
»» nationality

Example responses

200 Response

{
    "status": 0,
    "message": "string",
    "data": {
        "1": [
            {
                "unique_identifier": "string",
                "policy_highlights": "string",
                "sum_insured": 0,
                "premium": {
                    "add_on": null,
                    "gst": null,
                    "basic": null
                },
                "insurer_code": "string",
                "insurance_name": "string",
                "brochure_url": "string",
                "insurer_logo": "string",
                "premium_total": 0,
                "insurer_id": 0,
                "cover_discount": {
                    "any_room": 0,
                    "super_ncb": 0,
                    "unlimited_reload": 0
                }
            }
        ],
        "2": [
            {
                "unique_identifier": "string",
                "policy_highlights": "string",
                "sum_insured": 0,
                "premium": {
                    "add_on": null,
                    "gst": null,
                    "basic": null
                },
                "insurer_code": "string",
                "insurance_name": "string",
                "brochure_url": "string",
                "insurer_logo": "string",
                "premium_total": 0,
                "insurer_id": 0,
                "cover_discount": {
                    "any_room": 0,
                    "super_ncb": 0,
                    "unlimited_reload": 0
                }
            }
        ],
        "3": [
            {
                "unique_identifier": "string",
                "policy_highlights": "string",
                "sum_insured": 0,
                "premium": {
                    "add_on": null,
                    "gst": null,
                    "basic": null
                },
                "insurer_code": "string",
                "insurance_name": "string",
                "brochure_url": "string",
                "insurer_logo": "string",
                "premium_total": 0,
                "insurer_id": 0,
                "cover_discount": {
                    "any_room": 0,
                    "super_ncb": 0,
                    "unlimited_reload": 0
                }
            }
        ]
    }
}

Responses

Status Meaning Description Schema
200 OK Returns a list of all Quotation for specific insurer Inline
400 Bad Request Returns Error Response Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
» status integer false none 200
» message string false none none
» data object false none none
»» 1 [object] false none All possible combination for 1 Year policy
»»» unique_identifier string false none none
»»» policy_highlights string false none Highlights HTML
»»» sum_insured integer false none none
»»» premium object false none none
»»»» add_on float false none none
»»»» gst float false none none
»»»» basic float false none none
»»» insurer_code string false none none
»»» insurance_name string false none none
»»» brochure_url string false none none
»»» insurer_logo string false none none
»»» premium_total integer false none none
»»» insurer_id integer false none none
»»» cover_discount object false none none
»»»» any_room integer false none none
»»»» super_ncb integer false none none
»»»» unlimited_reload integer false none none
»» 2 [object] false none All possible combination for 2 Years policy
»»» unique_identifier string false none none
»»» policy_highlights string false none Highlights HTML
»»» sum_insured integer false none none
»»» premium object false none none
»»»» add_on float false none none
»»»» gst float false none none
»»»» basic float false none none
»»» insurer_code string false none none
»»» insurance_name string false none none
»»» brochure_url string false none none
»»» insurer_logo string false none none
»»» premium_total integer false none none
»»» insurer_id integer false none none
»»» cover_discount object false none none
»»»» any_room integer false none none
»»»» super_ncb integer false none none
»»»» unlimited_reload integer false none none
»» 3 [object] false none All possible combination for 3 Years policy
»»» unique_identifier string false none none
»»» policy_highlights string false none Highlights HTML
»»» sum_insured integer false none none
»»» premium object false none none
»»»» add_on float false none none
»»»» gst float false none none
»»»» basic float false none none
»»» insurer_code string false none none
»»» insurance_name string false none none
»»» brochure_url string false none none
»»» insurer_logo string false none none
»»» premium_total integer false none none
»»» insurer_id integer false none none
»»» cover_discount object false none none
»»»» any_room integer false none none
»»»» super_ncb integer false none none
»»»» unlimited_reload integer false none none

Status Code 400

Name Type Required Restrictions Description
» status integer false none 200
» message string false none Some thing went wrong
» data object false none none

Proposal _ Final Quotation Generation API

Code samples

# You can also use wget
curl -X POST https://cms-dev.theblackswan.in/health/online-quotation \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://cms-dev.theblackswan.in/health/online-quotation', headers = headers)

print(r.json())

POST /health/online-quotation

Health Proposal

Body parameter

{
    "firstname": "string",
    "middlename": "string",
    "lastname": "string",
    "height_feet": 0,
    "height_inch": 0,
    "height": 0,
    "weight": 0,
    "marital_status": "single",
    "salutation": "string",
    "mobile": "string",
    "email": "string",
    "landmark": "string",
    "occupation": "string",
    "address_1": "string",
    "address_2": "string",
    "cover_discount": {
        "any_room": 0,
        "super_ncb": 0,
        "unlimited_reload": 0
    },
    "address": "string",
    "members": {
        "firstname": "string",
        "middlename": "string",
        "lastname": "string",
        "dob": "string",
        "height_feet": 0,
        "height_inch": 0,
        "height": 0,
        "weight": 0,
        "marital_status": "string",
        "salutation": "string",
        "mobile": "string",
        "email": "string",
        "landmark": "string",
        "occupation": "string",
        "address_1": "string",
        "address_2": "string",
        "type": "string",
        "member_type": "string"
    }
}

Parameters

Name In Type Required Description
body body object true none
» firstname body string false Occupation of person
» middlename body string false Middle name of person
» lastname body string false Last name of person
» height_feet body integer false Number of feet in person height
» height_inch body integer false Number of inches after feets
» height body integer false Height of person in centimeter
» weight body integer false Height of person in kilogram
» marital_status body string false Marital sttaus like singal maried
» salutation body string false Mr/Mrs/…etc
» mobile body string false 10 digit phone number
» email body string false Email id
» landmark body string false Landmark near your address
» occupation body string false Occupation of person
» address_1 body string false Address details line 1
» address_2 body string false Address details line 2
» cover_discount body object false none
»» any_room body integer false none
»» super_ncb body integer false none
»» unlimited_reload body integer false none
» address body string false Address details
» members body object false none
»» firstname body string false First name of Person details
»» middlename body string false Middle name of Person details
»» lastname body string false Lat name of Person details
»» dob body string false Date in format like 17/09/2003
»» height_feet body integer false Number of feet in person height
»» height_inch body integer false Number of inches after feets
»» height body integer false Height of person in centimeter
»» weight body integer false Height of person in kilogram
»» marital_status body string false Marital sttaus like singal maried
»» salutation body string false Mr/Mrs/…etc
»» mobile body string false 10 ndigit phone number
»» email body string false Email id
»» landmark body string false Landmark near your address
»» occupation body string false Occupation of person
»» address_1 body string false Address details line 1
»» address_2 body string false Address details line 2
»» type body string false Type of person, like adult/child
»» member_type body string false Type of member is he proposer, or relation to proposer

Enumerated Values

Parameter Value
» marital_status single
» marital_status married

Example responses

400 Response

{
    "status": 0,
    "message": "string",
    "data": {}
}

Responses

Status Meaning Description Schema
201 Created none None
400 Bad Request Returns Error Response Inline

Response Schema

Status Code 400

Name Type Required Restrictions Description
» status integer false none 200
» message string false none Some thing went wrong
» data object false none none

Life

Life Insurance Quotation API

Code samples

# You can also use wget
curl -X POST https://cms-dev.theblackswan.in/life/quotation \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://cms-dev.theblackswan.in/life/quotation', headers = headers)

print(r.json())

POST /life/quotation

Fetches Quotation from all the Life Insurers.

Body parameter

{
    "user": {
        "dob": null,
        "first_name": "string",
        "last_name": "string",
        "email": "string",
        "phone": "string",
        "employment": "sal",
        "gender": "M",
        "pincode": 0,
        "occupation": 0,
        "education": "BHS",
        "pancard": "string",
        "annual_income": 0,
        "marital_status": "single"
    },
    "auto_debit": "Y",
    "sum_insured": 0,
    "frequency": "monthly",
    "policy_term": 0,
    "payout_option": "lumpsum",
    "state": "string",
    "tobaco_user": "Y",
    "rider_flag": "Y",
    "members": [
        {
            "type": "adult",
            "member_type": "proposer",
            "sum_insured": 0,
            "dob": null,
            "pincode": 0,
            "city_name": "string",
            "state_name": "string",
            "gender": "M",
            "proposer": true,
            "nationality": "INDIAN"
        }
    ],
    "rider": null,
    "spouse_detail": {
        "income": "string",
        "total_life_cover": "string"
    }
}

Parameters

Name In Type Required Description
body body object true none
» user body object false none
»» dob body date false FORMAT: (DD/MM/YYYY)
»» first_name body string false First Name of Customer
»» last_name body string false First Name of Customer
»» email body string false Customer Email
»» phone body string false Customer Phone
»» employment body string false Corresponding code to Salried, Not Salaried and Not Employed
»» gender body string false pass ‘Y’, If the User consumes Tobbacco else ‘N’
»» pincode body integer false Pincode of Customer Address
»» occupation body integer false Occupation id from Occupation Listing
»» education body string false Education Level corresponding from Enum
»» pancard body string false Valid PANCARD of customer
»» annual_income body integer false Income of the Customer
»» marital_status body string false Education Level corresponding from Enum
» auto_debit body string false Pass ‘Y’ if user opt for Standing Instructions.
» sum_insured body integer false Value of Cover Amount, user looking for
» frequency body string false Frequency of the Premium user opting for
» policy_term body integer false Coverage years
» payout_option body string false Lumpsum Option user wants to opt for.
» state body string false state_name from PINCODE listing API
» tobaco_user body string false pass ‘Y’, If the User consumes Tobbacco else ‘N’
» rider_flag body string false pass ‘Y’, If the User Opted any Rider else ‘N’
» members body [object] false none
»» type body string false Classify this member as a child(dependent 25 years) or adult
»» member_type body string false Relation to policy proposer
»» sum_insured body integer false none
»» dob body date false Date of birth of member(format: “DD/MM/YYYY”)
»» pincode body integer false Pincode available in PINCODE Listing API
»» city_name body string false city_name correspond to available PINCODE’s
»» state_name body string false state_name correspond to available PINCODE’s
»» gender body string false Classify Member as a Male or Female
»» proposer body boolean false none
»» nationality body string false Nationalitiy of Member
» rider body any false none
» spouse_detail body object false none
»» income body string false If occupation is Housewife then Spouse Income
»» total_life_cover body string false If occupation is Housewife then Spouse’s Total Life Insurance Cover

Enumerated Values

Parameter Value
»» employment sal
»» employment nosal
»» employment nowork
»» gender M
»» gender F
»» gender TG
»» education BHS
»» education HS
»» education BD
»» education PG
»» marital_status single
»» marital_status married
» auto_debit Y
» auto_debit N
» frequency monthly
» frequency single
» frequency annually
» payout_option lumpsum
» tobaco_user Y
» tobaco_user N
» rider_flag Y
» rider_flag N
»» type adult
»» type kids
»» member_type proposer
»» member_type daughter
»» member_type father
»» member_type mother
»» member_type son
»» member_type spouse
»» gender M
»» gender F
»» nationality INDIAN
»» nationality

Example responses

200 Response

{
    "status": 0,
    "message": "string",
    "data": [
        {
            "unique_identifier": "string",
            "policy_highlights": "string",
            "premium": {
                "add_on": null,
                "gst": null,
                "basic": null
            },
            "insurer_code": "string",
            "insurance_name": "string",
            "insurer_logo": "string",
            "premium_total": 0,
            "payment_url": "string"
        }
    ]
}

Responses

Status Meaning Description Schema
200 OK Returns a list of Quotation minimum Inline
400 Bad Request Returns Error Response Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
» status integer false none 200
» message string false none none
» data [object] false none none
»» unique_identifier string false none none
»» policy_highlights string false none Highlights HTML
»» premium object false none none
»»» add_on float false none none
»»» gst float false none none
»»» basic float false none none
»» insurer_code string false none none
»» insurance_name string false none none
»» insurer_logo string false none none
»» premium_total integer false none none
»» payment_url string false none If insurer provide payment URL, Then go for Payment else you have call “/life/quotation/redirect” for payment link generation

Status Code 400

Name Type Required Restrictions Description
» status integer false none 200
» message string false none Some thing went wrong
» data object false none none

life_quotation_redirect_for_quotation

Code samples

# You can also use wget
curl -X POST https://cms-dev.theblackswan.in/life/quotation/redirect \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://cms-dev.theblackswan.in/life/quotation/redirect', headers = headers)

print(r.json())

POST /life/quotation/redirect

Body parameter

{
    "user": {
        "dob": null,
        "first_name": "string",
        "last_name": "string",
        "email": "string",
        "phone": "string",
        "employment": "sal",
        "gender": "M",
        "pincode": 0,
        "occupation": 0,
        "education": "BHS",
        "pancard": "string",
        "annual_income": 0,
        "marital_status": "single"
    },
    "address1": "string",
    "address2": "string",
    "politically_exposed": true,
    "occupation": "string",
    "nature_of_work": "string",
    "nominee_name": "string",
    "nominee_dob": null,
    "relationship": "string",
    "insurer_code": "string",
    "insurance_name": "string",
    "unique_id": "string",
    "auto_debit": "Y",
    "sum_insured": 0,
    "frequency": "monthly",
    "policy_term": 0,
    "payout_option": "lumpsum",
    "state": "string",
    "tobaco_user": "Y",
    "rider_flag": "Y",
    "members": [
        {
            "type": "adult",
            "member_type": "proposer",
            "sum_insured": 0,
            "dob": null,
            "pincode": 0,
            "city_name": "string",
            "state_name": "string",
            "gender": "M",
            "proposer": true,
            "nationality": "INDIAN"
        }
    ],
    "rider": null,
    "spouse_detail": {
        "income": "string",
        "total_life_cover": "string"
    }
}

Parameters

Name In Type Required Description
body body object true none
» user body object false none
»» dob body date false FORMAT: (DD/MM/YYYY)
»» first_name body string false First Name of Customer
»» last_name body string false First Name of Customer
»» email body string false Customer Email
»» phone body string false Customer Phone
»» employment body string false Corresponding code to Salried, Not Salaried and Not Employed
»» gender body string false pass ‘Y’, If the User consumes Tobbacco else ‘N’
»» pincode body integer false Pincode of Customer Address
»» occupation body integer false Occupation id from Occupation Listing
»» education body string false Education Level corresponding from Enum
»» pancard body string false Valid PANCARD of customer
»» annual_income body integer false Income of the Customer
»» marital_status body string false Education Level corresponding from Enum
» address1 body string false Address Line 1
» address2 body string false Address Line 2
» politically_exposed body boolean false Coverage years
» occupation body string false none
» nature_of_work body string false none
» nominee_name body string false pass ‘Y’, If the User consumes Tobbacco else ‘N’
» nominee_dob body date false Format:- DD/MM/YYYY
» relationship body string false none
» insurer_code body string false From Quotation API
» insurance_name body string false none
» unique_id body string false From Quotation API
» auto_debit body string false Pass ‘Y’ if user opt for Standing Instructions.
» sum_insured body integer false Value of Cover Amount, user looking for
» frequency body string false Frequency of the Premium user opting for
» policy_term body integer false Coverage years
» payout_option body string false Lumpsum Option user wants to opt for.
» state body string false state_name from PINCODE listing API
» tobaco_user body string false pass ‘Y’, If the User consumes Tobbacco else ‘N’
» rider_flag body string false pass ‘Y’, If the User Opted any Rider else ‘N’
» members body [object] false none
»» type body string false Classify this member as a child(dependent 25 years) or adult
»» member_type body string false Relation to policy proposer
»» sum_insured body integer false none
»» dob body date false Date of birth of member(format: “DD/MM/YYYY”)
»» pincode body integer false Pincode available in PINCODE Listing API
»» city_name body string false city_name correspond to available PINCODE’s
»» state_name body string false state_name correspond to available PINCODE’s
»» gender body string false Classify Member as a Male or Female
»» proposer body boolean false none
»» nationality body string false Nationalitiy of Member
» rider body any false none
» spouse_detail body object false none
»» income body string false If occupation is Housewife then Spouse Income
»» total_life_cover body string false If occupation is Housewife then Spouse’s Total Life Insurance Cover

Enumerated Values

Parameter Value
»» employment sal
»» employment nosal
»» employment nowork
»» gender M
»» gender F
»» gender TG
»» education BHS
»» education HS
»» education BD
»» education PG
»» marital_status single
»» marital_status married
» auto_debit Y
» auto_debit N
» frequency monthly
» frequency single
» frequency annually
» payout_option lumpsum
» tobaco_user Y
» tobaco_user N
» rider_flag Y
» rider_flag N
»» type adult
»» type kids
»» member_type proposer
»» member_type daughter
»» member_type father
»» member_type mother
»» member_type son
»» member_type spouse
»» gender M
»» gender F
»» nationality INDIAN
»» nationality

Example responses

200 Response

{
    "status": 0,
    "message": "string",
    "data": {
        "unique_identifier": "string",
        "aegon_payment_url": "string",
        "final_premium": 0,
        "base_premium": 0,
        "gst": 0,
        "payment_url": "string"
    }
}

Responses

Status Meaning Description Schema
200 OK Returns a list of Quotation minimum Inline
400 Bad Request Returns Error Response Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
» status integer false none 200
» message string false none none
» data object false none none
»» unique_identifier string false none none
»» aegon_payment_url string false none Payment Link
»» final_premium integer false none none
»» base_premium integer false none none
»» gst integer false none none
»» payment_url string false none Payment Link

Status Code 400

Name Type Required Restrictions Description
» status integer false none 200
» message string false none Some thing went wrong
» data object false none none

AI/ML

Policy PDF_ Image OCR

Code samples

# You can also use wget
curl -X POST https://cms-dev.theblackswan.in/policy/prefill-data-policy \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'
import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://cms-dev.theblackswan.in/policy/prefill-data-policy', headers = headers)

print(r.json())

POST /policy/prefill-data-policy

Example responses

400 Response

{
    "status": 0,
    "message": "string",
    "data": {}
}

Responses

Status Meaning Description Schema
201 Created none None
400 Bad Request Returns Error Response Inline

Response Schema

Status Code 400

Name Type Required Restrictions Description
» status integer false none 200
» message string false none Some thing went wrong
» data object false none none

RC Image OCR

Code samples

# You can also use wget
curl -X POST https://cms-dev.theblackswan.in/policy/prefill-data-rc \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'
import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://cms-dev.theblackswan.in/policy/prefill-data-rc', headers = headers)

print(r.json())

POST /policy/prefill-data-rc

Example responses

400 Response

{
    "status": 0,
    "message": "string",
    "data": {}
}

Responses

Status Meaning Description Schema
201 Created none None
400 Bad Request Returns Error Response Inline

Response Schema

Status Code 400

Name Type Required Restrictions Description
» status integer false none 200
» message string false none Some thing went wrong
» data object false none none

Report

Summary Report Generation API

Code samples

# You can also use wget
curl -X GET https://cms-dev.theblackswan.in/policy/report/summary \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'
import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('https://cms-dev.theblackswan.in/policy/report/summary', headers = headers)

print(r.json())

GET /policy/report/summary

Example responses

Responses

Status Meaning Description Schema
200 OK none None
400 Bad Request none None

Response Schema

Report Generation API

Code samples

# You can also use wget
curl -X GET https://cms-dev.theblackswan.in/policy/report?report_type=MOTOR \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'
import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('https://cms-dev.theblackswan.in/policy/report', params={
  'report_type': 'MOTOR'
}, headers = headers)

print(r.json())

GET /policy/report

Parameters

Name In Type Required Description
page query string false 1
limit query string false 20
end_date query string false 20/05/2021
start_date query string false 20/04/2021
report_type query string true Type of Report

Enumerated Values

Parameter Value
report_type MOTOR
report_type HEALTH
report_type LIFE

Example responses

200 Response

{
    "allow_renew": null,
    "breakin_status": null,
    "business_name": null,
    "creation_date": null,
    "cubic_capacity": null,
    "customer_email": null,
    "customer_name": null,
    "customer_phone": null,
    "fuel": null,
    "inspection_number": null,
    "insurer_logo": null,
    "insurer_name": null,
    "is_breakin_case": null,
    "issue_date": null,
    "make": null,
    "master_posp_name": null,
    "model": null,
    "net_premium": null,
    "network_manager_name": null,
    "payment_status": null,
    "payment_url": null,
    "plan_type": null,
    "policy_end_date": null,
    "policy_mode": null,
    "policy_number": null,
    "policy_pdf": null,
    "policy_start_date": null,
    "policy_status": null,
    "posp_name": null,
    "product_type": null,
    "registration_year": null,
    "rto": null,
    "source": null,
    "sub_posp_name": null,
    "total_premium": null,
    "transaction_id": null,
    "variant_name": null,
    "vehicle_no": null
}

Responses

Status Meaning Description Schema
200 OK Returns required fields Inline
400 Bad Request Returns Error Response Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
» allow_renew Boolean false none Policy is renewable or new policy
» breakin_status Boolean false none Wether policy is brakin or not
» business_name String false none Name of agent business
» creation_date String false none Date when policy is created
» cubic_capacity String false none Cubic capacity of vehicle
» customer_email String false none Email of customer
» customer_name String false none Name of customer
» customer_phone String false none Phone number of customer
» fuel String false none tell vehicle is petrol or desele or electric
» inspection_number String false none Inspection Number in case of break-in
» insurer_logo String false none Logo of insurer
» insurer_name String false none Name of Insurer
» is_breakin_case Boolean false none Wether policy is brak-in or not
» issue_date String false none Policy issuance date
» make String false none Name of vehicle manufacturer
» master_posp_name String false none Name of master POSP
» model String false none Vehicle model name
» net_premium Decimal false none Policy net premium
» network_manager_name String false none Name of Networ Manager
» payment_status String false none Status of Payment for policy
» payment_url String false none Link of payment url
» plan_type String false none Policy type(CO, TP, Breakin)
» policy_end_date String false none End date of policy
» policy_mode String false none Policy punched online or offline
» policy_number String false none Policy Number
» policy_pdf String false none Policy odf link
» policy_start_date String false none Policy start date
» policy_status String false none Polciy status (issued/pending)
» posp_name String false none Name of posp who sold policy
» product_type String false none Type of vehicle(Bike, scooter, pvt car etc)
» registration_year String false none Registeration date of vehicle
» rto String false none Vehicle registration RTO
» source String false none Medium of policy punched(web/app)
» sub_posp_name String false none Name of sub -posp
» total_premium Decimal false none Total premium of policy
» transaction_id String false none Transaction id of policy
» variant_name String false none Name of variant of vehicle
» vehicle_no String false none Regustration Number of vehicle

Status Code 400

Name Type Required Restrictions Description
» status integer false none 200
» message string false none Some thing went wrong
» data object false none none
Curl Python