Policy Coverage

Returns a list of coverage entries for an employee — one per active policy they are enrolled in. Each entry includes policy details (insurer, product, TPA, type, dates), the employee's coverage period, sum insured, health card PDF download URL, and UHID.

Endpoint

GET /v1/policy/coverage/{employee_id}

Request

Headers

Header	Value
Authorization	`Bearer YOUR_ACCESS_TOKEN`

Path Parameters

Parameter	Type	Required	Description
employee_id	string	Yes	BizzAssure internal employee ID

Example Request

GET /v1/policy/coverage/ba_emp_01jwz3k...
Authorization: Bearer YOUR_ACCESS_TOKEN

Response

Success (200 OK)

{
  "payload": [
    {
      "policy_id": "ba_pol_01k...",
      "policy_number": "GH/2024/001234",
      "insurer_name": "Star Health Insurance",
      "insurer_logo": "https://storage.bizassure.in/logos/star-health.png",
      "product_name": "Star Comprehensive",
      "category": "Group Health",
      "tpa_name": "Medi Assist",
      "type": "POLICY_TYPE_FAMILY_FLOATER",
      "coverage_type": "COVERAGE_TYPE_ESC",
      "start_date": "2024-04-01",
      "end_date": "2025-03-31",
      "coverage_start_date": "2024-07-01",
      "coverage_end_date": "2025-03-31",
      "sum_insured": 500000,
      "network_hospital_url": "https://www.starhealth.in/network-hospitals",
      "pdf_url": "https://storage.bizassure.in/health-cards/...?X-Amz-Expires=3600&...",
      "uhid": "UHID123456"
    }
  ]
}

Response Fields

The payload is an array of coverage objects, one per active policy the employee is enrolled in.

Field	Type	Required	Description
policy_id	string	Always	BizzAssure internal policy ID
policy_number	string	Always	Insurer-issued policy number
insurer_name	string	Always	Display name of the insurer
insurer_logo	string	Always	URL of the insurer's logo
product_name	string	Always	Name of the insurance product
category	string	Always	Policy category e.g. `Group Health`, `Group Term Life`, `Group Personal Accident`
tpa_name	string	Always	Name of the Third Party Administrator
type	string	Always	Policy type: `POLICY_TYPE_FAMILY_FLOATER`, `POLICY_TYPE_INDIVIDUAL`, or `POLICY_TYPE_FLOATER_WITH_SI_RESTRICTION`
coverage_type	string	Always	Who is covered: `COVERAGE_TYPE_E` (Employee only), `COVERAGE_TYPE_ES` (Employee + Spouse), `COVERAGE_TYPE_ESC` (Employee + Spouse + Children), `COVERAGE_TYPE_ESCP` (Employee + Spouse + Children + Parents), `COVERAGE_TYPE_P` (Parents only)
start_date	string	Always	Policy start date (`YYYY-MM-DD`)
end_date	string	Always	Policy end date (`YYYY-MM-DD`)
coverage_start_date	string	Always	This employee's coverage start date (`YYYY-MM-DD`)
coverage_end_date	string	Always	This employee's coverage end date (`YYYY-MM-DD`)
sum_insured	number	Always	Sum insured for this employee under the policy (INR)
network_hospital_url	string?	Optional	URL to the insurer's network hospital list
pdf_url	string	Always	Pre-signed URL to download the health card PDF (valid for 1 hour)
uhid	string?	Optional	Unique Health ID assigned by the insurer/TPA. `null` if not yet assigned

Error Responses

Employee Not Covered (404)

Returned when the employee exists but has no active coverage under any policy.

{
  "type": "NOT_FOUND",
  "title": "Employee Not Covered",
  "detail": "The employee is not covered",
  "instance": "/v1/policy/health-card/ba_emp_01jwz3k..."
}

Unauthorized (401)

{
  "type": "UNAUTHORIZED",
  "title": "Unauthorized",
  "detail": "Missing or invalid access token",
  "instance": "/v1/policy/health-card/ba_emp_01jwz3k..."
}

Endpoint​

Request​

Headers​

Path Parameters​

Example Request​

Response​

Success (200 OK)​

Response Fields​

Error Responses​

Employee Not Covered (404)​

Unauthorized (401)​