Add Dependent

https://api.wealthcare.com/system/Services/Employee/Dependent/{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

Address1 string

Dependent's address.

Min Length:	0
Max Length:	55

Address2 string

Second line of dependent’s address if needed.

Min Length:	0
Max Length:	55

BirthDate string <date-time>

Date of birth for dependent.

City string

City associated with dependent's address.

Min Length:	0
Max Length:	30

Country string

Country associated with dependent's address. US is a valid option. Please contact us if you intend to send to any international address.

Min Length:	0
Max Length:	3

DependentId string

Dependent's ID as it appears in WCA.

Min Length:	0
Max Length:	30

DependentSocialSecurityNumber string

Dependent's current social security number.

Min Length:	0
Max Length:	9

EmployeeId string

Employee's ID as it appears in WCA.

Min Length:	0
Max Length:	30

EmployeeSocialSecurityNumber string

Dependent's current social security number.

Min Length:	0
Max Length:	9

DependentStatus enum<string>

Possible values: New Active TempInactive PermInactive Terminated Enrollment

EmployerId string

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

Min Length:	0
Max Length:	18

FirstName string

Dependent's first name.

Min Length:	0
Max Length:	50

FullTimeStudent boolean

Indicates if the dependent is a full time student.
Gender enum<string>

Possible values: None Male Female

LastName string

Dependent's last name.

Min Length:	0
Max Length:	50

MiddleInitial string

Dependent's middle initial.

Min Length:	0
Max Length:	1

NamePrefix string

Dependent's name prefix. Examples are Mr., Mrs., Dr., etc.

Min Length:	0
Max Length:	5

Phone string

Dependent's phone number including area code.

Min Length:	0
Max Length:	30

Relationship enum<string>

Possible values: SpouseorCommonLawSpouse DomesticPartner Child Other Unknown

ShippingAddress1 string

Dependent's shipping address if different from the above address as to where the card should be sent. If included, then ShippingCity, ShippingState, ShippingZipCode, and ShippingCountry must also be included.

Min Length:	0
Max Length:	55

ShippingAddress2 string

Second line of dependent's shipping address, if needed.

Min Length:	0
Max Length:	55

ShippingCity string

City associated with dependent's shipping address.

Min Length:	0
Max Length:	30

ShippingCountry string

Country associated with dependent's shipping address.

Min Length:	0
Max Length:	3

ShippingState string

State associated with dependent's shipping address.
ShippingZipCode string

Zip code associated with dependent's shipping address.
State string

State code associated with the dependent's 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.
TpaId string

A unique identifier for your administrator instance, generated by WCA when the instance was first set up. If a value is not sent, the TPA ID from the user making the request with be used.
ZipCode string

Zip code associated with dependent's address.
EligibilityDate string <date-time>

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

Date upon which the dependent’s account is no longer eligible for benefits. Date must be after dependent account effective date. YYYYMMDD format.
DependentPrivacy enum<string>

Used to enable or disable dependent privacy.

Possible values: None Confidential Custom
CustomPrivacyOptionID string

A unique identifier for the custom privacy statuses created. If dependent privacy is none or confidential, leave this field blank. If dependent privacy is set to custom, this field is required.
AuthorizedContactEnabled boolean

Indicates the existence of an authorized contact for the dependent.

AuthorizedContactName string

Name of the dependent’s authorized contact. May include first and last in same field.

Min Length:	0
Max Length:	50

AuthorizedContactCode string

Password to be verified when dependent’s authorized contact calls on behalf of the dependent.

Min Length:	0
Max Length:	20

AlternateAddress1 string

First line of dependent's alternate address.

Min Length:	0
Max Length:	75

AlternateAddress2 string

Second line of dependent's alternate address, if needed.

Min Length:	0
Max Length:	75

AlternateCity string

City associated with dependent's alternate address.

Min Length:	0
Max Length:	30

AlternateState string

State associated with dependent's alternate address.

Min Length:	0
Max Length:	10

AlternateZip string

Zip code associated with dependent's alternate address.

Min Length:	0
Max Length:	15

AlternateCountry string

Country associated with dependent's alternate address.

Min Length:	0
Max Length:	3

AlternatePhone string

Alternate phone number for dependent with area code included.

Min Length:	0
Max Length:	20