Participant APIs | REST

Selected Version:
Download Open API File

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

https://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).

Request

Path parameters

Path parameters page anchor
  • 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

Query parameters

Query parameters page anchor
  • isPpTemplate boolean

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

  • decrypt integer <int32>

    Indicate if the URI parameters are encrypted or not. Use 1 for encrypted, 0 for decrypted (default is 0). This affects how the API interprets the incoming identifiers.

Response

Response body

Response body page anchor
  • 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
  • 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
Response Headers 
No response yet.
Response Body 
No response yet.

Copyright © 2026 Alegeus Technologies, LLC. All rights reserved. Alegeus, Alegeus Technologies, WealthCare, WealthCare Saver are registered trademarks of Alegeus Technologies, LLC

AI Assistant Preview

Generating response...