Employee Flow

The Employee Flow is a stateful, pre-built UI you can show to employees who will enroll/waive in benefits in your application.

This Flow encapsulates the end-to-end employee annual benefits lifecycle:

1. (Pre) Open Enrollment
2. Open Enrollment
3. (Post) Open enrollment
4. QLE / Mid-year changes

Usage

To show the employee flow, first make a POST to the employee flow endpoint

POST /flows/employee

Request params:

• employer_id - The ID of the employer within your system (string)
• employee_id - The ID of the employee within your system (string)

The response will contain the URL of the Employee Flow that you can show in an iFrame.

<iframe src="{{url}}" />

Sample code

Request

curl -X POST {{API_BASE_URL}}/flows/employee \
  -H "Authorization: Bearer {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
    "employer_id": "34590",
    "employee_id": "94834"
  }'

Response

{
	url: "https://embed.benbase.com/employee?otp=123"
}

iFrame

<iframe src="https://embed.benbase.com/employee?otp=123" />