Policies

Policy endpoints are used to retrieve policy details

Get Policies

Retrieves all policies in a specific date range or session id

Request

GET /v1/business/health/policies?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	No	Unique identifier for the session where policy details are stored and tracked
start_date	string	No	The start of the date range for filtering policies, in YYYY-MM-DD format.
end_date	string	No	The end of the date range for filtering policies, 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

{
  "policies": [
    {
      "session_id": "18kfaYY6UvClEx35",
      "policy_id": "18kfaYY6UvClEx35",
      "insurer_policy_number": "31-24-0134728-00",
      "status": "ISSUED",
      "issuance_date": "2024-10-08",
      "expiry_date": "2025-10-07",
      "sum_insured": "1000000",
      "policy_type": "FRESH",
      "tenure": 1,
      "gross_premium": "10417.00",
      "insurer_id": "18kfaYY6UvClEx35",
      "insurer_name": "ICICI Lombard",
      "insurer_logo": "https://cdn.oasr.in/oa-site/cms-uploads/media/thumbnail_ABHI_logo_d425a45a55.jpg",
      "product_id": "18kfaYY6UvClEx35",
      "product_name": "ICICI Lombard Health Insurance",
      "variant_id": "18kfaYY6UvClEx35",
      "variant_name": "ICICI Lombard Health Insurance",
      "previous_policy_id": "18kfaYY6UvClEx35",
      "proposer_details": {
        "address_line_1": "123, 1st Lane",
        "address_line_2": "3rd Main Street",
        "city": "Bangalore",
        "state": "Karnataka",
        "country": "India",
        "pincode": "560008",
        "dob": "1990-01-01",
        "email": "john.doe@example.com",
        "name": "John Doe",
        "phone": "9848488484",
        "bank_id": "18kfaYY6UvClEx35",
        "bank_account_number": "1234567890",
        "bank_name": "ICICI Bank",
        "branch_id": "18kfaYY6UvClEx35",
        "branch_name": "Bangalore Branch",
        "ifsc_code": "ICIC0000001"
      },
      "insured_members": [
        {
          "member_id": "18kfaYY6UvClEx35",
          "dob": "1990-01-01",
          "gender": "Male",
          "name": "John Doe",
          "pre_existing_diseases": ["Hypertension"],
          "relationship": "SELF"
        }
      ],
      "nominees": [
        {
          "nominee_id": "18kfaYY6UvClEx35",
          "nominee_name": "John Doe",
          "nominee_phone": "9848488484",
          "relationship": "Spouse"
        }
      ],
      "riders": [
        {
          "id": "18ceBvygbS2tjQlE",
          "name": "Cancer Booster"
        }
      ],
      "proposal_id": "18kfaYY6UvClEx35",
      "quote_id": "18kfaYY6UvClEx35"
    }
  ],

  "end_cursor": "18q79YF6b8aprZse",
  "start_cursor": "18qFYnYsTGJR5uDb",
  "has_prev": false,
  "has_next": true,
  "total_count": 35
}

Response Fields

Field	Type	Optional	Description
session_id	string	Yes	Session ID of the policy otherwise null
policies	array	No	Array of policy objects
has_next	boolean	No	Whether there are more policies available in next page
has_prev	boolean	No	Whether there are more policies available in previous page
count	number	No	Total number of policies
end_cursor	string	No	Cursor pointing to the end of current page results
start_cursor	string	No	Cursor pointing to the start of current page results

Policy Object Fields

