Get list of an employee's dependent

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

Retrieve a list of dependents associated with a specific employee, identified by their unique TPA ID, Employer ID, and Participant ID. This endpoint is useful for obtaining detailed information about an employee's dependents, including their names and relationships.

Request

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 user whose feature information is being retrieved.

Header parameters

Accept-Language enum<string>

Specify the participant’s language preference for the response. Valid values are "es" for Spanish, "en" for English, and "fr" for French. If not specified or if an invalid value is sent, the response will default to English. Note that if a requested field lacks a translation, 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, 0 for decrypted (default is 0). This affects how the API interprets the incoming identifiers.
ageRestrict integer <int32>

An optional parameter that restricts the returned dependents' ages to those greater than the specified value. Defaults to -1, which indicates no age restriction.

Response

Response body

array <object>
- TpaId string
  
  A unique identifier used to identify your admin instance. This value was system generated with the admin instance was created.
- EmprId string
  
  Unique identifier for the employer. Note: When an employer is created, WealthCare Admin assigns the 3-character prefix; you assign the remaining characters.
- DepId string
  
  Unique identifier for the dependent
- FirstName string
  
  The full first name of the dependent
- LastName string
  
  The full last name of the dependent
- MiddleInitial string
  
  The middle initial of the dependent. This will be an empty string if no middle initial exists.
- NamePrefix string
  
  Name Prefix of the dependent. If populated, valid values are Mr., Mrs., Ms., Dr., Rev.
- EmpeId string
  
  The Employee ID of the employee the dependent is associated with.
- EmpeFullName string
  
  This is the full name of the employee the dependent is associated with. The format is “{Last Name}, {First Name} {Middle Initial}”
- Relationship enum<string>
  
  Indicated relation of Dependent to Employee.
  
  Possible values: Unknown SpouseorCommonLawSpouse Child DomesticPartner Other
- DependentStatus enum<string>
  
  Activity status for the dependent
  
  Possible values: All New Active TempInactive PermInactive Terminated Enrollment

Participant APIs | REST