Participant APIs | REST

Selected Version:
Download Open API File

This method gets Introduction Text and Certification Text of the Data Partner

https://api.wealthcare.com/participant/services/datapartner/publictext/{tpaId}/{employerId}/{participantId}/{dataPartnerId}

Retrieve the Introduction Text and Certification Text associated with a specific Data Partner, identified by TPA ID, Employer ID, Participant ID, and Data Partner ID. This endpoint is useful for obtaining essential information about a Data Partner for display or processing purposes.

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.

  • employerId string Required

    Unique identifier for the employer. Note: When the employer was created, WealthCare Admin assigned the 3-character prefix; you assigned the remaining characters.

  • participantId string Required

    Unique identifier for the participant user whose feature information is being retrieved.

  • dataPartnerId string Required

    Data Partner Id

Query parameters

Query parameters page anchor
  • 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
  • DataPartnerId string
  • PartnerName string
  • Addr1 string
  • Addr2 string
  • City string
  • State string
  • CountryCde string
  • Zip string
  • Phone string
  • Fax string
  • EmailAddr string
  • PosPhysBankAcctKey integer <int32>
  • ManPhysBankAcctKey integer <int32>
  • InsertDte string <date-time>
  • InsertUserIdKey integer <int32>
  • UpdateDte string <date-time>
  • UpdateUserIdKey integer <int32>
  • NegativeBalanceToEmailAddr string
  • NegativeBalanceCcEmailAddr string
  • NegativeBalanceOptions integer <int32>
  • ProcessingTypeCde enum<string>
    Possible values: PBF Transaction
  • ReconciliationToEmailAddr string
  • ReconciliationCcEmailAddr string
  • EligResponseLastRunDte string <date-time>
  • PbfLastRunDte string <date-time>
  • EligImportLastRunDte string <date-time>
  • TransImportLastRunDte string <date-time>
  • TransExportLastRunDte string <date-time>
  • DataPartnerOptions integer <int64>
  • ImsRegion string
  • DatabaseTwin string
  • BankDepositNum string
  • LastSetlDte string
  • CardFileLastRunDte string <date-time>
  • RequiredFields integer <int64>
  • ProcessingStatus integer <int32>
  • DpstPhysBankAcctKey integer <int32>
  • CurYrTxnCde integer <int32>
  • CurYrNegativeAmtTxnCde integer <int32>
  • PriorYrTxnCde integer <int32>
  • PriorYrNegativeAmtTxnCde integer <int32>
  • AchDescription string
  • DaysToDelay integer <int32>
  • SsoChannel string
  • SsoLinkName string
  • SsoLinkText string
  • PosPurchCde integer <int32>
  • PosPurchReversalCde integer <int32>
  • PosReturnCde integer <int32>
  • PosReturnReversalCde integer <int32>
  • ManualClaimPmntCde integer <int32>
  • ManualClaimPmntReversalCde integer <int32>
  • ManualClaimRfndCde integer <int32>
  • ManualClaimRfndReversalCde integer <int32>
  • DepositCde integer <int32>
  • DepositReversalCde integer <int32>
  • PayrollFundingDebitOffsetCde integer <int32>
  • ExtFundingDebitOffsetCde integer <int32>
  • PennyCreditPhysBankAcctKey integer <int32>
  • ExtFundingPhysBankAcctKey integer <int32>
  • TpsProcessorKey integer <int32>
  • TpsProcessorId string
  • AgentUserIdKey integer <int32>
  • ProfileKey integer <int32>
  • FirstName string
  • LastName string
  • Initial string
  • UserStatusCde enum<string>
    Possible values: New Active TempInactive PermInactive TempActive
  • Pswd string
  • UserId string
  • NamePrefix string
  • UserLastUpdateDte string <date-time>
  • TpsLastUpdateDte string <date-time>
  • TpsProcStatusCde enum<string>
    Possible values: New Active Inactive
  • RecordIdLength integer <int32>
  • TpsOptions integer <int32>
  • HlthAcctTypeCde string
  • HlthAcctTypeDesc string
  • HlthAuxHtml string
  • Hlt2AcctTypeCde string
  • Hlt2AcctTypeDesc string
  • Hlt2AuxHtml string
  • AcctTypeOptions integer <int64>
  • PosDebitOffsetCde integer <int32>
  • ManualClaimDebitOffsetCde integer <int32>
  • PaperStmtIndAllowed enum<string>
    Possible values: None ElectronicOnly PaperOnly Both
  • PaperStmtIndDefault string
  • StmtEffectiveDte string <date-time>
  • DepositsUserId string
  • DepositsPwd string
  • RoutingId string
  • AbaRoutingNum string
  • InvestmentPartnerId string
  • InvstTransOutBankAcctKey integer <int32>
  • InvstTransInBankAcctkey integer <int32>
  • InvstTransInOffsetCde integer <int32>
  • InvstTransOutOffsetCde integer <int32>
  • InvstTransInCde integer <int32>
  • InvstFeeTxnCde integer <int32>
  • InvstFeeOffsetCde integer <int32>
  • InvstFeeBankAcctkey integer <int32>
  • InvstTransOutCde integer <int32>
  • InvstDataPartnerId string
  • RoutingNum string
  • EmprFundingRoutingNum string
  • MailingAddress string
  • PartnerUrl string
  • CustomerServicePhoneNumber string
  • DaysToProcess integer <int32>
  • WcaBank boolean
  • SettleActivity boolean
  • SetlPhysBankAcctKey integer <int32>
  • NextCheckNum integer <int64>
  • InstructionTxt string
  • CertificationTxt string
  • GlAcct integer <int32>
  • OmniBusExist boolean
  • WcHsaStmtEffectiveDte string <date-time>
  • WcHsaStmtPeriod enum<string>
    Possible values: All None Daily Weekly BiMonthly Monthly Quarterly Yearly SemiMonthly BiWeekly Once
  • WcHsaStmtDisclosure string
  • IdvCustomerIdentifier string
  • PcsGroupId integer <int32>
  • PcsPlanId integer <int32>
  • PcsAccountId integer <int32>
  • PcsSignatureId integer <int32>
  • PcsImgLogoId integer <int32>
  • PcsImgSignId integer <int32>
  • OnlinePayPhysBankAcctNum string
  • OnlinePayPhysBankRoutingNum string
  • TaxpayerIdNum string
  • TaxFormEmailAlertAddr string
  • DefaultSsoPrtrProfileKey integer <int32>
  • PayerName string
  • PayerAddr1 string
  • PayerAddr2 string
  • PayerCity string
  • PayerState string
  • PayerZip string
  • PayerCountryCde string
  • PayerPhone string
  • EmprFundingOmnibusExist boolean
  • PCSWcHsaStmtDisclosure string
  • DaysToWaitForAcknowledgement integer <int32>
  • DisclosureAlertExists boolean
  • PortfolioId string
  • ChkLogoFileKey integer <int32>
  • ChkSignatureText string
  • ChkSignatureFileKey integer <int32>
  • ChkLogoName string
  • ChkSignName string
  • FractionalFoutingNum string
  • DataPartnerId string
  • PartnerName string
  • Addr1 string
  • Addr2 string
  • City string
  • State string
  • CountryCde string
  • Zip string
  • Phone string
  • Fax string
  • EmailAddr string
  • PosPhysBankAcctKey integer <int32>
  • ManPhysBankAcctKey integer <int32>
  • InsertDte string <date-time>
  • InsertUserIdKey integer <int32>
  • UpdateDte string <date-time>
  • UpdateUserIdKey integer <int32>
  • NegativeBalanceToEmailAddr string
  • NegativeBalanceCcEmailAddr string
  • NegativeBalanceOptions integer <int32>
  • ProcessingTypeCde enum<string>
    Possible values: PBF Transaction
  • ReconciliationToEmailAddr string
  • ReconciliationCcEmailAddr string
  • EligResponseLastRunDte string <date-time>
  • PbfLastRunDte string <date-time>
  • EligImportLastRunDte string <date-time>
  • TransImportLastRunDte string <date-time>
  • TransExportLastRunDte string <date-time>
  • DataPartnerOptions integer <int64>
  • ImsRegion string
  • DatabaseTwin string
  • BankDepositNum string
  • LastSetlDte string
  • CardFileLastRunDte string <date-time>
  • RequiredFields integer <int64>
  • ProcessingStatus integer <int32>
  • DpstPhysBankAcctKey integer <int32>
  • CurYrTxnCde integer <int32>
  • CurYrNegativeAmtTxnCde integer <int32>
  • PriorYrTxnCde integer <int32>
  • PriorYrNegativeAmtTxnCde integer <int32>
  • AchDescription string
  • DaysToDelay integer <int32>
  • SsoChannel string
  • SsoLinkName string
  • SsoLinkText string
  • PosPurchCde integer <int32>
  • PosPurchReversalCde integer <int32>
  • PosReturnCde integer <int32>
  • PosReturnReversalCde integer <int32>
  • ManualClaimPmntCde integer <int32>
  • ManualClaimPmntReversalCde integer <int32>
  • ManualClaimRfndCde integer <int32>
  • ManualClaimRfndReversalCde integer <int32>
  • DepositCde integer <int32>
  • DepositReversalCde integer <int32>
  • PayrollFundingDebitOffsetCde integer <int32>
  • ExtFundingDebitOffsetCde integer <int32>
  • PennyCreditPhysBankAcctKey integer <int32>
  • ExtFundingPhysBankAcctKey integer <int32>
  • TpsProcessorKey integer <int32>
  • TpsProcessorId string
  • AgentUserIdKey integer <int32>
  • ProfileKey integer <int32>
  • FirstName string
  • LastName string
  • Initial string
  • UserStatusCde enum<string>
    Possible values: New Active TempInactive PermInactive TempActive
  • Pswd string
  • UserId string
  • NamePrefix string
  • UserLastUpdateDte string <date-time>
  • TpsLastUpdateDte string <date-time>
  • TpsProcStatusCde enum<string>
    Possible values: New Active Inactive
  • RecordIdLength integer <int32>
  • TpsOptions integer <int32>
  • HlthAcctTypeCde string
  • HlthAcctTypeDesc string
  • HlthAuxHtml string
  • Hlt2AcctTypeCde string
  • Hlt2AcctTypeDesc string
  • Hlt2AuxHtml string
  • AcctTypeOptions integer <int64>
  • PosDebitOffsetCde integer <int32>
  • ManualClaimDebitOffsetCde integer <int32>
  • PaperStmtIndAllowed enum<string>
    Possible values: None ElectronicOnly PaperOnly Both
  • PaperStmtIndDefault string
  • StmtEffectiveDte string <date-time>
  • DepositsUserId string
  • DepositsPwd string
  • RoutingId string
  • AbaRoutingNum string
  • InvestmentPartnerId string
  • InvstTransOutBankAcctKey integer <int32>
  • InvstTransInBankAcctkey integer <int32>
  • InvstTransInOffsetCde integer <int32>
  • InvstTransOutOffsetCde integer <int32>
  • InvstTransInCde integer <int32>
  • InvstFeeTxnCde integer <int32>
  • InvstFeeOffsetCde integer <int32>
  • InvstFeeBankAcctkey integer <int32>
  • InvstTransOutCde integer <int32>
  • InvstDataPartnerId string
  • RoutingNum string
  • EmprFundingRoutingNum string
  • MailingAddress string
  • PartnerUrl string
  • CustomerServicePhoneNumber string
  • DaysToProcess integer <int32>
  • WcaBank boolean
  • SettleActivity boolean
  • SetlPhysBankAcctKey integer <int32>
  • NextCheckNum integer <int64>
  • InstructionTxt string
  • CertificationTxt string
  • GlAcct integer <int32>
  • OmniBusExist boolean
  • WcHsaStmtEffectiveDte string <date-time>
  • WcHsaStmtPeriod enum<string>
    Possible values: All None Daily Weekly BiMonthly Monthly Quarterly Yearly SemiMonthly BiWeekly Once
  • WcHsaStmtDisclosure string
  • IdvCustomerIdentifier string
  • PcsGroupId integer <int32>
  • PcsPlanId integer <int32>
  • PcsAccountId integer <int32>
  • PcsSignatureId integer <int32>
  • PcsImgLogoId integer <int32>
  • PcsImgSignId integer <int32>
  • OnlinePayPhysBankAcctNum string
  • OnlinePayPhysBankRoutingNum string
  • TaxpayerIdNum string
  • TaxFormEmailAlertAddr string
  • DefaultSsoPrtrProfileKey integer <int32>
  • PayerName string
  • PayerAddr1 string
  • PayerAddr2 string
  • PayerCity string
  • PayerState string
  • PayerZip string
  • PayerCountryCde string
  • PayerPhone string
  • EmprFundingOmnibusExist boolean
  • PCSWcHsaStmtDisclosure string
  • DaysToWaitForAcknowledgement integer <int32>
  • DisclosureAlertExists boolean
  • PortfolioId string
  • ChkLogoFileKey integer <int32>
  • ChkSignatureText string
  • ChkSignatureFileKey integer <int32>
  • ChkLogoName string
  • ChkSignName string
  • FractionalFoutingNum string
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...