Returns details of a communication

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

Use this operation to read messages sent from an administrator to a specific participant.

tpaId string Required

A unique identifier used to identify your admin instance. This value was system generated with 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

Participant Id
communicationKey integer <int32> Required

Communication Key

communicationVersion integer <int32> Required

Communication version 1:Legacy, 2:Premium (default value is 1)
communicationFileType integer <int32>

Communication File Type 0:Unknown, 1:Html, 2:PortalHtml, 3:Txt, 4:Pdf (default value is 2)
decrypt integer <int32>

Indicate if the URI parameters are encrypted or not. 1: encrypted, 0: decrypted, default to 0.

RecipientAddress string

The recipient's email address
FileByteArray string <byte>

A byte array containing the file stream data for the communication.
DocumentTrackingNum integer <int64>

Document tracking number
SenderAddress string

Email address of sender
Subject string

Message subject
Body string

Message body
ParticipantId integer <int32>

The employee ID for the participant
CommunicationRuleType integer

Communication rule type
CommunicationRuleKey integer <int32>

Communication rule template id
CommunicationChannels integer <int32>

Communication channel bit flags 0 = None, 1 = Email, 2 = Mobile, 4 = Letter
BarcodeStream string <byte>

Barcode data
BarcodeAlign string

Barcode alignment. Values: "Left", "Center", "Right", "None", "100%"
CommunicationVersion integer <int32>

Communication version. 1 = Legacy Communication, 2 = Premium Communication