Participant APIs | REST

Version:

Download Open API Specification

Get list of an employee's dependent

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

Get list of an employee's dependent

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

Participant Id

Header parameters

Accept-Language enum<string>

Specify the participant’s language preference. The corresponding response will then return text/string values in the language specified, defaulting to English if not specified or if an invalid value is sent. Note: If Spanish or French is requested and a particular field does not have a translated value (Spanish or French), then the English text value will be returned.

Possible values: es en fr

Query parameters

decrypt integer <int32>

Indicate if the URI parameters are encrypted or not. 1: encrypted, 0: decrypted, default to 0.
ageRestrict integer <int32>

An optional parameter with default to -1 but if value provided greater than 0 then restricts dependents' age by this number

Response

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