Get Employee

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

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.
employeeId string Required

Unique identifier for the employee.

Request body

EmployeeId string

this field is not used; the operation will use the employee ID sent on the request path.

EmployerId string

this field is not used; the operation will use the employer ID sent on the request path

Min Length:	0
Max Length:	18

TpaId string

this field is not used; the operation will use the TPA ID sent on the request path

EmployeeSocialSecurityNumber string

this field is not used; the operation uses the employee ID sent on the request path to find the correct employee.

Min Length:	0
Max Length:	9

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.
CardNumber string

this field is not used; the operation uses the employee ID sent on the request path to find the correct employee.
EmployeeMarketplaceGUID string

this field is not used; the operation uses the employee ID sent on the request path to find the correct employee.

Response

Addr1 string

First line of the employee’s mailing address.
Addr2 string

Second line of the employee’s mailing address
BankAcctNum string

Employee bank account number for direct deposit reimbursements. This field can be included in a direct deposit file exported from the system. Due to NACHA requirements, if using direct deposit do not enter a value greater than 17 characters.
BankAcctTypeCde enum<string>

indicates the type of account represented in BankAcctNum.

Possible values: None Checking Savings GeneralLedger
BankRoutingNum string

Employee's bank account routing number for direct deposit reimbursements. This field can be included in a direct deposit file exported from the system.
BirthDte string <date-time>

Date of birth for the employee.
City string

City associated with employee’s address.
CountryCde string

US is the only valid option. Please contact us if you intend to send to any international address.
EmailAddr string

Employee’s email address. Email addresses are automatically converted by WCA to all lowercase.
EmpeSsn string

Employee’s social security number.
SocSecNum string

Employee ID, a uniue identifier for the employee. While your administrator may use social security numbers for employee IDs, this is not necessarily a social security number.
CardholderStatusCde enum<string>

Employee status

Possible values: New Active TempInactive PermInactive Terminated Enrollment
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
Gender enum<string>

Employee’s gender.

Possible values: None Male Female
LastName string

Employee’s last name
MaritalStatus enum<string>

The employee's marital status.

Possible values: None Single Married Separated Widowed Divorced
Initial string

Employee’s middle initial.
NamePrefix string

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

Employee’s phone number including area code.
ReimbCde enum<string>

The employee's default reimbursement method.

Possible values: None Check DirectDeposit ExternalCheck ExternalDirectDeposit Card
Remarks string

Any comments about the employee. This is field is for information only and is not used in any WCA processing.
ShipAddr1 string

Address line 1 of the employee’s card shipping address if different from the mailing address.
ShipAddr2 string

Employee’s card shipping address if different from the mailing address
ShipCity string

Employee’s card shipping address if different from the mailing address.
ShipCountryCde string

Employee’s card shipping country if different from the mailing address
ShipState string

Employee’s card shipping address state if different from the mailing address.
ShipZip string

Employee’s card shipping address zip code if different from the above address.
State string

State code for the employee's mailing address.
TpaId string

A unique identifier for your administrator instance, generated by WCA when the instance was first set up.
UserField1 string

Field defined by administrator user. Not used by WCA
Zip string

Zip code associated with the employee's mailing address
CardDesignId string

Future use only. Only valid value today is "Payment"
EligDte string

Date upon which the employee is eligible to elect benefits.
TermDte string

Date upon which the employee's account is no longer eligible for benefits. Date must be after Account Effective date.
DriversLicense string

The employee’s drivers license number
MaidenName string

The employee mother’s maiden name
EmailCommunicationOptions enum<integer>

An enum indicating what email communications the employee is opted into. A 0 indicates an opt-out of all messages.

Possible values: Manual Claim Entered Participant Shipping Address Change Participant Email Address Change Participant Direct Deposit Change Participant Portal Password Change Participant Billing Address Change Card Mailed Card Lost/Stolen Card Transaction Denied Account Balance Alert Account Deductible Met Run Out Date Reminder Year-End Reminder Grace Period Reminder Balance Statement Alert User ID Change Participant Claim Entry Deposit Received HSA Online Statement Enrollee Welcome Email Email Communication Template Completed HSA Payment Failed HSAPayment Card Transaction Approved Reimbursement Processed Partner Welcome Email Partner Billing Address Change Partner Shipping Address Change Partner Employee Email Address Change Partner Password Change Partner User ID Change Partner HSA Online Statement Partner Deposit Received Partner External Account Updated Partner Email Communication Template Partner IRS Contribution Limit Partner Account Closed Partner Account Re-Associated Partner Online Enrollment All Communications
ProcessingNotes string

Notes entered for the employee to be used by claims processors.
MobileNum string

Employee's mobile phone number, including area code
Pan string

WCA-generated key used for text message functionality.
SMSCommunicationOptions enum<integer>

An enum indicating what mobile communications the employee is opted into. A 0 indicates an opt-out of all messages.

Possible values: Manual Claim Entered Participant Shipping Address Change Participant Email Address Change Participant Direct Deposit Change Participant Portal Password Change Participant Billing Address Change Card Mailed Card Lost/Stolen Card Transaction Denied Account Balance Alert Account Deductible Met Run Out Date Reminder Year-End Reminder Grace Period Reminder Balance Statement Alert User ID Change Participant Claim Entry Deposit Received HSA Online Statement Enrollee Welcome Email Email Communication Template Completed HSA Payment Failed HSAPayment Card Transaction Approved Reimbursement Processed Partner Welcome Email Partner Billing Address Change Partner Shipping Address Change Partner Employee Email Address Change Partner Password Change Partner User ID Change Partner HSA Online Statement Partner Deposit Received Partner External Account Updated Partner Email Communication Template Partner IRS Contribution Limit Partner Account Closed Partner Account Re-Associated Partner Online Enrollment All Communications
BankAcctName string

Direct Deposit Bank Account Name
HealthPlanId string

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

Used to identify the participant on the WealthCare Marketplace platform.
PbmId string

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

The employee’s Alternate ID
EmpeLevelUserDefinedFieldValue2 string

Field defined by administrator. Not used by WCA.
EmpeLevelUserDefinedFieldValue3 string

Field defined by administrator. Not used by WCA.
EmpeLevelUserDefinedFieldValue4 string

Field defined by administrator. Not used by WCA.
EmpeLevelUserDefinedFieldValue5 string

Field defined by administrator. Not used by WCA.
EmpeLevelUserDefinedFieldValue6 string

Field defined by administrator. Not used by WCA.
EmpeLevelUserDefinedFieldValue7 string

Field defined by administrator. Not used by WCA.
EmpeLevelUserDefinedFieldValue8 string

Field defined by administrator. Not used by WCA.
EmpeLevelUserDefinedFieldValue9 string

Field defined by administrator. Not used by WCA.
EmpeLevelUserDefinedFieldValue10 string

Field defined by administrator. Not used by WCA.
IsOnlineRepaymentDisabled boolean

Indicates if online repayments are disabled for the employee. False/0 – Online repayments are available for this employee. True/1 – Online repayment is disabled for this employee
CarrierName string

The name of the employee’s medical insurance carrier.
MedicalDeductible number <double>

The annual deductible for this employee’s medical insurance.
MedicalDeductiblePTD number <double>

The amount the employee has paid toward his deductible in the current plan year.