Quotes

You can retrieve all quotes in a specific date range using this API. This endpoint provides comprehensive details about the quotes generated.

Get Quotes

Retrieves all quotes in a specific date range.

note

A single session ID can be associated with multiple quotes as users compare different insurance options. For each quote and variant combination, only one proposal can be active at a time (meaning not in REJECTED or CANCELLED status).

Request

GET /v1/business/health/quotes?session_id={id}&start_date={YYYY-MM-DD}&end_date={YYYY-MM-DD}&next={next-cursor}&prev={prev-cursor}

Fields

Field	Type	Required	Description
session_id	string	Yes	Unique identifier for the session where quote details are stored and tracked otherwise null
start_date	string	No	The start of the date range for filtering quotes, in `YYYY-MM-DD` format.
end_date	string	No	The end of the date range for filtering quotes, in `YYYY-MM-DD` format.
next	string	No	The next cursor to paginate through the results(send the end_cursor from the response).
prev	string	No	The previous cursor to paginate through the results(send the start_cursor from the response).

note

The start_date and end_date parameters must be within a 7-day range. Requests with a date range greater than 7 days will return an error.

start_date and end_date and session_id cannot be used together at the same time.

Response

{
  "quotes": [
    {
      "session_id": "18kdaYY6WvClEx34",
      "quote_id": "18kfaYY6UvClEx35",
      "sum_insured": "1000000",
      "pincode": "560071",
      "deductible": "0",
      "total_variants": 23,
      "completed_variants": 12,
      "member_details": [
        {
          "relation": "self",
          "age": 30
        },
        {
          "relation": "daughter",
          "age": 10
        },
        {
          "relation": "daughter",
          "age": 10
        }
      ],
      "plan_type": "BASE",
      "customer_name": "John Doe",
      "customer_phone": "9848488484",
      "customer_gender": "Male",
      "customer_email": "john.doe@example.com",
      "recommendations": [
        {
          "recommendation_id": "18TzMT7LGohy13QG",
          "company_id": "18TzMT7LGohy13QG",
          "company_name": "ICICI Lombard",
          "company_logo": "https://cdn.oasr.in/oa-site/cms-uploads/media/icici_lombard_logo_b73c659d45.jpeg",
          "company_description": "ICICI Lombard",
          "company_network_hospital_count": 7547,
          "company_claim_settlement_ratio": 99,
          "product_id": "18TzWesACxcf3fNW",
          "product_name": "Elevate",
          "variant_id": "18TzcpfwTP0HHPI8",
          "variant_name": "Elevate",
          "premium_details": [
            {
              "tenure": 1,
              "premium": "11295"
            },
            {
              "tenure": 2,
              "premium": "21460"
            },
            {
              "tenure": 3,
              "premium": "31402"
            }
          ],
          "recommended": true
        }
      ]
    }
  ],
  "end_cursor": "18q79YF6b8aprZse",
  "start_cursor": "18qFYnYsTGJR5uDb",
  "has_next": false,
  "has_prev": true,
  "count": 35
}

Response Fields

Field	Type	Optional	Description
session_id	string	Yes	Session ID of the quote otherwise null
quotes	array	No	Array of quote objects
has_next	boolean	No	Whether there are more quotes available in next page
has_prev	boolean	No	Whether there are more quotes available in previous page
count	number	No	Total number of quotes matching the criteria
end_cursor	string	No	Cursor pointing to the end of current page results(send the end_cursor from the response)
start_cursor	string	No	Cursor pointing to the start of current page results(send the start_cursor from the response)

Quote Object Fields

Field	Type	Optional	Description
session_id	string	Yes	Unique identifier for the session where quote details are stored and tracked otherwise null
quote_id	string	No	Unique identifier for the quote
sum_insured	string	No	Total sum insured amount in INR
pincode	string	No	6-digit postal code
deductible	string	No	Deductible amount in INR
total_variants	number	No	Total number of variants available
completed_variants	number	No	Number of variants processed
member_details	array	No	Details of insured members (see Member Details table below)
plan_type	string	No	Type of insurance plan(see Plan table below)
customer_name	string	No	Name of the customer
customer_phone	string	No	Phone number of the customer
customer_gender	string	No	Gender of the customer
customer_email	string	No	Email address of the customer
recommendations	array	No	Array of recommended insurance products (see Recommendations table below)

Plan Type Values

Values	Description
BASE	Base plan
SUPER_TOP_UP	Super top up plan

Member Details Fields

Field	Type	Optional	Description
relation	string	No	Relationship with the proposer
age	number	No	Age of the member

Recommendations Fields

Field	Type	Optional	Description
recommendation_id	string	No	Unique identifier for the recommendation
company_id	string	No	Unique identifier for the insurance company
company_name	string	No	Name of the insurance company
company_logo	string	No	URL to the company's logo
company_description	string	No	Brief description of the company
company_network_hospital_count	number	No	Number of network hospitals
company_claim_settlement_ratio	number	No	Claim settlement ratio percentage
product_id	string	No	Unique identifier for the insurance product
product_name	string	No	Name of the insurance product
variant_id	string	No	Unique identifier for the product variant
variant_name	string	No	Name of the product variant
premium_details	array	No	Array of premium details (see Premium Details table below)
recommended	boolean	No	Whether this is a recommended product