Field	Type	Optional	Description
session_id	string	Yes	Session ID of the policy otherwise null
insurer_logo	string	No	URL to the insurer's logo
insurer_id	string	No	Unique identifier for the insurer
insurer_name	string	No	Name of the insurance company
policy_number	string	No	Unique policy number
product_id	string	No	Unique identifier for the insurance product
product_name	string	No	Name of the insurance product
status	string	No	Current status of the policy
variant_id	string	No	Unique identifier for the product variant
variant_name	string	No	Name of the product variant
insured_members	array	No	Details of insured members (see Insured Members table below)
nominees	array	No	Details of nominees (see Nominee Fields table below)
riders	array	No	List of selected riders (see Rider Fields table below)
previous_policy_id	string	Yes	ID of the previous policy if any otherwise null
expiry_date	string	No	Policy expiry date in YYYY-MM-DD format
issuance_date	string	No	Policy issuance date in YYYY-MM-DD format
insurer_policy_number	string	No	Policy number from the insurer
policy_type	string	No	Type of policy (e.g., "FRESH")
sum_insured	string	No	Total sum insured amount in INR
tenure	number	No	Policy tenure in years
gross_premium	string	No	Total premium amount in INR
proposal_id	string	Yes	Unique identifier for the proposal if any otherwise null
quote_id	string	Yes	Unique identifier for the quote if any otherwise null

Proposer Details Fields

Field	Type	Optional	Description
address	object	No	Address object (see Address Fields table below)
dob	string	No	Date of birth in YYYY-MM-DD format
email	string	Yes	Email address of the proposer otherwise null
name	string	No	Full name of the proposer
phone	string	No	Phone number of the proposer
bank_details	object	Yes	Bank details object (see Bank Details Fields table below)

Address Fields

Field	Type	Optional	Description
address_line_1	string	No	Complete address of the proposer
address_line_2	string	Yes	Additional address line of the proposer
pincode	string	No	6-digit postal code
city	string	No	City of the proposer
state	string	No	State of the proposer
country	string	No	Country of the proposer

Bank Details Fields

Field	Type	Optional	Description
bank_id	string	No	Unique identifier for the bank
bank_account_number	string	No	Bank account number
bank_name	string	No	Name of the bank
branch_id	string	No	Unique identifier for the branch
branch_name	string	No	Name of the branch
ifsc_code	string	No	IFSC code of the bank branch

Insured Members Fields

Field	Type	Optional	Description
member_id	string	No	Unique identifier for the member
dob	string	No	Date of birth in YYYY-MM-DD format
gender	string	No	Gender of the insured member
name	string	No	Full name of the member
pre_existing_diseases	array	Yes	List of pre-existing diseases if any
relationship	string	No	Relationship with the proposer

Nominee Fields

Field	Type	Optional	Description
nominee_id	string	No	Unique identifier for the nominee
nominee_name	string	No	Full name of the nominee
nominee_phone	string	Yes	Phone number of the nominee otherwise null
relationship	string	No	Relationship with the insured member

Rider Fields

Field	Type	Optional	Description
id	string	No	Unique identifier for the rider
name	string	No	Name of the rider

Get Policy By Id

Retrieves a policy by its unique identifier

Request

GET /v1/business/health/policies/:id

URL Parameters

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

note

The id paramter can either be the Oneassure policy id or the insurer policy number.

Response

{
  "policy": {
    "session_id": "18kfaYY6UvClEx35",
    "policy_id": "18kfaYY6UvClEx35",
    "insurer_policy_number": "31-24-0134728-00",
    "status": "ISSUED",
    "issuance_date": "2024-10-08",
    "expiry_date": "2025-10-07",
    "sum_insured": "1000000",
    "policy_type": "FRESH",
    "tenure": 1,
    "gross_premium": "10417.00",
    "insurer_id": "18kfaYY6UvClEx35",
    "insurer_name": "ICICI Lombard",
    "insurer_logo": "https://cdn.oasr.in/oa-site/cms-uploads/media/thumbnail_ABHI_logo_d425a45a55.jpg",
    "product_id": "18kfaYY6UvClEx35",
    "product_name": "ICICI Lombard Health Insurance",
    "variant_id": "18kfaYY6UvClEx35",
    "variant_name": "ICICI Lombard Health Insurance",
    "previous_policy_id": "18kfaYY6UvClEx35",
    "proposer_details": {
      "address_line_1": "123, 1st Lane",
      "address_line_2": "3rd Main Street",
      "dob": "1990-01-01",
      "email": "john.doe@example.com",
      "name": "John Doe",
      "phone": "9848488484",
      "pincode": "560008",
      "bank_id": "18kfaYY6UvClEx35",
      "bank_account_number": "1234567890",
      "bank_name": "ICICI Bank",
      "branch_id": "18kfaYY6UvClEx35",
      "branch_name": "Bangalore Branch",
      "ifsc_code": "ICIC0000001",
      "city": "Bangalore",
      "state": "Karnataka",
      "country": "India"
    },
    "insured_members": [
      {
        "member_id": "18kfaYY6UvClEx35",
        "dob": "1990-01-01",
        "gender": "Male",
        "name": "John Doe",
        "pre_existing_diseases": ["Hypertension"],
        "relationship": "SELF"
      }
    ],
    "nominees": [
      {
        "nominee_id": "18kfaYY6UvClEx35",
        "nominee_name": "John Doe",
        "nominee_phone": "9848488484",
        "relationship": "Spouse"
      }
    ],
    "riders": [
      {
        "id": "18ceBvygbS2tjQlE",
        "name": "Cancer Booster"
      }
    ],
    "proposal_id": "18kfaYY6UvClEx35",
    "quote_id": "18kfaYY6UvClEx35"
  }
}

