Participant APIs | REST

Version:
Download Open API Specification

Update Dependent Details

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

Update Dependent Details

Path parameters

Path parameters page anchor
  • 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

  • dependentId string Required

    Unique identifier for the Dependent.

Header parameters

Header parameters page anchor
  • 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

Query parameters page anchor
  • decrypt integer <int32>

    Indicate if the URI parameters are encrypted or not. 1: encrypted, 0: decrypted, default to 0.

Request body

Request body page anchor
  • Prefix string

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

  • LastName string

    Last name of Dependent.

  • FirstName string

    First name of Dependent.

  • MiddleInitial string

    Middle initial of Dependent.

  • Phone string

    Dependent’s Phone number, including area code.

  • AddressLine1 string

    First line of the Dependent’s mailing address.

  • AddressLine2 string

    Second line of the Dependent’s mailing address.

  • City string

    City associated with the Dependent’s mailing address.

  • State string

    State associated with the Dependent’s mailing address.

  • Zip string

    Zip code associated with the Dependent’s mailing address.

  • Country string

    Country associated with the Dependent’s mailing address.

  • DependentStatus enum<string>

    Activity status for the Dependent: 0 = All, 1 = New, 2 = Active, 3 = TempInactive, 4 = PermInactive, 5 = Terminated,6 = Enrollment

    Possible values: All New Active TempInactive PermInactive Terminated Enrollment
  • Gender enum<string>

    Gender of the Dependent : 0 = None,
    1 = Male, 2 = Female

    Possible values: None Male Female
  • ShippingAddressLine1 string

    First line of the Dependent’s shipping address.

  • ShippingAddressLine2 string

    Second line of the Dependent’s shipping address.

  • ShippingAddressCity string

    City associated with a Dependent’s shipping address.

  • ShippingAddressState string

    State associated with a Dependent’s shipping address.

  • ShippingAddressZip string

    Zip code associated with a Dependent’s shipping address.

  • ShippingAddressCountry string

    Country associated with a Dependent’s shipping address.

  • BirthDate string

    Birth date of Dependent.

  • CardDesignID string

    Card design associated with a Dependent: 1 = Payment Card 2 = Combo Card

  • CardNumber string

    Benefits Card number of the Dependent.

  • DependentID string

    Unique identifier for the Dependent.

  • DependentSSN string

    Social Security Number of Dependent.

  • EligibilityDate string

    Date from when Dependent become eligible.

  • EmployeeID string

    Unique identifier for the Employee to which Dependent is added to.

  • EmployeeSSN string

    Social Security Number of Employee.

  • FullTimeStudent boolean

    Indicated that the Dependent is a FullTimeStudent or Not. 0 = No, this person is not full time student. 1 = Yes, this person is full time student.

  • HealthPlanID string

    An assigned ID for the Dependent’s health plan.

  • LastUpdated string <date-time>

    Last date the Dependent demographic data was modified.

  • PBMID string

    An assigned ID for the Pharmacy Benefits Management (PBM) organization handling pharmaceutical benefits for Dependents.

  • Relationship enum<string>

    Indicated relation of Dependent to Employee. 0 = Unknown, 1 = SpouseorCommonLawSpouse, 2 = Child, 3 = DomesticPartner, 4 = Other

    Possible values: Unknown SpouseorCommonLawSpouse Child DomesticPartner Other
  • TerminationDate string

    Termination Date of Dependent.

  • MedicareBeneficiary enum<string>

    Indicates Participant as a Medicare beneficiary.

    Possible values: None PrimaryBeneficiary SecondaryBeneficiary
  • MedicareID string

    This value is the active covered individual’s/beneficiary’s health insurance claim number.

  • PersonCode string

    This code is used to identify specific individuals on a policy for Medicare Reporting. The values are established by the insurer. May also be known as a Dependent Code.

  • EndStageRenalDisease boolean

    Indicates whether the Dependent has ESRD for Medicare Reporting. 0 = No, this person does not have ESRD. 1 = Yes, this person has ESRD.

  • TpaId string

    Unique identifier assigned by WealthCare Admin.

  • EmprId string

    Unique identifier for the Employer.

  • IssueDependentCard boolean

    Indicated that the Dependent is issued with a Card other than Employee one. 0 = No, this person not issued with a card. 1 = Yes, this person is issued with card.

  • FlexAcctIds array <string>

    Unique Id to account associated with Dependents.