Premium Details Fields

Field	Type	Optional	Description
tenure	number	No	Policy tenure in years
premium	string	No	Premium amount in INR for the tenure

Get Quote By Id

Retrieves a quote by its unique identifier.

Request

GET /v1/business/health/quotes/:id

URL Parameters

Field	Type	Required	Description
id	string	Yes	Unique identifier for the quote

Response

{
  "quote": {
    "session_id": "18kdaYY6WvClEx34",
    "quote_id": "18kfaYY6UvClEx35",
    "sum_insured": "1000000",
    "pincode": "560071",
    "deductible": "0",
    "total_variants": 23,
    "completed_variants": 12,
    "member_details": [
      {
        "relation": "self",
        "age": 30
      },
      {
        "relation": "daughter",
        "age": 10
      },
      {
        "relation": "daughter",
        "age": 10
      }
    ],
    "plan_type": "BASE",
    "customer_name": "John Doe",
    "customer_phone": "9848488484",
    "customer_gender": "Male",
    "customer_email": "john.doe@example.com",
    "recommendations": [
      {
        "recommendation_id": "18TzMT7LGohy13QG",
        "company_id": "18TzMT7LGohy13QG",
        "company_name": "ICICI Lombard",
        "company_logo": "https://cdn.oasr.in/oa-site/cms-uploads/media/icici_lombard_logo_b73c659d45.jpeg",
        "company_description": "ICICI Lombard",
        "company_network_hospital_count": 7547,
        "company_claim_settlement_ratio": 99,
        "product_id": "18TzWesACxcf3fNW",
        "product_name": "Elevate",
        "variant_id": "18TzcpfwTP0HHPI8",
        "variant_name": "Elevate",
        "premium_details": [
          {
            "tenure": 1,
            "premium": "11295"
          },
          {
            "tenure": 2,
            "premium": "21460"
          },
          {
            "tenure": 3,
            "premium": "31402"
          }
        ],
        "recommended": true
      }
    ]
  }
}

Response Fields

Field	Type	Optional	Description
quote	object	No	Quote object

Quote Object Fields

Field	Type	Optional	Description
session_id	string	Yes	Unique identifier for the session where quote details are stored and tracked otherwise null
quote_id	string	No	Unique identifier for the quote
sum_insured	string	No	Total sum insured amount in INR
pincode	string	No	6-digit postal code
deductible	string	No	Deductible amount in INR
total_variants	number	No	Total number of variants available
completed_variants	number	No	Number of variants processed
member_details	array	No	Details of insured members (see Member Details table below)
plan_type	string	No	Type of insurance plan(see Plan table below)
customer_name	string	No	Name of the customer
customer_phone	string	No	Phone number of the customer
customer_gender	string	No	Gender of the customer
customer_email	string	No	Email address of the customer
recommendations	array	No	Array of recommended insurance products (see Recommendations table below)

Plan Type Values

Values	Description
BASE	Base plan
SUPER_TOP_UP	Super top up plan

Member Details Fields

Field	Type	Optional	Description
relation	string	No	Relationship with the proposer
age	number	No	Age of the member

Recommendations Fields

Field	Type	Optional	Description
recommendation_id	string	No	Unique identifier for the recommendation
company_id	string	No	Unique identifier for the insurance company
company_name	string	No	Name of the insurance company
company_logo	string	No	URL to the company's logo
company_description	string	No	Brief description of the company
company_network_hospital_count	number	No	Number of network hospitals
company_claim_settlement_ratio	number	No	Claim settlement ratio percentage
product_id	string	No	Unique identifier for the insurance product
product_name	string	No	Name of the insurance product
variant_id	string	No	Unique identifier for the product variant
variant_name	string	No	Name of the product variant
premium_details	array	No	Array of premium details (see Premium Details table below)
recommended	boolean	No	Whether this is a recommended product

Premium Details Fields

Field	Type	Optional	Description
tenure	number	No	Policy tenure in years
premium	string	No	Premium amount in INR for the tenure

Get Quotes​

Request​

Fields​

Response​

Response Fields​

Quote Object Fields​

Plan Type Values​

Member Details Fields​

Recommendations Fields​

Premium Details Fields​

Get Quote By Id​

Request​

URL Parameters​

Response​

Response Fields​

Quote Object Fields​

Plan Type Values​

Member Details Fields​

Recommendations Fields​

Premium Details Fields​

Get Quotes

Request

Fields

Response

Response Fields

Quote Object Fields

Plan Type Values

Member Details Fields

Recommendations Fields

Premium Details Fields

Get Quote By Id

Request

URL Parameters

Response

Response Fields

Quote Object Fields

Plan Type Values

Member Details Fields

Recommendations Fields

Premium Details Fields