Proposals
You can retrieve all proposals in a specific date range using this API. This endpoint provides comprehensive details about the proposal.
Get Propsals
Retrieves all proposals in a specific date range or session id
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/proposals?session_id={id}&start_date={YYYY-MM-DD}&end_date={YYYY-MM-DD}&next={next-cursor}&prev={prev-cursor}
Query Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| session_id | string | Yes | Unique identifier for the session where proposal details are stored and tracked otherwise null |
| start_date | string | No | The start of the date range for filtering proposals, in YYYY-MM-DD format. |
| end_date | string | No | The end of the date range for filtering proposals, in YYYY-MM-DD format. |
| next | string | No | The next cursor to paginate through the results. |
| prev | string | No | The previous cursor to paginate through the results. |
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
{
"proposals": [
{
"proposal_id": "19uZNZEXFRXqzH7D",
"session_id": "18kfaYY6UvClEx35",
"name": "John Doe",
"phone": "973456786",
"email": "abc@gmail.com",
"insurer_name": "ICICI Lombard",
"insurer_id": "18kfaYY6UvClEx35",
"product_name": "Elevate",
"product_id": "18kfaYY6UvClEx35",
"variant_name": "Elevate",
"variant_id": "18kfaYY6UvClEx35",
"tenure": "1",
"net_premium": "7282.20",
"gross_premium": "8593.00",
"status": "ACCEPTED",
"form_responses": {}, // TODO
"insurer_proposal_id": "",
"cancelled_reason": "Customer BMI is too high",
"rejection_reason": "Customer's daily drinking habit is too high",
"quote_id": "18kfaYY6UvClEx35"
}
],
"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 proposal otherwise null |
| proposals | array | No | Array of proposal objects |
| has_next | boolean | No | Whether there are more proposals available in next page |
| count | number | No | Total number of proposals matching the criteria |
| metadata | object | Yes | Additional metadata if any |
| 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) |
Proposal Fields
| Field | Type | Optional | Description |
|---|---|---|---|
| proposal_id | string | No | Unique identifier for the proposal |
| name | string | No | Name of the proposer |
| phone | string | No | Phone number of the proposer |
| string | No | Email address of the proposer | |
| insurer_name | string | No | Name of the insurance company |
| insurer_id | string | No | Unique identifier for the insurance company |
| product_name | string | No | Name of the insurance product |
| product_id | string | No | Unique identifier for the insurance product |
| variant_name | string | No | Name of the product variant |
| variant_id | string | No | Unique identifier for the product variant |
| tenure | number | No | Policy tenure in years |
| net_premium | string | No | Net premium amount in INR |
| gross_premium | string | No | Total premium amount including taxes in INR |
| status | string | No | Current status of the proposal(see status table below) |
| insurer_proposal_id | string | Yes | Proposal ID assigned by the insurer if any otherwise null |
| quote_id | string | No | Unique identifier for the quote |
| cancelled_reason | string | Yes | Reason for cancellation if any otherwise null |
| rejection_reason | string | Yes | Reason for rejection if any otherwise null |
Status Values
| Values | Description |
|---|---|
| INITIATED | Proposal has been submitted to the OneAssure internal system |
| PENDING | Proposal has passed the initial checks and is waiting for being submitted to the insurer |
| SUBMITTED | Proposal has been submitted to the insurer |
| UNDERWRITING | Proposal is under underwriting review with the insurer |
| CANCELLED | Proposal has been cancelled by the OneAssure internal system due to failing pre-underwriting checks |
| ACCEPTED | Proposal has been accepted by the insurer |
| REJECTED | Proposal has been rejected by the insurer |
| OFFLINE | Proposal will be processed offline |
Get Proposal By Id
Retrieves a proposal by its unique identifier
Request
GET /v1/business/health/proposals/:id
URL Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string | Yes | Unique identifier for the policy |
Response
{
"proposal": {
"proposal_id": "19uZNZEXFRXqzH7D",
"session_id": "18kfaYY6UvClEx35",
"name": "John Doe",
"phone": "973456786",
"email": "abc@gmail.com",
"insurer_name": "ICICI Lombard",
"insurer_id": "18kfaYY6UvClEx35",
"product_name": "Elevate",
"product_id": "18kfaYY6UvClEx35",
"variant_name": "Elevate",
"variant_id": "18kfaYY6UvClEx35",
"tenure": "1",
"net_premium": "7282.20",
"gross_premium": "8593.00",
"status": "ACCEPTED",
"form_responses": {}, // TODO
"insurer_proposal_id": "",
"cancelled_reason": "Customer BMI is too high",
"rejection_reason": "Customer's daily drinking habit is too high",
"quote_id": "18kfaYY6UvClEx35"
}
}
Response Fields
| Field | Type | Optional | Description |
|---|---|---|---|
| policy | object | No | Policy object |
Proposal Fields
| Field | Type | Optional | Description |
|---|---|---|---|
| proposal_id | string | No | Unique identifier for the proposal |
| name | string | No | Name of the proposer |
| phone | string | No | Phone number of the proposer |
| string | No | Email address of the proposer | |
| insurer_name | string | No | Name of the insurance company |
| insurer_id | string | No | Unique identifier for the insurance company |
| product_name | string | No | Name of the insurance product |
| product_id | string | No | Unique identifier for the insurance product |
| variant_name | string | No | Name of the product variant |
| variant_id | string | No | Unique identifier for the product variant |
| tenure | number | No | Policy tenure in years |
| net_premium | string | No | Net premium amount in INR |
| gross_premium | string | No | Total premium amount including taxes in INR |
| status | string | No | Current status of the proposal(see status table below) |
| insurer_proposal_id | string | Yes | Proposal ID assigned by the insurer if any otherwise null |
| quote_id | string | No | Unique identifier for the quote |
| cancelled_reason | string | Yes | Reason for cancellation if any otherwise null |
| rejection_reason | string | Yes | Reason for rejection if any otherwise null |
Status Values
| Values | Description |
|---|---|
| INITIATED | Proposal has been submitted to the OneAssure internal system |
| PENDING | Proposal has passed the initial checks and is waiting for being submitted to the insurer |
| SUBMITTED | Proposal has been submitted to the insurer |
| UNDERWRITING | Proposal is under underwriting review with the insurer |
| CANCELLED | Proposal has been cancelled by the OneAssure internal system due to failing pre-underwriting checks |
| ACCEPTED | Proposal has been accepted by the insurer |
| REJECTED | Proposal has been rejected by the insurer |
| OFFLINE | Proposal will be processed offline |