Administrative APIs | REST

Version:
Download Open API Specification

Get Employers

https://api.wealthcare.com/system/Services/Employer/{tpaId}/List

This will return a list of all employers for the specified administrator.

  • tpaId string Required

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

  • verboseMode boolean
  • array <object>
    • ManageHSAFundingBankAccounts boolean
    • CardIssueAddressIndicator_2016_09 enum<string>

      Specifies which address new cards are mailed to.

      Possible values: Cardholder Employer Tpa MBI EmployerAlternate AdminAlternate
    • EmployerMarketplaceGUID string
    • ActiveFirstUse boolean

      Specifies whether cards are automatically activated when a cardholder first uses the card.

    • City string

      City associated with employer group's address.

    • CopayAutoReview boolean

      Indicates whether the employer has employee co-pay amounts enabled.

    • EmailAddress string

      Email address associated with employer group.

    • EmployerId string

      Employer group's ID in WCA, including the group's 3 character prefix.

    • EmployerName string

      Complete employer name. This is the name used on reports generated by the system.

    • EmployerStatus enum<string>
      Possible values: New Active TempInactive PermInactive
    • RecurringExpenseAutoReview boolean

      Indicates whether the employer has employee recurring expense amounts enabled.

    • State string

      The two letter state abbreviation associated with the group’s address.

    • TpaId string

      Administrator ID.

    • DefaultCardDesign enum<string>
      Possible values: Payment Combo
    • EmprOptions enum<integer>
      Possible values: None (0) AllowSplitAcrossPlanDesign (32) AllowExternalReimb (128) AllowIneligiblePOSOffset (256) EnableComboCard (1024) AllowParticipantEmailUpdates (2048) AllowParticipantEmailAdmin (4096) AllowParticipantAccessDependentInfo (8192) AllowParticipantRequestNewCard (16384) AllowParticipantUpdateDemoInfo (32768) AllowParticipantUpdateDirectDepositInfo (65536) AllowParticipantViewDirectDepositInfo (131072) AllowParticipantClaimsCrossOver (262144) VerifyReimbursement (524288) AllowUploadCensusRecords (1048576) AllowViewMetavanteEduContents (2097152) AllowParticipantCommunicationSelection (4194304) AllowParticipantClaimEntry (8388608) AllowParticipantReceiptUpload (16777216) AllowEmployeeDemographicSelfCreationviaOnlineEnrollment (33554431) EnableProviderPay (67108864) BillableEmployer (4294967296) DisplayClaimsoneClaimsManager (17179869184) LockEmployerStatus (34359738368)
    • ComboCardWaitingPeriod enum<integer>
      Possible values:
    • AllowSplitAcrossPlanDesign boolean
    • ThermalLogoId string

      This is the Thermal Logo (Front) description that was created in the user interface.

    • ReimbMinAmt number <double>

      This field is used to set the minimum reimbursement amount for Reimbursement Processing.