Eligibility Flow
The Eligibility flow manages which employees in your organization are eligible to access Wellhub's benefits platform. As a business-to-business company, Wellhub only provides its services to employees of subscribing companies, and all integration processes begin with establishing and maintaining employee eligibility.
This page describes the eligibility flow at a conceptual level. For implementation details, see the integration-specific guides linked at the bottom of this page.
What Is Eligibility?
An eligible is an employee record that has been submitted to Wellhub and grants that employee access to the platform. Eligibility management is the process of keeping these records accurate and up to date as your workforce changes.
Supported Operations
Loading diagram...
How these operations are expressed depends on the integration technology. For file-based integrations (SFTP), they map to specific submission types (full file, newcomers, leavers). For API integrations, they map to specific endpoint calls. See the guides under Implement This Flow for details.
Data Model
Each eligibility record is made up of the standard Wellhub employee attributes. See the Wellhub Data Model in the Glossary for the full field reference.
Eligibility Identifiers
Each employee is uniquely identified in Wellhub by an Eligibility Identifier. The identifier is defined in your contract and can be based on one or more of the following attributes:
- National ID
- Employee ID
- Mobile Number
When multiple attributes compose an Eligibility Identifier, all of them are required in eligibility requests or files. Supporting identifiers (those that do not compose the Eligibility Identifier) can be stored but are optional.
Examples:
- In API jobs, the eligibility identifier must be present in the job item creation payload.
- In SFTP files, the eligibility identifier must be present in the file header and in every data row.
Some characters may be blocked or normalized in technical channels (for example, URL paths, query parameters, or file names) to prevent security issues such as path traversal. If you receive a validation or processing error related to an identifier, try encoding or omitting special characters, and coordinate with your Wellhub contact if you need to use a specific format.
Implement This Flow
The eligibility flow is supported by the following integration technologies. Select the one that matches your setup:
- Eligibility via REST API — Real-time, programmatic eligibility management
- Eligibility via SFTP — Batch file-based eligibility management