Add Employee

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

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

ValidateEmployeeAccount boolean
CarrierName string
MedicalDeductible number <double>
MedicalDeductiblePTD number <double>

Address1 string Required

First line of the employee’s mailing address.

Min Length:	0
Max Length:	55

Address2 string

Second line of the employee’s mailing address

Min Length:	0
Max Length:	55

BankAccount 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. If ReimbursementCode is set to DirectDeposit than this field is required.

Min Length:	0
Max Length:	17

BankAccountTypeCode enum<string>

Indicates the type of account sent in BankAccount. Cannot be None if ReimbursementCode is set to DirectDeposit.

Possible values: None Checking Savings GeneralLedger

BankRoutingNumber 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. If ReimbursementCode is set to DirectDeposit than this field is required.

Min Length:	0
Max Length:	9

BirthDate string <date-time>

Date of birth for the employee. Birth Date is not required for creating new employees, but is required prior to an employee enrolling in an HSA.

City string Required

City associated with employee’s mailing address.

Min Length:	0
Max Length:	30

Country string Required

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

Min Length:	0
Max Length:	3

EmailAddress string

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

Min Length:	0
Max Length:	75

EmployeeSocialSecurityNumber string

Employee’s social security number. In general, WCA requires SSN for employees is enrolled in an HSA account. Employee SSN is not required for creating new employees, but is required prior to an employee enrolling in an HSA. Validation logic prevents duplicate social security numbers from being entered within a family unit. For example, a dependent can't have the same SSN as the employee. Additionally, a dependent can't have the same SSN as another dependent.

Min Length:	0
Max Length:	9

FirstName string Required

Employee’s first name. Allowable characters are alphanumeric (a-z, A-Z, 0- 9), Special characters - comma (,), period (.), dash (-), ampersand (&), single apostrophe ('), and space ( ).

Min Length:	0
Max Length:	50

Gender enum<string>

Employee’s gender.

Possible values: None Male Female

LastName string Required

Employee’s last name. Allowable characters are alphanumeric (a-z, A-Z, 0-9), Special characters - comma (,), period (.), dash (-), ampersand (&), single apostrophe ('), and space ( ).

Min Length:	0
Max Length:	50

EmployeeMaritalStatus enum<string>

The employee's marital status.

Possible values: None Single Married Separated Widowed Divorced

MiddleInitial string

Employee’s middle initial name. Allowable characters are alphanumeric (a-z, A-Z, 0-9), Special characters - comma (,), period (.), dash (-), ampersand (&), single apostrophe ('), and space ( ).

Min Length:	0
Max Length:	1

NamePrefix string

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

Min Length:	0
Max Length:	5

Phone string

Employee’s phone number including area code.

Min Length:	0
Max Length:	30

ReimbursementCode enum<string>

Sets the employee's default reimbursement method. Check printing normally occurs in the administrator’s application and not in WCA.

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.

Min Length:	0
Max Length:	1400

ShippingAddress1 string

Address line 1 of the employee’s card shipping address if different from the mailing address. If included, than ShippingCity, ShippingState, ShippingZipCode, and ShippingCountry must also be included.

Min Length:	0
Max Length:	55

ShippingAddress2 string

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

Min Length:	0
Max Length:	55

ShippingCity string

Employee’s card shipping address if different from the mailing address. Required if the ShippingAddress1 field is included.

Min Length:	0
Max Length:	30

ShippingCountry string

Employee’s card shipping address if different from the mailing address. US is valid option. Please contact us if you intend to send to any international address. Required if the ShippingAddress1 field is included.

Min Length:	0
Max Length:	3

ShippingState string

Employee’s card shipping address if different from the mailing address. Use the appropriate 2 character state postal code associated with employee’s address. Please contact us if you intend to send to any international address. Required if the ShippingAddress1 field is included
ShippingZipCode string

Employee’s card shipping address if different from the above address. Required if the ShippingAddress1 field is included
State string Required

State code for the employee's mailing address. Use 2 character state or region postal code associated with employee’s address. Please contact us if you intend to send to any international address.

UserDefinedField string

Field defined by the administrator. This is not used by WCA

Min Length:	0
Max Length:	50

ZipCode string Required

Zip code of the employee's mailing address
CardDesignId string

For future use. Card design will currently always be payment.
EligibilityDate string <date-time>

Format is YYYYMMDD. Date upon which the employee is eligible to elect benefits.
TerminationDate string <date-time>

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

The employee’s drivers license number.
MaidenName string

The employee's mother’s maiden name.
EmailCommunicationOptions enum<string>

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

This field may be used to enter notes for claims processors

Min Length:	0
Max Length:	500

MobileNum string

Employee’s mobile phone number, including area code.

Min Length:	0
Max Length:	19

SMSCommunicationOptions enum<string>

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

AlternateId string

The employee’s Alternate ID

Min Length:	0
Max Length:	20

EmployeeMarketplaceGUID string

Used to identify the participant on the WealthCare Marketplace platform.

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.

Min Length:	0
Max Length:	30

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.

Min Length:	0
Max Length:	30

BankAcctName string

Employee’s Direct Deposit Bank Account Name.

Min Length:	0
Max Length:	50

UserDefinedField2 string