Skip to main content
POST
Create benefit eligibility policy

Authorizations

X-Partner-API-Key
string
header
required

Partner API key for external integrations

Path Parameters

company_id
string<uuid>
required

Unique identifier for the company

Body

application/json

Request to create a benefit eligibility policy

classification
enum<string>
required

Employee classification for benefit eligibility:

  • Full time - Full-time employees only
  • Part time - Part-time employees only
  • All - All employees regardless of classification
Available options:
Full time,
Part time,
All
waiting_period
enum<string>
required

Waiting period before benefit eligibility:

  • 1st of the following month - Eligibility starts first day of following month
  • 30 days - 30-day waiting period from hire date
  • 60 days - 60-day waiting period from hire date
  • None - Immediate eligibility
Available options:
1st of the following month,
30 days,
60 days,
None

Response

200 - application/json

Benefit eligibility policy created successfully

Response from creating a benefit eligibility policy

eligibility_policy
object
required

Benefit eligibility policy configuration