Add an employee to a group

Adds an existing employee to a group. The employee must belong to the same employer as the group. If there is a group_policy associated with the group, a corresponding enrolment_intent will be created for the employee.

Authentication

AuthorizationBearer

Authorization header using the Bearer scheme

Path Parameters

group_idstringRequiredformat: "gr_.+"

Request

This endpoint expects an object.

employee_idstringRequiredformat: "ee_.+"

Employee Id

create_enrolment_intentsboolean or nullOptional

Controls whether enrolment intents are automatically created for the employee. Enrolment intents are only created if the employee is eligible. Defaults to true for hosted platforms and false for non-hosted platforms when not specified.

policy_configurationobject or nullOptional

Policy configuration for the employee in this group. Leave null to use group defaults.

Response

idstringformat: "ee_.+"

Unique identifier for the employee.

group_idstringformat: "gr_.+"

Unique identifier for the group.

policieslist of objects

List of policies associated with the employee in this group.

enrolmentslist of objects

List of enrolments associated with the employee in this group.

eligibility_statusenum

Eligibility status for the employee in this group. Pending = no eligibility check performed (no group policy), Eligible = employee meets provider’s eligibility criteria, Ineligible = employee does not meet eligibility criteria (e.g., age restrictions).

Allowed values:

desired_policy_start_datedate or null

The desired date for the employee’s policy to start. This date is not guaranteed to be honored by the insurance provider and may be adjusted based on provider-specific rules and requirements.

enrolment_datedate or null

The date on which the employee agreed to enrol into the group's policies. This date may be used by some insurance providers to determine the policy start date.

1	import requests
2
3	url = "https://test.api.kota.io/groups/gr_3b1333d87d9d4fd6ad83ba7f6b0e951a/employees"
4
5	payload = { "employee_id": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a" }
6	headers = {
7	"Authorization": "Bearer <token>",
8	"Content-Type": "application/json"
9	}
10
11	response = requests.post(url, json=payload, headers=headers)
12
13	print(response.json())

1	{
2	"id": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a",
3	"group_id": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a",
4	"policies": [
5	{
6	"id": "p_3b1333d87d9d4fd6ad83ba7f6b0e951a"
7	}
8	],
9	"enrolments": [
10	{
11	"id": "ei_3b1333d87d9d4fd6ad83ba7f6b0e951a"
12	}
13	],
14	"eligibility_status": "pending",
15	"desired_policy_start_date": "2024-12-01",
16	"enrolment_date": "2024-12-01"
17	}

Authentication

Path Parameters

Headers

Request

Response

Errors