Overview

About our APIs | Administrative API Overview | Participant API Overview

About Alegeus APIs

Quickly build and launch your own custom experiences with Alegeus APIs.

Alegeus APIs are built around RESTful and SOAP web APIs. Our APIs allow your products to work in synchrony with WealthCare Admin, WealthCare Portal, and WealthCare Mobile, sharing real-time data between integrations.

Enhance your products with our APIs so that you can use your own tools for things like:

Automating back-office tasks
Onboarding new employees
Setting up plans
Reporting on plan performance
Creating unique mobile apps
And more!

Administrative API Overview

Use these APIs to embed WealthCare Admin (WCA) operations and data within your administrative platform. Administrative APIs, (sometimes referred to as System Integration or WCA APIs), are available in both REST and SOAP web services.

How they work

Our Administrative APIs are driven by your WCA settings. They do not utilize your participant portal or mobile configurations.

For example, if you use the Administrative API for Get Employee Accounts, and have enabled 'Hide accounts in Permanently Inactive status on the portal/mobile?' in WCA, the API response would not hide permanently inactive accounts, as this setting applies to your participant portal and mobile products.

Capabilities

Here are a few examples of how the Administrative APIs can be utilized:

Automating the creation of employers when your external CRM (such as Salesforce) has a customer enter a certain status
Synchronizing employee demographics between two platforms

See Administrative APIs

Participant API Overview

Use these APIs to embed WealthCare Portal (WCP) and Mobile (WCM) functionality. You can use them to build or expand your own member portal, mobile app or IVR. Participant APIs are available as REST web services.

How they work

The following dictate what a user is allowed to do:

User’s role in WealthCare Admin (WCA)
WCA admin-level self-service options
WCA employer-level participant web and mobile self-service

For example, a participant user can call the Participant Account API but is only able to get data on themselves. An employer user can use the same API to get data on any employee in their organization. A TPA user can use this API to get data on any employee within the TPAs employers.

WCA Configuration

Here are a few examples of how WCA configurations drive the Participant APIs:

Custom plan descriptions and custom field names, if defined in WCA, will be used in your API responses.
If an employer enables 'Do you want to allow employees to update their email address?' in WCA, your API response for GetUserInfo will indicate that this employer's participants have permission to update their email address.
If you enable 'Hide accounts in Permanently Inactive status on the portal/mobile? in WCA, permanently inactive accounts will be hidden from participants when the Get Account Summary API is called

See Participant APIs