Eligibility concepts

Eligibility API keeps your employee roster in sync so onboarding and offboarding stay current.

Eligibility identifier

Employees are identified by an Eligibility Identifier. The identifier is defined in your contract and can be based on:

  • Email
  • National ID
  • Employee ID

Only the primary identifier is required in API calls. Supporting identifiers can be stored but are optional.

Security note: Some characters may be blocked in path parameters to prevent path traversal. If you receive a validation error, try encoding or omitting special characters.

Entities

When interacting with Wellhub's API, an access may handle one or more companies simultaneously. For that, it is important to understand what kind of entity the developer is dealing with. The available entity types are:

  • Single Entity: Manages a single company;
  • Multi Entity: Manages multiple companies;
  • Channel Partner: Manages multiple companies;