Specify Plans Available to Employee

This endpoint exposes eligibility management for employees.

Through this endpoint, you specify a unique set of plans per employee along with the rates associated with each plan for a particular employee.

Please note that:

  • Subsequent requests will overwrite the existing plans, not accumulate them, so be careful to always send the full set of plans.
  • If eligibility changes in your system, then you will need to update any and all employees, one-by-one, in the Nayya system to get things consistent.
  • Age rates are not included as rate parameters. Integrators should abstract away the age as a rate parameter because this endpoint assigns rates to a specific employee and the integrators already know the employee’s age.
  • All the e_#child rate keys should be provided for the given number and lower. For example if e_spouse_2child is provided then e_spouse_1child, e_1child and e_2child should also be provided. For more examples, see the example payloads.

Supported Grouping:

  • IndividualRateType: Life, LTD, STD, Critical Illness, Legal
  • FamilyGroupRateType: Medical, Dental, Vision, Accident, Hospital Indemnity, Pet, Identity Theft, Legal
Recipes
🦉
Decision Support API: Post Employee eligibility with Basic life free plan and Flat rate type
Open Recipe
🦉
Decision Support API: Post Employee Elibility with Voluntary life plan with Individual Grouping
Open Recipe
🦉
Decision Support API: Post eligibility for Critical Illness Plans with Individual Grouping
Open Recipe
🦉
Decision Support Api: Post Employee Eligibility for Accident plans with Family Grouping
Open Recipe
🦉
Decision Support Api: Post Employee Eligibility for Hospital Indemnity plans with Family Grouping
Open Recipe
Path Params
string
required

The unique ID from Nayya or your internal unique ID prefixed with the external: indicator that represents an employee (Ex. external:3438yht-hg8ht39-h23uh9th-uewht0o).

Body Params
data
array of objects
data
Responses

Response body
object
data
array of objects
data
object
string
required

Nayya's unique ID representing the plan this eligibility is attached to.

string | null
required

Your internal ID that represents this plan. If you are using our API with your internal IDs, this ID is required and you must use this ID any time you want to refer to this plan.

required
401

Unauthorized

404

Not Found

500

Internal Server Error

Language
Credentials
URL