Participant APIs | REST

Version:
Download Open API Specification

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

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

Retrieve detailed information about a specific enrollment plan, which is essential for previewing the enrollment screen in the WealthCare Application (WCA). This endpoint is typically used to display plan options to users during the enrollment process.

  • 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

  • planKey integer <int32> Required

    Plan Key

  • isPpTemplate boolean

    Indicates whether the enrollment plan is a product partner template (true) or a TPA template (false). This parameter helps differentiate between template types for accurate processing.

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

  • 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