Policy Members

Returns a paginated list of all members (employees and their dependents) enrolled in a specific policy. You can filter by employee ID to retrieve only one employee's coverage entries.

Endpoint

GET /v1/policy/{policy_id}/members

Path Parameters

Parameter	Description
policy_id	BizzAssure internal policy ID (from List Policies)

Request

Headers

Header	Value
Authorization	Bearer YOUR_ACCESS_TOKEN

Query Parameters

Parameter	Type	Required	Description
employee_id	string	No	Filter results to a specific employee (and their dependents on this policy)
status	string	No	Filter by member status: ACTIVE, INACTIVE, or SUSPENDED
search	string	No	Search by employee name or email
limit	number	No	Number of results per page (default: 10)
start_cursor	string	No	Cursor for forward pagination (use end_cursor from the previous response)
last_cursor	string	No	Cursor for backward pagination (use start_cursor from the previous response)

Example — All members of a policy

GET /v1/policy/ba_pol_01k/members?status=ACTIVE&limit=50
Authorization: Bearer YOUR_ACCESS_TOKEN

Example — Members for a specific employee

GET /v1/policy/ba_pol_01k/members?employee_id=ba_emp_01jwz3k&limit=10
Authorization: Bearer YOUR_ACCESS_TOKEN

Response

Success (200 OK)

Each row in members represents a single covered person — either an employee or one of their dependents.

{
  "payload": {
    "members": [
      {
        "id": "ba_pmem_01...",
        "client_id": "ba_client_abc...",
        "policy_id": "ba_pol_01k...",
        "employee_id": "ba_emp_01jwz3k...",
        "dependent_id": null,
        "endorsement_id": "ba_end_xyz...",
        "insurer_member_id": "INS-MEM-00123",
        "coverage_start_date": "2024-01-01",
        "coverage_end_date": "2024-12-31",
        "premium_amount": 12000.0,
        "sum_insured": 300000.0,
        "remaining_sum_insured": 285000.0,
        "status": "active",
        "employee_name": "Ravi Kumar",
        "employee_email": "ravi.kumar@company.com",
        "employee_dob": "1990-04-15",
        "employee_gender": "MALE",
        "employee_department": "Engineering",
        "employee_designation": "Software Engineer"
      },
      {
        "id": "ba_pmem_02...",
        "client_id": "ba_client_abc...",
        "policy_id": "ba_pol_01k...",
        "employee_id": "ba_emp_01jwz3k...",
        "dependent_id": "ba_dep_01k...",
        "coverage_start_date": "2024-01-01",
        "coverage_end_date": "2024-12-31",
        "status": "active",
        "employee_name": "Ravi Kumar",
        "employee_email": "ravi.kumar@company.com"
      }
    ],
    "total_count": 2,
    "start_cursor": "eyJpZCI6...",
    "end_cursor": "eyJpZCI6...",
    "has_previous": false,
    "has_next": false,
    "message": "Policy members retrieved successfully",
    "success": true
  }
}

Member Object Fields

Field	Type	Description
id	string	BizzAssure internal policy-member record ID
client_id	string	Client/organisation ID
policy_id	string	Policy this member belongs to
employee_id	string	BizzAssure internal employee ID
dependent_id	string?	BizzAssure internal dependent ID — null if the row represents the employee themselves
endorsement_id	string?	Endorsement that enrolled this member, if applicable
insurer_member_id	string?	Member ID assigned by the insurer (available after insurer processes the endorsement)
coverage_start_date	string	Start of coverage (YYYY-MM-DD)
coverage_end_date	string	End of coverage (YYYY-MM-DD)
premium_amount	number?	Premium allocated to this member (INR)
sum_insured	number?	Sum insured for this member (INR)
remaining_sum_insured	number?	Remaining sum insured after claims (INR)
status	string	active, inactive, or suspended
employee_name	string	Employee's full name
employee_email	string	Employee's email address
employee_dob	string	Employee's date of birth (YYYY-MM-DD)
employee_gender	string	Employee's gender
employee_department	string?	Employee's department
employee_designation	string?	Employee's job title

Pagination Fields

Field	Type	Description
total_count	number	Total number of member rows matching the filter
start_cursor	string	Pass as last_cursor to paginate backward
end_cursor	string	Pass as start_cursor to get the next page
has_previous	boolean	true if there are earlier pages
has_next	boolean	true if there are more pages after this one

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/members"
}

Unauthorized (401)

{
  "type": "UNAUTHORIZED",
  "title": "Unauthorized",
  "detail": "Missing or invalid access token",
  "instance": "/v1/policy/ba_pol_01k/members"
}