Nayya seamlessly integrates into your existing user flow, providing intelligent decision support that guides employees towards the optimal benefits selections. By handing off to Nayya at a strategic point in your platform, you enable users to explore personalized plan recommendations. Your platform then retrieves these selections, creating a streamlined experience that facilitates informed choices for employees and their families.

Integrating Nayya is a straightforward process, involving three key steps:

1. Entity Mapping: Align your system's data structures with Nayya's entities (employers, employees, benefits, and snapshots). This ensures accurate data transfer and personalized recommendations.
2. Configuration via API Requests: Utilize our API to configure employers, employees, benefits, and snapshots within Nayya. This step establishes the necessary context for personalized decision support.
3. Embedded User Experience: Embed Nayya's user interface directly into your platform, providing a seamless transition for users as they explore their benefit options.

Step One: Mapping Entities

Nayya's entities are relatively basic and match up well with most benefit admin platforms.

Every POST request will return a response with the ID or IDs of the entities you created. If you are using external IDs, they will be included in the response. External IDs can be used for subsequent requests instead of Nayya IDs. It is a best practice for Partners to store the Nayya ID in their system alongside the external ID even if the external ID is used to make requests.

Note: We do not recommend passing a combination of External and Nayya IDs.

Here is the list of entities that you'll need to plan for:

• Employer
• Benefit
• Employee
• Snapshots

Step Two: Configuration

You will need an API key to begin making the requests required to configure data for employer groups. You can request a Client and Secret from Nayya’s Client Solutions team which will allow you to create an API key using our Get a Token endpoint.

Note: All of our endpoints allow for the creation of a single entity at a time.

Employers

To get started, you will need to create employers where your Employees and Benefits will live. You can create an employer using the Create an Employer endpoint.

This will return a 201 with the Nayya ID (If you passed an external ID, you will also receive this in the response). You will need the Nayya ID or External ID to access the majority of the other endpoints you will need to hit.

Benefits

Next, we will create benefits for this employer. You can create a Benefit using the Create or update a benefit endpoint.

This will return a 201 with the Nayya benefit ID (If you passed an external Benefit ID, you will also receive this in the response).

Note: the Create or update a benefit endpoint is the most robust endpoint in our API and it is also the most flexible. Please review our Creating a Benefit guide for a more detailed walkthrough of this endpoint.

Along with creating benefits, you may need to create benefit dependencies. Benefit dependencies will define a relationship between a parent and child benefit. You have the option to ensure that an employee must enroll in, must not enroll in, or must enroll in one of the benefits that you provide. You can create benefit dependencies using the Add Benefit Dependencies to Benefit endpoint

Employees

After creating employers and benefits, the next step is to create employees and dependents. You can create an employer using the Create an Employee endpoint.

This will return a 201 with the Nayya ID (If you passed an external ID, you will also receive this in the response).

Note: if there are no dependents, the API supports receiving an empty dependents array

Snapshots

Snapshots will allow you to specify which benefits an employee is eligible for and the rates and benefit amounts associated with a specific benefit. Snapshots support grouped rates and individual rates by configuring ratePackages. Partners can define rate packages with a specific External ID. In the ratePackage, partners can leverage Rate Package dependencies to configure individual rates.

Just-in-Time Deployment

Most partners will leverage Just-in-Time(JIT) deployment when making their Employee, Dependent, and Snapshot requests. This will ensure that the data used in Nayya is up-to-date. Partners will typically select the point right before the employee transitions to Choose to make these just-in-time requests.

For embedded partners, The Employee, Dependent, and Snapshot requests should be sequenced in the following order for a user's first visit:

• Create an Employee request
• 201 Response from Create an Employee
• Create a Dependent request
• 201 Response from Create a Dependent
• Create a Snapshot request
• 201 Response from Create a Snapshot (A new snapshot should be sent each time the user is directed to choose, even if the Employee and Dependents exist)
• User redirected to Choose iframe

Note: Users should NOT be redirected to Choose until after a successful 201 response is received from the Create a Snapshot request. This will ensure that incomplete or outdated information is not sent to Choose