Get Policy
Retrieve the full details of a single group health policy by its ID.
Endpoint
GET /v1/policy/{policy_id}
Path Parameters
| Parameter | Description |
|---|---|
| policy_id | BizzAssure internal policy ID (from List Policies) |
Request
Headers
| Header | Value |
|---|---|
| Authorization | Bearer YOUR_ACCESS_TOKEN |
Example Request
GET /v1/policy/ba_pol_01k...
Authorization: Bearer YOUR_ACCESS_TOKEN
Response
Success (200 OK)
{
"payload": {
"policy": {
"id": "ba_pol_01k...",
"client_id": "ba_client_abc...",
"policy_number": "HLT-2024-00123",
"insurer_id": "ba_ins_xyz...",
"product_id": "ba_prod_abc...",
"tpa_id": "ba_tpa_def...",
"net_premium": 850000.0,
"gross_premium": 1003000.0,
"coverage_type": "COVERAGE_TYPE_ESC",
"type": "POLICY_TYPE_FAMILY_FLOATER",
"status": "POLICY_STATUS_ACTIVE",
"start_date": "2024-01-01",
"end_date": "2024-12-31",
"sum_insured": ["300000", "500000"],
"inclusions": "Hospitalization, Day care procedures, ...",
"exclusions": "Pre-existing diseases (2-year waiting period), ...",
"terms_conditions": "...",
"policy_document_url": "https://...",
"insurer_name": "Star Health Insurance",
"insurer_logo": "https://...",
"network_hospital_url": "https://...",
"daycare_url": "https://...",
"product_name": "Comprehensive Health",
"tpa_name": "Medi Assist",
"client_name": "Acme Corp",
"cd_balance": 120000.0
},
"message": "Policy retrieved successfully",
"success": true
}
}
Policy Object Fields
| Field | Type | Description |
|---|---|---|
| id | string | BizzAssure internal policy ID |
| client_id | string | Client/organisation this policy belongs to |
| policy_number | string | Insurer-issued policy number |
| insurer_id | string | ID of the insurer |
| product_id | string | ID of the insurance product |
| tpa_id | string | ID of the Third-Party Administrator |
| net_premium | number | Net premium amount (INR) |
| gross_premium | number | Gross premium including taxes (INR) |
| coverage_type | string | COVERAGE_TYPE_E (Employee only), COVERAGE_TYPE_ES (+Spouse), COVERAGE_TYPE_ESC (+Children), COVERAGE_TYPE_ESCP (+Parents) |
| type | string | POLICY_TYPE_FAMILY_FLOATER, POLICY_TYPE_INDIVIDUAL, or POLICY_TYPE_FLOATER_WITH_SI_RESTRICTION |
| status | string | POLICY_STATUS_ACTIVE, POLICY_STATUS_INACTIVE, or POLICY_STATUS_SUSPENDED |
| start_date | string | Policy start date (YYYY-MM-DD) |
| end_date | string | Policy end date (YYYY-MM-DD) |
| sum_insured | string[] | Available sum insured slabs (INR, as strings) |
| inclusions | string | Covered benefits and inclusions |
| exclusions | string | Excluded conditions and procedures |
| terms_conditions | string | Full terms and conditions text |
| policy_document_url | string | URL to download the policy document |
| insurer_name | string | Display name of the insurer |
| insurer_logo | string | URL of the insurer's logo |
| network_hospital_url | string | URL to the insurer's network hospital list |
| daycare_url | string | URL to the insurer's daycare procedure list |
| product_name | string | Display name of the product |
| tpa_name | string | Display name of the TPA |
| client_name | string | Display name of the client organisation |
| cd_balance | number | Current CD (Credit Deposit) balance for this policy (INR) |
Error Responses
Not Found (404)
{
"type": "NOT_FOUND",
"title": "Policy Not Found",
"detail": "No policy found with the given ID",
"instance": "/v1/policy/ba_pol_01k"
}
Unauthorized (401)
{
"type": "UNAUTHORIZED",
"title": "Unauthorized",
"detail": "Missing or invalid access token",
"instance": "/v1/policy/ba_pol_01k"
}