Get communication message details

https://development.api.wealthcare.com/participant/services/participant/communications/message/{tpaId}/{employerId}/{participantId}

Path parameters

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 whose features are being queried.

Query parameters

id integer <int32>

Communication History Key
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.

Response

DocumentFileType enum<string>

Bit flags indicating the document type queues the communication is in

Possible values: Unknown ClaimReceiptQueue POSReceiptQueue ClaimEntryWorkQueue1 ClaimEntryWorkQueue2 ClaimEntryWorkQueue3 TransactionWorkQueue1 TransactionWorkQueue2 TransactionWorkQueue3 UnassignedQueue DeleteQueue ClaimEntryWorkQueue4 ClaimEntryWorkQueue5 ClaimEntryWorkQueue6 ClaimEntryWorkQueue7 ClaimEntryWorkQueue8 ClaimEntryWorkQueue9 ClaimEntryWorkQueue10 InteractionQueue1 InteractionQueue2 InteractionQueue3 InteractionQueue4 InteractionQueue5 InteractionQueue6 InteractionQueue7 InteractionQueue8 InteractionQueue9 InteractionQueue10 PartnerInteractionQueue1 PartnerInteractionQueue2 PartnerInteractionQueue3 PartnerInteractionQueue4 PartnerInteractionQueue5 PartnerInteractionQueue6 PartnerInteractionQueue7 PartnerInteractionQueue8 PartnerInteractionQueue9 PartnerInteractionQueue10 PartnerTransactionQueue1 PartnerTransactionQueue2 PartnerTransactionQueue3 PartnerTransactionQueue4 PartnerTransactionQueue5 PartnerTransactionQueue6 PartnerTransactionQueue7 PartnerTransactionQueue8 PartnerTransactionQueue9 PartnerTransactionQueue10 PartnerDisclosureQueue PartnerCIPQueue UnassignedPartnerQueue DeletePartnerQueue ClaimEntryWorkQueue11 ClaimEntryWorkQueue12 ClaimEntryWorkQueue13 ClaimEntryWorkQueue14 ClaimEntryWorkQueue15 ClaimEntryWorkQueue16 ClaimEntryWorkQueue17 ClaimEntryWorkQueue18 ClaimEntryWorkQueue19 ClaimEntryWorkQueue20 ClaimEntryWorkQueue21 ClaimEntryWorkQueue22 ClaimEntryWorkQueue23 ClaimEntryWorkQueue24 ClaimEntryWorkQueue25 TransactionWorkQueue4 TransactionWorkQueue5 TransactionWorkQueue6 TransactionWorkQueue7 TransactionWorkQueue8 TransactionWorkQueue9 TransactionWorkQueue10 TransactionWorkQueue11 TransactionWorkQueue12 TransactionWorkQueue13 TransactionWorkQueue14 TransactionWorkQueue15 TransactionWorkQueue16 TransactionWorkQueue17 TransactionWorkQueue18 TransactionWorkQueue19 TransactionWorkQueue20 TransactionWorkQueue21 TransactionWorkQueue22 TransactionWorkQueue23 TransactionWorkQueue24 TransactionWorkQueue25 InteractionQueue11 InteractionQueue12 InteractionQueue13 InteractionQueue14 InteractionQueue15 InteractionQueue16 InteractionQueue17 InteractionQueue18 InteractionQueue19 InteractionQueue20 InteractionQueue21 InteractionQueue22 InteractionQueue23 InteractionQueue24 InteractionQueue25 EmployeeDocument
DocumentTrackingNum integer <int64>

Document tracking number
EmailTypeCde integer <int32>

Email type code {BenSoft.Common.Enumeration.EmailType}
CustTempOptions integer <int64>

Bit flags for custom options set on the communication template {BenSoft.Common.Enumeration.CustomTemplateOptions}
NotificationEmailSubject string

Notification email subject
SenderAddress string

Sender email address
Subject string

Message subject
Body string

Message body
EmpeId integer <int32>

Participant Id
CustomTemplateType enum<string>

Participant communication template type

Possible values: Unknown ParticipantClaimEntryUI OnlineEnrollmentUI EligibilityReponseImport PositiveBalanceImport HSATransactionImport EmployeeAccountExport TransactionExport CardExport ManualClaimEntered ShippingAddressChange EmployeeEmailAddressChange DirectDepositChange PasswordChange BillingAddressChange CardMailed CardLostStolen CardTransactionDenied AccountBalanceAlert AccountDeductibleMet RunOutDateReminder YearEndReminder GracePeriodReminder OnlineEnrollmentPlan BalanceStatementAlert UserIdChange EmployerReimbVerification ParticipantClaimEntryEmail GenericEmail ParticipantPOSReceiptUpload EmployerQueueCommunication TpaQueueCommunication EmployerFundingNotification DepositReceivedAlert HSAOnlineStatement EnrolleeWelcomeEmail EmailCommunicationTemplate PendingContributionsCommunication DeductibleRulesTemplate ServiceCategoriesTemplate CompletedHSAPaymentNotice FailedHSAPaymentNotice CardTransactionApproved ReimbursementProcessed EmployerPortal WelcomeEmailPartnerAlert BillingAddressChangePartnerAlert ShippingAddressChangePartnerAlert EmployeeEmailAddressChangePartnerAlert PasswordChangePartnerAlert UserIdChangePartnerAlert HSAOnlineStatementPartnerAlert DepositReceivedPartnerAlert ExternalAccountUpdatedPartnerAlert EmailCommunicationTemplatePartnerAlert IRSContributionLimitPartnerAlert AccountClosedPartnerAlert AccountReAssociatedPartnerAlert OnlineEnrollmentEmailPartnerAlert Disclosure ProductPartnerCustomText EmprHSAFundingNotification AccountReAssociatedAlert IRSTaxForms1099Alert IRSTaxForms5498Alert NewAdminMasterFraudAlert CIPLetter EmprNonHSAFundingNotificationRecipientData EmprNonHSAFundingNotification PayrollContributionReminderRecipientData PayrollContributionReminder ReportNotification ProrationScheduleTemplate CustomDependentPrivacy EmployerPlanReconcilation EmpeDDBankAcctStatusAlert EmployeeIDNotes OnlineBalanceRepaymentConfirmation OnlineBalanceRepaymentFailure OnlineRepaymentTemplate FutureDatedClaims CommunicationHoldRuleTemplate MobileNumberRegistration UserIdRegistration ParticipantSelfServiceOption
TemplateKey integer <int32>

Participant communication template id
CommunicationChannel enum<string>

Communication channel bit flags

Possible values: None Email Mobile Both LetterCommunication NotifyEmail MailedLetter SendEmailToTaxFormsAcctHolders
BarcodeStream string <byte>

Barcode data
BarcodeAlign string

Barcode alignment. Values: "Left", "Center", "Right", "None", "100%"