API Details - Alegeus Developer Portal

Search employees

https://qa.api.wealthcare.com/participant/services/participant/employee/{tpaId}

Search Employees - Includes employer ID, criteria to search for, criteria to search by, and the ability to exclude permanently inactive employers.

tpaId string Required

A unique identifier used to identify your admin instance. This value was system generated with the admin instance was created.

Accept-Language enum<string>

Specify the participant’s language preference. The corresponding response will then return text/string values in the language specified, defaulting to English if not specified or if an invalid value is sent. Note: If Spanish or French is requested and a particular field does not have a translated value (Spanish or French), then the English text value will be returned.

Possible values: es en fr

decrypt integer <int32>

Indicate if the URI parameters are encrypted or not. 1: encrypted, 0: decrypted, default to 0.

ExcludePIEmpr boolean

Send true to exclude employees under an employer in a Permanently Inactive status. Send false to include employees under an employer in a Permanently Inactive status.
EmprId string

Specify the unique Employer ID generated by WealthCare Admin if the employer is known, or use an empty string to search all employers
SearchBy enum<string>

Used with the SearchFor value. Specifies what type of data is sent in SearchFor. I.e., if a 3 is sent here, then the value sent in SearchFor will be compared to LastName values of employees in the system to determine what employees will be returned.

Possible values: SocSecNum FirstName LastName FirstLastName SSN CardNumber EmailAddress HealthId PBMId Address1 PhoneNumber PPAccountNumber AlternateId CardProxyNumber MobileNumber
SearchFor string

Used with the SearchBy field. This is the value actually being searched for.
MaxRecords integer <int32>

The maximum number of records to include in the response. Minimum value is 1; maximum value is 999,999.
StartOrdinal integer <int32>

This can be used if searches are being completed in batches. Minimum value is 1; maximum value is 999,999. For example, if you want to only handle 25 results at a time, you would send 1 for this value on the first call (and 25 for MaxRecords), and if/when the next 25 are needed, send 26 for this value on the second call (and still send 25 for MaxRecords) in order to get results 26-50.