Participant APIs | REST

Version:
Download Open API Specification

Add a dependent

https://api.wealthcare.com/participant/services/participant/dependent/adddependent

This operation allows you to set up both Dependent Demographics, a Dependent Account, and issue the dependent a card.

  • decrypt integer <int32>

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

  • DependentPrivacy boolean

    Use to enable or disable dependent privacy.|0 = Disabled/none (default)|1 = Confidential privacy status|2 = Custom privacy status|Note: If a value of 2 is submitted, the custom privacy ID field is required

  • 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

    Date of birth for the dependent. Note: If Medicare Beneficiary Option is populated, this field is conditionally required.

  • CardDesignID string

    Card design associated with a Dependent:1 = Payment Card

  • CardNumber string

    Benefits Card number of the Dependent.

  • DependentID string

    Unique identifier for the Dependent.

  • DependentSSN string

    Dependent’s social security number.|Note 1: You can use this field for TPS matching but cannot use it to search for a dependent.|Note 2: Validation logic prevents duplicate social security numbers from being entered within a family unit. For example, a dependent can't have the same SSN as the employee. Additionally, a dependent can't have the same SSN as another dependent.

  • EligibilityDate string

    Date upon which the Dependent is eligible to elect benefits. Date provided must be prior to the termination date. With WealthCare Admin 5.0, Card (POS) authorizations will use this date if populated. The dependent is considered eligible on 12:00:01 am CT on the date of eligibility. Card Authorization requests prior to the eligibility date will be denied. If no date is provided, then the dependent is assumed to be eligible. You may optionally enforce this date upon submission of a manual claim. WealthCare Admin will deny the claim if the date of service is prior to the eligibility date. If enforcing eligibility dates, Claims entered for a dependent must be within the Dependent and Employee’s eligibility dates.

  • 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.