Skip to main content

Create Employee

Register a new employee in your organisation. The employee will be available for policy enrolment.

Endpoint

POST /v1/client/employees

Request

Headers

HeaderValue
Content-Typeapplication/json
AuthorizationBearer YOUR_ACCESS_TOKEN

Body

{
"employee_id": "EMP001",
"name": "Ravi Kumar",
"email": "ravi.kumar@company.com",
"phone_number": "9876543210",
"date_of_birth": "1990-04-15",
"gender": "GENDER_MALE",
"designation": "Software Engineer",
"department": "Engineering",
"date_of_joining": "2022-01-10",
"address": "123 MG Road, Bengaluru, Karnataka 560001",
"personal_email": "ravi@personal.com",
"personal_phone_number": "9123456789",
"status": "EMPLOYEE_STATUS_ACTIVE"
}

Fields

FieldTypeRequiredDescription
employee_idstringYesYour internal employee identifier
namestringYesFull name of the employee
emailstringYesOfficial email address (must be a valid email)
phone_numberstringYesOfficial phone number
date_of_birthstringYesDate of birth in YYYY-MM-DD format
genderstringYesGENDER_MALE, GENDER_FEMALE, or GENDER_OTHER
designationstringNoJob title / designation
departmentstringNoDepartment the employee belongs to
date_of_joiningstringNoDate of joining in YYYY-MM-DD format
addressstringNoResidential address
personal_emailstringNoPersonal email address
personal_phone_numberstringNoPersonal phone number
statusstringYesEMPLOYEE_STATUS_ACTIVE, EMPLOYEE_STATUS_INACTIVE, or EMPLOYEE_STATUS_INACTIVE_ONGOING_CLAIM

Response

Success (200 OK)

{
"payload": {
"employee_id": "ba_emp_01jwz3k...",
"message": "Employee created successfully",
"success": true
}
}

Response Fields

FieldTypeDescription
employee_idstringBizzAssure-assigned internal employee ID
messagestringHuman-readable result message
successbooleantrue if the employee was created

Error Responses

Validation Error (400 Bad Request)

{
"type": "VALIDATION_ERROR",
"title": "Validation Failed",
"detail": "email: must be a valid email address",
"instance": "/v1/client/employees"
}

Duplicate Employee (409 Conflict)

{
"type": "ALREADY_EXISTS",
"title": "Employee Already Exists",
"detail": "An employee with the given employee_id already exists for this client",
"instance": "/v1/client/employees"
}

Unauthorized (401 Unauthorized)

{
"type": "UNAUTHORIZED",
"title": "Unauthorized",
"detail": "Missing or invalid access token",
"instance": "/v1/client/employees"
}