Search Employees

https://api.wealthcare.com/system/Services/Employee/{tpaId}/{employerId}/employeeId/Search

This operation will return a list of employees that match the entered search criteria.

Path parameters

tpaId string Required

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

Unique identifier for the employer. Note: When the employer was created, WealthCare Admin assigned the 3-character prefix; you assigned the remaining characters.

Request body

EmployeeId string

if using Employee ID as the identifier for which to look up an employee, use the employeeId query parameter. This field is not used.

EmployerId string

This field is not used. The Employer ID parameter will be used for the lookup.

Min Length:	0
Max Length:	18

TpaId string

This field is not used. The TpaId parameter will be used for the lookup.
VerboseMode boolean

Optional, if set to true, the operation may return more details as to why a query did not return any records. For example, if an invalid employee social security number was sent.
PageIndex integer <int32>

Page number for paginated result set. The maximum number of records per request/page is 100. You must submit a separate request for each page you wish to return. By making multiple requests, you can retrieve an unlimited number of records.

EmployeeSocialSecurityNumber string

Employee’s social security number. At least one of EmployeeSocialSecurityNumber, EmployeeID, FirstName, LastName, or CardNumber must be included on the request. EmployeeID, if used, is sent as a request parameter, not on the body.

Min Length:	0
Max Length:	9

FirstName string

First name of the employee. At least one of EmployeeSocialSecurityNumber, EmployeeID, FirstName, LastName, or CardNumber must be included on the request. EmployeeID, if used, is sent as a request parameter, not on the body.

Min Length:	0
Max Length:	50

LastName string

Last Name of the employee. At least one of EmployeeSocialSecurityNumber, EmployeeID, FirstName, LastName, or CardNumber must be included on the request. EmployeeID, if used, is sent as a request parameter, not on the body.

Min Length:	0
Max Length:	50

CardNumber string

Card Number. At least one of EmployeeSocialSecurityNumber, EmployeeID, FirstName, LastName, or CardNumber must be included on the request. EmployeeID, if used, is sent as a request parameter, not on the body.

Min Length:	0
Max Length:	50

Response

array <object>

EmprId string

Unique identifier for the employer. When the employer was created, WealthCare Admin assigned the 3-character prefix; you assigned the remaining characters.
FirstName string

Employee’s first name
Initial string

Employee’s middle initial
LastName string

Employee’s last name
NamePrefix string

Title of the employee, such as Mr., Mrs., Dr., Rev, etc
SocSecNum string

This is the employee ID, a unique identifier for the employee. While your administration may use social security numbers for the employee ID, this field is NOT necessarily a social security number.
TpaId string

A unique identifier for your administrator instance, generated by WCA when the instance was first set up.
CardholderStatus enum<string>

Employee status

Possible values: New Active TempInactive PermInactive Terminated Enrollment

AlternateId string

The employee’s alternate ID

Min Length:	0
Max Length:	20

EmpeSsn string

Employee’s social security number
CarrierName string
MedicalDeductible number <double>
MedicalDeductiblePTD number <double>