Get employee details

https://beta.api.wealthcare.com/participant/services/participant/employee/{tpaId}/{employerId}/{participantId}

Retrieve detailed information about a specific employee, including personal and contact details, banking information, and eligibility status. This endpoint is useful for applications that need to display or process employee data for benefits management or HR purposes.

Path parameters

tpaId string Required

A unique identifier used to identify your admin instance. This value is system generated when 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.
participantId string Required

Unique identifier for the participant whose features are being queried.

Header parameters

Accept-Language enum<string>

Specify the participant’s language preference for the response. The API will return text in the specified language, defaulting to English if not provided or if an invalid value is sent. Note that if a requested language (Spanish or French) lacks a translation for a specific field, the English value will be returned.

Possible values: es en fr

Query parameters

decrypt integer <int32>

Indicate if the URI parameters are encrypted or not. Use 1 for encrypted and 0 for decrypted; defaults to 0 if not specified.

Response

Prefix string

Title for employee, such as Mr., Mrs., Ms., Dr., or Rev
LastName string

Employee's last name.
FirstName string

Employee's first name.
MiddleInitial string

Employee's middle initial.
Phone string

Employee's phone number, including area code.
MobileNumber string

Employee's mobile phone number including area code.
AddressLine1 string

First line of the employee's mailing address.
AddressLine2 string

Second line of the employee's mailing address.
City string

City associated with the employee's mailing address.
State string

Two-character state code associated with the employee's mailing address.
Zip string

ZIP code associated with the employee's mailing address.
Country string

Country associated with the employee's mailing address, usually US.
ReimbursementMethod enum<string>

Reimbursement Method for reimbursing an employee or dependent.

Possible values: Undefined None Check DirectDeposit ExternalCheck ExternalDirectDeposit Card Payroll
Email string

Employee's email address.
UserDefinedField string

You can define this field. WCA does not use it.
EmployeeStatus enum<string>

Activity status for the employee.

Possible values: All New Active TempInactive PermInactive Terminated Enrollment
Gender enum<string>

Possible values: None Male Female
MaritalStatus enum<string>

Marital status of the employee.

Possible values: None Single Married Separated Widowed Divorced
ShippingAddressLine1 string

First line of the employee's shipping address.
ShippingAddressLine2 string

Second line of the employee's shipping address.
ShippingAddressCity string

City associated with an employee's shipping address.
ShippingAddressState string

The 2-character state code associated with the employee's shipping address.
ShippingAddressZip string

ZIP code associated with the employee's shipping address.
ShippingAddressCountry string

Country associated with the employee's shipping address.
BirthDate string

Employee's Date of birth.
BankRoutingNumber string

Bank Routing number of employee direct deposit account.
BankAccountNumber string

Employee's bank account number for direct deposit reimbursements.
BankAccountTypeCode enum<string>

Employee's bank account type.

Possible values: None Checking Savings GeneralLedger
BankName string

Bank Name of employee direct deposit account.
Remarks string

Any comments about the employee. Note: This is field is for information only.
EmployeeSSN string

Employee's social security number.
HealthPlanID string

An assigned ID for the employee's health plan. Note: You can use this field for TPS matching but cannot use it to search for an employee.
DentalID string

An assigned ID for the employee's dental plan. Note: You can use this field for TPS matching but cannot use it to search for an employee.
VisionID string

An assigned ID for the employee's vision plan. Note: You can use this field for TPS matching but cannot use it to search for an employee.
PBMID string

An assigned ID for the pharmacy benefits management (PBM) organization handling pharmaceutical benefits for employees. Note: You can use this field for TPS matching but cannot use it to search for an employee.
EligibilityDate string

Date when the employee was hired.
LastUpdated string <date-time>

Last date the employee demographic data was modified.
CardNumber string

Benefits Card number of the employee.
TerminationDate string

Employee's Date of Termination.
Division string

Division to which employee is assigned, if division functionality is in use.
EmployerName string

Name of employer for whom employee works.
HealthcareCoverageDefault string

Coverage ID that is associated with an employee's primary Healthcare Coverage. The employee will be linked to all healthcare coverage types—Medical, Pharmacy, Dental, Hospital, and Vision and/or Hearing copays—associated with this Healthcare Coverage option.
MedicalCoverage string

Coverage ID that is associated with the Medical Coverage type and links the employee to the copays for this coverage type.
PharmacyCoverage string

Coverage ID that is associated with the Pharmacy Coverage type and links the employee to the copays for this coverage type.
DentalCoverage string

Coverage ID that is associated with the Dental Coverage type and links the employee to the copays for this coverage type. Note 1: Providing a Coverage ID for Dental Coverage takes priority over the default Healthcare Coverage for this type. Note 2: The Coverage ID is required in order for employee-level co-pay amounts to be associated with this particular coverage.
HospitalCoverage string

Coverage ID that is associated with the Hospital Coverage type and links the employee to the copays for this coverage type.
VisionCoverage string

Coverage ID that is associated with the Vision Coverage type and links the employee to the copays for this coverage type.
HearingCoverage string

Coverage ID that is associated with the Hearing. Coverage type and links the employee to the copays for this coverage type.
HighDeductableHealthPlanEligible boolean

Flag indicating whether the employee is eligible for an High Deductible Health Plan. 0 = No 1 = Yes
DriverLicenceNumber string

Employee Driver's License Number.
MotherMaidenName string

Employee's mother's maiden name.
MedicareBeneficiary enum<string>

Indicates participant as a Medicare beneficiary.

Possible values: None PrimaryBeneficiary SecondaryBeneficiary
MedicareID string

This value is the active covered individual's/beneficiary's health insurance claim number.
ProcessingNotes string

This is the processing notes entered by the administrator for the specified individual.
PersonCode string

This code is used to identify specific individuals on a policy for Medicare Reporting. The values are established by the insurer. May also be known as a Dependent Code.
EndStageRenalDisease boolean

Indicates whether the participant has ESRD for Medicare Reporting. 0 = No, this person does not have ESRD 1 = Yes, this person has ESRD
CardReimbAvail boolean

If the Employer is eligible for Card and has got a CRA Plan, then True, Otherwise False.
ReimbursementMethodList array <object>

List of available reimbursement methods for employee to choose.
- ReimbursementMethod enum<string>
  
  Possible values: Undefined None Check DirectDeposit ExternalCheck ExternalDirectDeposit Card Payroll
- Description string
HoldDirectDepositPaymentsReason string

The reason for holding direct deposits from being paid out to the employee.