Communications & Content

Access user communications, documents, and forms. Communications & Content enables developers to retrieve and manage user-facing communications and supporting content, including messages, documents, and forms. It provides access to key artifacts that support user engagement, compliance, and workflow completion across WEX platforms. Use this resource to surface important communications, retrieve required documents, and present forms needed for user interaction and benefit administration.

Core Communication Services

Communications API (Messages)

The Communications API provides a robust framework for managing secure, high-stakes interactions with consumers, acting as the primary engine for claim notifications, account alerts, and tax communications.

• Inbox Lifecycle Management: Build a full-service messaging center with capabilities to list messages, view detailed body text, and track real-time unread_count metrics.
• State Tracking: Support user-driven status updates, including marking communications as read, archiving them to historical views, or favoriting important items.
• Compliance & Auditing: Record exact acknowledged_date timestamps for legal disclosures and plan-specific requirements.
• Historical Access: The system provides a default lookback of three years, which can be refined using specific start_date and end_date parameters.

Document & Form Integration

The platform integrates messaging with vital benefit artifacts to ensure users have the necessary documentation for workflow completion.

Attachment Support: Messages include a documents array containing metadata for linked files. Document Referencing: The API returns unique document_id references. To download the actual file, these IDs must be passed to the dedicated Document or Reporting service. Unified Requirements: All identification fields, including person_id, message_id, and document_id, must follow the UUID v4 standard.

Integration Standards

Scopes & Permissions

Interaction with the Communications & Content suite requires specific OAuth authorizations:

Operational Logic

• Pagination Model: The list endpoint uses an index-based model with a default page_size of 25 (max 100). Use the has_next boolean to determine if additional pages are available.
• Idempotency: PUTrequests are idempotent by design; for example, updating a message to read: true multiple times consistently results in the same server state.
• Correlation: Including a 36-character X-Request-Id header is highly recommended for all write operations to assist in troubleshooting across the ecosystem.
• Time Standards: All timestamps are returned in ISO 8601 format (for example, 2026-04-23T12:00:00Z).

Global Error Reference