Get Dependents

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

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

Employee's ID as it appears in WCA.

Min Length:	0
Max Length:	30

EmployeeSocialSecurityNumber string

Employee's current social security number.

Min Length:	0
Max Length:	30

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

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.
VerboseMode boolean

Response

array <object>

Address1 string

Dependent's address.
Address2 string

Second line of dependent's address, if needed.
BirthDate string

Dependent's birth date.
City string

City associated with dependent's address.
Country string

Country associated with dependent's address.
DependentSocialSecurityNumber string

Dependent's current social security number.
DependentId string

Dependent's ID as it appears in WCA.
DependentStatus enum<string>

Possible values: New Active TempInactive PermInactive Terminated Enrollment
EmployeeSocialSecurityNumber string

Employee's current social security number.

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

Dependent's middle initial.
NamePrefix string

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

Dependent's phone number including area code.
Relationship enum<string>

Possible values: SpouseorCommonLawSpouse DomesticPartner Child Other Unknown
State string

State associated with dependent's 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.
CardDesignId string
EligibilityDate string

Date upon which the dependent is eligible to elect benefits. YYYYMMDD format.
TerminationDate string

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