Participant APIs | REST

Version:
Download Open API Specification

Get list of enrollment plan(needed for previewing the enrollment screen in WCA)

https://beta.api.wealthcare.com/participant/services/enrollment/plans/{tpaId}/{templateKey}

Retrieve a list of enrollment plans associated with a specific TPA and template key, which is essential for previewing the enrollment screen in the WealthCare Admin (WCA) interface.

  • tpaId string Required

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

  • templateKey integer <int32> Required

    Template Key

  • isPpTemplate boolean

    Indicates whether the template is a product partner template (true) or a TPA template (false). This helps in distinguishing the type of enrollment plan being requested.

  • numPlanReturn integer <int32>

    Specifies the number of plan rows to return in the response. The default value is 20, allowing for pagination of results if more plans are available.

  • decrypt integer <int32>

    Indicate if the URI parameters are encrypted or not. Use 1 for encrypted and 0 for decrypted; defaults to 0 if not specified.

  • array <object>
    • PlanKey integer <int32>
    • PlanId string
    • PlanYrStartDte string
    • PlanYrEndDte string
    • AnnualElectMin number <double>
    • AnnualElectMax number <double>
    • EligibilityDte string
    • EnrollmentStartDte string
    • EnrollmentEndDte string
    • DependentDesc string
    • FlexAcctId string
    • CoverageTierKey integer <int32>
    • CoverageTierDesc string
    • EmpeBrokerId string
    • AcctTypeCde string
    • AcctTypeDesc string
    • IsPrefunded boolean
    • IsHsaPlan boolean
    • OeTemplateTpaId string
    • OeTemplateKey integer <int32>
    • HasAnnouncement boolean
    • DataPartnerId string
    • AllowClaimsCrossover boolean
    • AllowManualClaims boolean
    • AllowAcctReassociation boolean
    • AllowManageOptin boolean
    • ReassociationAcctNum string
    • TrustPaper string
    • ProxyCde string
    • EmpeElectCde enum<string>
      Possible values: None Participate Waive DidNotEnroll
    • ContributionPeriod integer <int32>
    • PpElectAmt number <double>
    • AnnualElectAmt number <double>
    • LastElectAmt number <double>
    • AutoDepositCalendarKey integer <int32>
    • EmprId string
    • EmprName string
    • AcctStatusCde integer <int32>
    • PlanExtOptions integer <int32>
    • EmpeElectAmtPp number <double>
    • CustomDescription string
    • DataPartnerReplStatusCode enum<string>
      Possible values: None PendingCreate PendingUpdate UpToDate ValidationError UnexpectedError Deactivated InvalidAccount ApplicationApprovedManually ApplicationApproved ApplicationDeniedNoReapply ApplicationDeniedReapplyAllowed RequiresBankReview AwaitingAdditionalInformation ApplicationProcessing ApplicationSentToBank AccountReassociated DisclosuresToBeIssued DisclosureAcknowledgementRequired DisclosureAcknowledgementReceived
    • PaperElectronicTaxForm integer <int32>
    • MonthlyEnrollmentEndDay integer <int32>
    • EnrollStatusDesc string
    • IsEmprWithExternalCard boolean