Response

Response page anchor
  • Prefix string

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

  • LastName string

    Last name of Dependent.

  • FirstName string

    First name of Dependent.

  • MiddleInitial string

    Middle initial of Dependent.

  • Phone string

    Dependent’s Phone number, including area code.

  • AddressLine1 string

    First line of the Dependent’s mailing address.

  • AddressLine2 string

    Second line of the Dependent’s mailing address.

  • City string

    City associated with the Dependent’s mailing address.

  • State string

    State associated with the Dependent’s mailing address.

  • Zip string

    Zip code associated with the Dependent’s mailing address.

  • Country string

    Country associated with the Dependent’s mailing address.

  • DependentStatus enum<string>

    Activity status for the Dependent: 0 = All, 1 = New, 2 = Active, 3 = TempInactive, 4 = PermInactive, 5 = Terminated,6 = Enrollment

    Possible values: All New Active TempInactive PermInactive Terminated Enrollment
  • Gender enum<string>

    Gender of the Dependent : 0 = None,
    1 = Male, 2 = Female

    Possible values: None Male Female
  • ShippingAddressLine1 string

    First line of the Dependent’s shipping address.

  • ShippingAddressLine2 string

    Second line of the Dependent’s shipping address.

  • ShippingAddressCity string

    City associated with a Dependent’s shipping address.

  • ShippingAddressState string

    State associated with a Dependent’s shipping address.

  • ShippingAddressZip string

    Zip code associated with a Dependent’s shipping address.

  • ShippingAddressCountry string

    Country associated with a Dependent’s shipping address.

  • BirthDate string

    Birth date of Dependent.

  • CardDesignID string

    Card design associated with a Dependent: 1 = Payment Card 2 = Combo Card

  • CardNumber string

    Benefits Card number of the Dependent.

  • DependentID string

    Unique identifier for the Dependent.

  • DependentSSN string

    Social Security Number of Dependent.

  • EligibilityDate string

    Date from when Dependent become eligible.

  • EmployeeID string

    Unique identifier for the Employee to which Dependent is added to.

  • EmployeeSSN string

    Social Security Number of Employee.

  • FullTimeStudent boolean

    Indicated that the Dependent is a FullTimeStudent or Not. 0 = No, this person is not full time student. 1 = Yes, this person is full time student.

  • HealthPlanID string

    An assigned ID for the Dependent’s health plan.

  • LastUpdated string <date-time>

    Last date the Dependent demographic data was modified.

  • PBMID string

    An assigned ID for the Pharmacy Benefits Management (PBM) organization handling pharmaceutical benefits for Dependents.

  • Relationship enum<string>

    Indicated relation of Dependent to Employee. 0 = Unknown, 1 = SpouseorCommonLawSpouse, 2 = Child, 3 = DomesticPartner, 4 = Other

    Possible values: Unknown SpouseorCommonLawSpouse Child DomesticPartner Other
  • TerminationDate string

    Termination Date of Dependent.

  • MedicareBeneficiary enum<string>

    Indicates Participant as a Medicare beneficiary.

    Possible values: None PrimaryBeneficiary SecondaryBeneficiary
  • MedicareID string

    This value is the active covered individual’s/beneficiary’s health insurance claim number.

  • PersonCode string

    This code is used to identify specific individuals on a policy for Medicare Reporting. The values are established by the insurer. May also be known as a Dependent Code.

  • EndStageRenalDisease boolean

    Indicates whether the Dependent has ESRD for Medicare Reporting. 0 = No, this person does not have ESRD. 1 = Yes, this person has ESRD.

  • TpaId string

    Unique identifier assigned by WealthCare Admin.

  • EmprId string

    Unique identifier for the Employer.

  • IssueDependentCard boolean

    Indicated that the Dependent is issued with a Card other than Employee one. 0 = No, this person not issued with a card. 1 = Yes, this person is issued with card.

  • FlexAcctIds array <string>

    Unique Id to account associated with Dependents.

Copyright © 2025 Alegeus Technologies, LLC. All rights reserved. Alegeus, Alegeus Technologies, WealthCare, WealthCare Saver are registered trademarks of Alegeus Technologies, LLC