Participant APIs | REST

Version:
Download Open API Specification

Search dependent

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

Search dependent

  • tpaId string Required

    A unique identifier used to identify your admin instance. This value was system generated with the admin instance was created.

  • decrypt integer <int32>

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

  • EmprId string

    Specify the employerID for the employer or an empty string to search all employers

  • SearchBy enum<string>

    Search criteria

    Possible values: SocSecNum FirstName LastName FirstLastName SSN CardNumber EmailAddress HealthId PBMId Address1 PhoneNumber PPAccountNumber AlternateId
  • SearchFor string

    The content to search for

  • MaxRecords integer <int32>

    The maximum number of records returns

  • StartOrdinal integer <int32>

    The starting ordinal number to return results (normally 0)

  • 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