Response Fields

Field	Type	Optional	Description
policy	object	No	Policy object

Policy Object Fields

Field	Type	Optional	Description
session_id	string	Yes	Session ID of the policy otherwise null
insurer_logo	string	No	URL to the insurer's logo
insurer_id	string	No	Unique identifier for the insurer
insurer_name	string	No	Name of the insurance company
policy_number	string	No	Unique policy number
product_id	string	No	Unique identifier for the insurance product
product_name	string	No	Name of the insurance product
status	string	No	Current status of the policy
variant_id	string	No	Unique identifier for the product variant
variant_name	string	No	Name of the product variant
insured_members	array	No	Details of insured members (see Insured Members table below)
nominees	array	No	Details of nominees (see Nominee Fields table below)
riders	array	No	List of selected riders (see Rider Fields table below)
previous_policy_id	string	Yes	ID of the previous policy if any otherwise null
expiry_date	string	No	Policy expiry date in YYYY-MM-DD format
issuance_date	string	No	Policy issuance date in YYYY-MM-DD format
insurer_policy_number	string	No	Policy number from the insurer
policy_type	string	No	Type of policy (e.g., "FRESH")
sum_insured	string	No	Total sum insured amount in INR
tenure	number	No	Policy tenure in years
gross_premium	string	No	Total premium amount in INR
proposal_id	string	Yes	Unique identifier for the proposal if any otherwise null
quote_id	string	Yes	Unique identifier for the quote if any otherwise null

Proposer Details Fields

Field	Type	Optional	Description
address_line_1	string	No	Complete address of the proposer
address_line_2	string	Yes	Additional address line of the proposer
dob	string	No	Date of birth in YYYY-MM-DD format
email	string	Yes	Email address of the proposer otherwise null
name	string	No	Full name of the proposer
phone	string	No	Phone number of the proposer
pincode	string	No	6-digit postal code
bank_id	string	Yes	Unique identifier for the bank otherwise null
bank_account_number	string	Yes	Bank account number otherwise null
bank_name	string	Yes	Name of the bank otherwise null
branch_id	string	Yes	Unique identifier for the branch otherwise null
branch_name	string	Yes	Name of the branch otherwise null
ifsc_code	string	Yes	IFSC code of the bank branch otherwise null

Insured Members Fields

Field	Type	Optional	Description
member_id	string	No	Unique identifier for the member
dob	string	No	Date of birth in YYYY-MM-DD format
gender	string	No	Gender of the insured member
name	string	No	Full name of the member
pre_existing_diseases	array	Yes	List of pre-existing diseases if any
relationship	string	No	Relationship with the proposer

Nominee Fields

Field	Type	Optional	Description
nominee_id	string	No	Unique identifier for the nominee
nominee_name	string	No	Full name of the nominee
nominee_phone	string	Yes	Phone number of the nominee otherwise null
relationship	string	No	Relationship with the insured member

Rider Fields

Field	Type	Optional	Description
id	string	No	Unique identifier for the rider
name	string	No	Name of the rider