Wex Health API Documentation ## Sections • [Introduction](https://developers.wexhealth.com/wex-health-api/introduction.md): WEX administers health benefit accounts for thousands of employers and millions of consumers across the United States. The WEX Health & Benefits API… • [Benefits of Integrating with WEX APIs](https://developers.wexhealth.com/wex-health-api/benefits-of-integrating-with-wex-apis.md): WEX Health Benefits Platform APIs provide a comprehensive suite of tools to streamline your benefits administration, enhance your offerings, and… • [Getting Started](https://developers.wexhealth.com/wex-health-api/getting-started.md): Step 1: Confirm your partnership API access is available exclusively to credentialed WEX business partners. If you’re already a partner, your WEX… • [Authentication](https://developers.wexhealth.com/wex-health-api/authentication.md): WEX Health Benefits Platform APIs use OAuth 2.0 with the Client Credentials Grant Type for secure authentication. This industry-standard protocol… • [Lifecycle and Deprecation Policy](https://developers.wexhealth.com/wex-health-api/lifecycle-and-deprecation-policy.md): WEX Health & Benefits Platform APIs follow a structured lifecycle to ensure stability, predictability, and clear communication with our partners.… • [Claims & Financial Operations](https://developers.wexhealth.com/wex-health-api/api-endpoints/claims-and-financial-operations.md): Manage claims, payments, and financial account operations. Claims & Financial Operations enables developers to manage the movement of funds and… • [Accounting](https://developers.wexhealth.com/wex-health-api/api-endpoints/claims-and-financial-operations/accounting.md): Overview Manage financial instruments, accounts, and transaction activity. Accounting enables developers to manage core financial instruments and… • [List Bank Accounts](https://developers.wexhealth.com/wex-health-api/api-endpoints/claims-and-financial-operations/accounting/list-bank-accounts.md): Retrieve bank accounts, filtered by consumer • [Archive Bank Account](https://developers.wexhealth.com/wex-health-api/api-endpoints/claims-and-financial-operations/accounting/archive-bank-account.md): Archives a specific bank account by changing its account_use to ARCHIVED. This is a soft delete operation that maintains the account record for audit… • [Get Card By Id](https://developers.wexhealth.com/wex-health-api/api-endpoints/claims-and-financial-operations/accounting/get-card-by-id.md): Retrieves all details for a specific card by its unique ID. • [Get Cards](https://developers.wexhealth.com/wex-health-api/api-endpoints/claims-and-financial-operations/accounting/get-cards.md): Retrieves a list of cards associated with a Consumer, optionally filtering by provider, lastfourdigits and primary status. • [Reissue Card](https://developers.wexhealth.com/wex-health-api/api-endpoints/claims-and-financial-operations/accounting/reissue-card.md): Initiates a card reissue (replacement) request for the specified card. The replacement card will have the same card number and technology as the… • [Update Card Status](https://developers.wexhealth.com/wex-health-api/api-endpoints/claims-and-financial-operations/accounting/update-card-status.md): Updates the status of a specific card (for example, to ACTIVE, LOST_STOLEN, SUSPENDED). • [Issue Card For Dependent](https://developers.wexhealth.com/wex-health-api/api-endpoints/claims-and-financial-operations/accounting/issue-card-for-dependent.md): Issues a new debit card for the specified secondary cardholder (e.g. dependent or authorized signer). The secondary cardholder is identified by their… • [Activate Consumer Bank Account](https://developers.wexhealth.com/wex-health-api/api-endpoints/claims-and-financial-operations/accounting/activate-consumer-bank-account.md): Activates a pending consumer bank account by validating the micro-deposit amount. The account transitions to ACTIVE upon successful validation, or to… • [Create Or Update Bank Account](https://developers.wexhealth.com/wex-health-api/api-endpoints/claims-and-financial-operations/accounting/create-or-update-bank-account.md): Creates a new bank account or updates an existing one. If accountid is null in the request body, a new account will be created. If accountid is… • [Claims](https://developers.wexhealth.com/wex-health-api/api-endpoints/claims-and-financial-operations/claims.md): The Claims API provides programmatic access to manage health benefit claims and their associated financial data. This RESTful API enables developers… • [Get Claim By Claim Number](https://developers.wexhealth.com/wex-health-api/api-endpoints/claims-and-financial-operations/claims/get-claim-by-claim-number.md): Retrieves a single Claim object by its claim_number , including core claim details, current processing status, and related denial information when… • [Get Claims](https://developers.wexhealth.com/wex-health-api/api-endpoints/claims-and-financial-operations/claims/get-claims.md): Retrieve a paginated list of claims by either Person ID or Business Entity ID. Exactly one of personid or businessentityid must be provided. Requests… • [Get Receipts For Participant](https://developers.wexhealth.com/wex-health-api/api-endpoints/claims-and-financial-operations/claims/get-receipts-for-participant.md): Retrieve a list of receipt entities belonging to a specific claim by Claim Number and Person ID, paginated. • [Get Receipt For Participant](https://developers.wexhealth.com/wex-health-api/api-endpoints/claims-and-financial-operations/claims/get-receipt-for-participant.md): Retrieve a single receipt by Receipt ID. • [Get Payees For Participant](https://developers.wexhealth.com/wex-health-api/api-endpoints/claims-and-financial-operations/claims/get-payees-for-participant.md): Retrieve a list of payee information objects for a person by Person ID, paginated. • [Get Expense Categories And Types](https://developers.wexhealth.com/wex-health-api/api-endpoints/claims-and-financial-operations/claims/get-expense-categories-and-types.md): This endpoint fetches the expense categories and their associated types for a given person ID, account type, and employer ID. • [Download File From Cloud With Person Id](https://developers.wexhealth.com/wex-health-api/api-endpoints/claims-and-financial-operations/claims/download-file-from-cloud-with-person-id.md): Download File from cloud storage. • [Save Receipt](https://developers.wexhealth.com/wex-health-api/api-endpoints/claims-and-financial-operations/claims/save-receipt.md): Saves the uploaded receipt information and associates it with a claim. The person_id is used for authorization verification. • [Upload File To Cloud With Person Id](https://developers.wexhealth.com/wex-health-api/api-endpoints/claims-and-financial-operations/claims/upload-file-to-cloud-with-person-id.md): Uploads a file to the cloud with the provided person_id. • [Upload Receipt](https://developers.wexhealth.com/wex-health-api/api-endpoints/claims-and-financial-operations/claims/upload-receipt.md): This endpoint allows uploading a receipt for a specific person. The receipt is validated and saved. • [Update Denial](https://developers.wexhealth.com/wex-health-api/api-endpoints/claims-and-financial-operations/claims/update-denial.md): Cancels a denial on a claim • [List Claim Details](https://developers.wexhealth.com/wex-health-api/api-endpoints/claims-and-financial-operations/claims/list-claim-details.md): Returns a paginated list of ClaimDetail records for partner-authorized employers. The partner identity is resolved from the JWT bearer token, so… • [Create Claim Draft](https://developers.wexhealth.com/wex-health-api/api-endpoints/claims-and-financial-operations/claims/create-claim-draft.md): Runs the rules engine to calculate proposed pay/pending/deny amounts without creating claims. Draft expires after 24 hours. File it via POST… • [Get Claims Requiring Receipts](https://developers.wexhealth.com/wex-health-api/api-endpoints/claims-and-financial-operations/claims/get-claims-requiring-receipts.md): Retrieve a paginated list of a participant’s claims that fall into one of the “receipts needed” buckets identified by type. Ports the legacy LH1… • [Cancel Claim](https://developers.wexhealth.com/wex-health-api/api-endpoints/claims-and-financial-operations/claims/cancel-claim.md): Cancels a pending consumer-filed claim using denial code CC1 (Consumer Canceled Claim). The claim must be in Pending Receipt status, filed by… • [Update Claim Worksheet](https://developers.wexhealth.com/wex-health-api/api-endpoints/claims-and-financial-operations/claims/update-claim-worksheet.md): Updates a pending (open) claim worksheet by replacing the specified submission with new data. Implements the legacy UpdateClaim flow: Step A —… • [File Claim](https://developers.wexhealth.com/wex-health-api/api-endpoints/claims-and-financial-operations/claims/file-claim.md): Files a previously created draft. Generates claim numbers and writes claims in a single transaction. The rules engine does not run again - draft… • [Get Denial History](https://developers.wexhealth.com/wex-health-api/api-endpoints/claims-and-financial-operations/claims/get-denial-history.md): Retrieves denial history for a given claim • [Reimbursement Methods](https://developers.wexhealth.com/wex-health-api/api-endpoints/claims-and-financial-operations/reimbursement-methods.md): Overview The Reimbursement Methods API provides a centralized way to manage how funds are returned to consumers (for example, Direct Deposit, Check).… • [List Reimbursement Methods](https://developers.wexhealth.com/wex-health-api/api-endpoints/claims-and-financial-operations/reimbursement-methods/list-reimbursement-methods.md): Retrieves a paginated list of ReimbursementMethod objects for the specified consumer. Returns reimbursement methods with optional filtering by… • [Spending Accounts](https://developers.wexhealth.com/wex-health-api/api-endpoints/claims-and-financial-operations/spending-accounts.md): Overview The Spending Accounts API allows developers to retrieve detailed information about financial benefit accounts (such as HSA, FSA, or HRA).… • [List Spending Accounts](https://developers.wexhealth.com/wex-health-api/api-endpoints/claims-and-financial-operations/spending-accounts/list-spending-accounts.md): Retrieves a paginated list of SpendingAccount objects for the specified consumerid or planid . Returns the matching spending accounts with pagination… • [Transactions](https://developers.wexhealth.com/wex-health-api/api-endpoints/claims-and-financial-operations/transactions.md): Overview The Transactions API provides a detailed ledger of financial activities for a consumer’s benefit plans. This endpoint allows developers to… • [List Transactions](https://developers.wexhealth.com/wex-health-api/api-endpoints/claims-and-financial-operations/transactions/list-transactions.md): Retrieves transactions for a consumer and a set of plans under the provided plan year. Required : consumerid and planyearid must be provided. If… • [Claims Settings](https://developers.wexhealth.com/wex-health-api/api-endpoints/claims-and-financial-operations/claims-settings.md): Overview Retrieve the configuration and eligibility rules that govern claim filing. Claims Settings enables developers to read claim-related settings… • [Get Settings](https://developers.wexhealth.com/wex-health-api/api-endpoints/claims-and-financial-operations/claims-settings/get-settings.md): Retrieve settings for a given scope. Provide exactly one of personid or businessid; providing both returns 400. • [Get Filing Eligibility](https://developers.wexhealth.com/wex-health-api/api-endpoints/claims-and-financial-operations/claims-settings/get-filing-eligibility.md): Returns claim filing eligibility flags for a participant as a wrapped collection. When offeringSystemId is supplied, the eligibilities array contains… • [Document Verification](https://developers.wexhealth.com/wex-health-api/api-endpoints/claims-and-financial-operations/document-verification.md): Overview Verify claim documents and finalize adjudication. Document Verification enables developers to submit supporting documents for review,… • [Post Document Verification](https://developers.wexhealth.com/wex-health-api/api-endpoints/claims-and-financial-operations/document-verification/post-document-verification.md): Submit a document for verification. • [Validate Document Verification](https://developers.wexhealth.com/wex-health-api/api-endpoints/claims-and-financial-operations/document-verification/validate-document-verification.md): Validate a previously submitted document. • [Adjudicate Document Verification](https://developers.wexhealth.com/wex-health-api/api-endpoints/claims-and-financial-operations/document-verification/adjudicate-document-verification.md): Adjudicate a previously submitted document. • [Expenses](https://developers.wexhealth.com/wex-health-api/api-endpoints/claims-and-financial-operations/expenses.md): Overview Manage consumer-tracked expenses and look up eligible expense types. Expenses enables developers to track out-of-pocket costs and understand… • [Get Eligible Expenses By Plan Ids](https://developers.wexhealth.com/wex-health-api/api-endpoints/claims-and-financial-operations/expenses/get-eligible-expenses-by-plan-ids.md): Retrieve eligible expense categories and types for multiple plans (offerings) • [Create Expense](https://developers.wexhealth.com/wex-health-api/api-endpoints/claims-and-financial-operations/expenses/create-expense.md): Create a consumer-tracked (Unpaid) expense for a person (Spec-Compliant). • [Update Expense](https://developers.wexhealth.com/wex-health-api/api-endpoints/claims-and-financial-operations/expenses/update-expense.md): Updates an existing consumer tracked expense. • [Delete Expense](https://developers.wexhealth.com/wex-health-api/api-endpoints/claims-and-financial-operations/expenses/delete-expense.md): Soft-deletes a consumer tracked expense. Only unpaid expenses with no allocations can be removed. • [Providers](https://developers.wexhealth.com/wex-health-api/api-endpoints/claims-and-financial-operations/providers.md): Overview Manage the providers (payees) participants file claims for, and the recipients those claims cover. Providers enables developers to resolve… • [Get Recipients](https://developers.wexhealth.com/wex-health-api/api-endpoints/claims-and-financial-operations/providers/get-recipients.md): Resolve the available claim recipients (the participant and/or their dependents) for a set of plans (offerings). The recipient composition depends on… • [Get Last Used Providers](https://developers.wexhealth.com/wex-health-api/api-endpoints/claims-and-financial-operations/providers/get-last-used-providers.md): Retrieve a paginated list of providers most recently used by the participant, ordered from most to least recently used • [Create Provider](https://developers.wexhealth.com/wex-health-api/api-endpoints/claims-and-financial-operations/providers/create-provider.md): Creates a provider (payee) record for the participant identified by person_id . Requires the write:claims scope. Returns 403 Forbidden when the… • [Put Provider](https://developers.wexhealth.com/wex-health-api/api-endpoints/claims-and-financial-operations/providers/put-provider.md): Replaces the editable section of an existing provider (payee) record identified by id. The 8 editable fields are: accessible , accountnumber ,… • [Communications & Content](https://developers.wexhealth.com/wex-health-api/api-endpoints/communications-and-content.md): Access user communications, documents, and forms. Communications & Content enables developers to retrieve and manage user-facing communications and… • [Documents](https://developers.wexhealth.com/wex-health-api/api-endpoints/communications-and-content/documents.md): Overview The Documents resource group provides endpoints for retrieving benefit-related documents generated for individuals within the WEX Health and… • [Get Documents](https://developers.wexhealth.com/wex-health-api/api-endpoints/communications-and-content/documents/get-documents.md): Retrieves a paginated list of documents for the specified person, optionally filtered by year and document type. All document types (account… • [Get Document By Id](https://developers.wexhealth.com/wex-health-api/api-endpoints/communications-and-content/documents/get-document-by-id.md): Retrieves a specific document for the specified document_id . Use the Accept header with application/json to receive a RenderedDocumentDTO object… • [Messages](https://developers.wexhealth.com/wex-health-api/api-endpoints/communications-and-content/messages.md): Overview Retrieve and manage the messages sent to a person. Messages enables developers to list a person’s messages, open a single message, and… • [Get Messages](https://developers.wexhealth.com/wex-health-api/api-endpoints/communications-and-content/messages/get-messages.md): Retrieves a list of messages. Supports filtering by read, archived, and favorite status. • [Get Message](https://developers.wexhealth.com/wex-health-api/api-endpoints/communications-and-content/messages/get-message.md): Retrieves a specific message by its unique message_id. • [Update Message](https://developers.wexhealth.com/wex-health-api/api-endpoints/communications-and-content/messages/update-message.md): Replaces the message for the specified message_id with the data in the request body. • [Consent Management](https://developers.wexhealth.com/wex-health-api/api-endpoints/consent-management.md): The Consent Management section of the WEX Health and Benefits API provides the tools to build and operate a complete consent lifecycle – from… • [Agreements](https://developers.wexhealth.com/wex-health-api/api-endpoints/consent-management/agreements.md): Overview Retrieve agreements and manage consent records. Agreements enables developers to list and retrieve agreements, download agreement documents,… • [Get Agreement Responses Agreement Responses](https://developers.wexhealth.com/wex-health-api/api-endpoints/consent-management/agreements/get-agreement-responses-agreement-responses.md): Lists all consent records for a specific individual. • [Get Agreements Agreement](https://developers.wexhealth.com/wex-health-api/api-endpoints/consent-management/agreements/get-agreements-agreement.md): Returns a single agreement by ID. • [Get Agreements Agreement File](https://developers.wexhealth.com/wex-health-api/api-endpoints/consent-management/agreements/get-agreements-agreement-file.md): Returns the raw file content (PDF or HTML) stored in object storage for an agreement. • [Get Agreements Agreements](https://developers.wexhealth.com/wex-health-api/api-endpoints/consent-management/agreements/get-agreements-agreements.md): Supports cursor-free offset pagination via page (0-based, default 0) and page_size (1-100, default 20) query parameters. Responds with 400 if either… • [Create Agreement Responses Agreement Response](https://developers.wexhealth.com/wex-health-api/api-endpoints/consent-management/agreements/create-agreement-responses-agreement-response.md): Records that an individual has consented to a specific agreement. • [Agreements Attach Agreement File](https://developers.wexhealth.com/wex-health-api/api-endpoints/consent-management/agreements/agreements-attach-agreement-file.md): Accepts a file upload, stores it in Document Index, and creates an active AgreementFile record. • [Lifecycle Actions](https://developers.wexhealth.com/wex-health-api/api-endpoints/lifecycle-actions.md): Manage consumer lifecycle transitions and benefit coverage updates. Lifecycle Actions provide a robust, discovery-driven framework for handling… • [Termination](https://developers.wexhealth.com/wex-health-api/api-endpoints/lifecycle-actions/termination.md): Overview The Termination API suite provides a robust, discovery-driven workflow for ending consumer benefit coverage. By combining impact analysis,… • [Create Termination Request](https://developers.wexhealth.com/wex-health-api/api-endpoints/lifecycle-actions/termination/create-termination-request.md): Creates and executes a termination request, or previews the impact without executing. The mode field in the request body determines the operation:… • [Consumer Holds](https://developers.wexhealth.com/wex-health-api/api-endpoints/lifecycle-actions/consumer-holds.md): Overview Retrieve and manage the holds and red flags placed on a consumer. Consumer Holds enables developers to see what is blocking a consumer’s… • [Get Consumer Process Hold](https://developers.wexhealth.com/wex-health-api/api-endpoints/lifecycle-actions/consumer-holds/get-consumer-process-hold.md): Returns consumer holds with a Flag reason • [Get Consumer Red Flag](https://developers.wexhealth.com/wex-health-api/api-endpoints/lifecycle-actions/consumer-holds/get-consumer-red-flag.md): Return active red flags associated with a consumer, can be filtered by hold to retrieve flags that are only related to a certain hold. • [Get Red Flag Settings](https://developers.wexhealth.com/wex-health-api/api-endpoints/lifecycle-actions/consumer-holds/get-red-flag-settings.md): Retrieves the red flag configuration settings for a specified admin and process type. • [Release Red Flag](https://developers.wexhealth.com/wex-health-api/api-endpoints/lifecycle-actions/consumer-holds/release-red-flag.md): Release the specified red flag for a consumer, clears their associated processholds , and publishes corresponding domain events. Returns the… • [Plans, Enrollment & Elections](https://developers.wexhealth.com/wex-health-api/api-endpoints/plans-enrollment-and-elections.md): Configure plans, capture elections, and manage enrollment lifecycle. Plans, Elections & Enrollments allow developers to define available benefit… • [Elections](https://developers.wexhealth.com/wex-health-api/api-endpoints/plans-enrollment-and-elections/elections.md): Overview The Elections API manages consumer benefit choices, representing the specific financial commitments or coverage levels a consumer has… • [List Elections](https://developers.wexhealth.com/wex-health-api/api-endpoints/plans-enrollment-and-elections/elections/list-elections.md): Retrieve elections for a specific enrollment with optional filtering by plan and plan year. Required : enrollmentid must be provided. consumerid must… • [Get Election](https://developers.wexhealth.com/wex-health-api/api-endpoints/plans-enrollment-and-elections/elections/get-election.md): Retrieve details for a specific election by ID. • [Get Election History](https://developers.wexhealth.com/wex-health-api/api-endpoints/plans-enrollment-and-elections/elections/get-election-history.md): Retrieve enrolled election history for a consumer, filtered by election startdate within a lookback window. Required : consumerid must be provided.… • [List Election Expense Types](https://developers.wexhealth.com/wex-health-api/api-endpoints/plans-enrollment-and-elections/elections/list-election-expense-types.md): Retrieve the categorized expense types for a given consumer and account type. Categories are returned in the items collection. • [List Election Plan Attestations](https://developers.wexhealth.com/wex-health-api/api-endpoints/plans-enrollment-and-elections/elections/list-election-plan-attestations.md): Retrieve the associated attestations assigned to the plans of a given consumer. Attestations are returned in the items collection. • [List Election Plans](https://developers.wexhealth.com/wex-health-api/api-endpoints/plans-enrollment-and-elections/elections/list-election-plans.md): Retrieve the enrolled plans for a given consumer, including nested elections. Plans are returned in the items collection. This is a person-scoped… • [Enrollments](https://developers.wexhealth.com/wex-health-api/api-endpoints/plans-enrollment-and-elections/enrollments.md): Overview The Enrollments API serves as the definitive record of a consumer’s participation in various benefit plans. While an Election represents the… • [List Enrollments](https://developers.wexhealth.com/wex-health-api/api-endpoints/plans-enrollment-and-elections/enrollments/list-enrollments.md): Retrieve enrollments with required filtering by consumer, consumer identifier and optional filtering by plan, plan year and employer. Required:… • [Get Enrollment](https://developers.wexhealth.com/wex-health-api/api-endpoints/plans-enrollment-and-elections/enrollments/get-enrollment.md): Retrieve details for a specific enrollment by ID. • [Plan Years](https://developers.wexhealth.com/wex-health-api/api-endpoints/plans-enrollment-and-elections/plan-years.md): Overview The Plan Years API suite defines the foundational temporal cycles for all benefit offerings. A Plan Year represents the specific period… • [List Plan Years](https://developers.wexhealth.com/wex-health-api/api-endpoints/plans-enrollment-and-elections/plan-years/list-plan-years.md): Retrieve plan years with optional filtering by consumer, employer, year, and status. Required : At least one of consumerid or employerid must be… • [Get Plan Year](https://developers.wexhealth.com/wex-health-api/api-endpoints/plans-enrollment-and-elections/plan-years/get-plan-year.md): Retrieve details for a specific plan year by ID. • [Create Plan Year](https://developers.wexhealth.com/wex-health-api/api-endpoints/plans-enrollment-and-elections/plan-years/create-plan-year.md): Create a new plan year for an employer. • [Update Plan Year](https://developers.wexhealth.com/wex-health-api/api-endpoints/plans-enrollment-and-elections/plan-years/update-plan-year.md): Replace all properties that can be altered in an existing plan year. Required : planyearid must be provided. • [Plans](https://developers.wexhealth.com/wex-health-api/api-endpoints/plans-enrollment-and-elections/plans.md): Overview The Plans API is the architectural core of the benefit system. While a Plan Year defines the temporal boundaries, a Plan defines the actual… • [List Plans](https://developers.wexhealth.com/wex-health-api/api-endpoints/plans-enrollment-and-elections/plans/list-plans.md): Retrieve plans for a specific plan year with optional filtering by type and employer. Required : At least one of consumerid or employerid must be… • [Get Plan](https://developers.wexhealth.com/wex-health-api/api-endpoints/plans-enrollment-and-elections/plans/get-plan.md): Retrieve details for a specific plan by ID. • [Create Plan](https://developers.wexhealth.com/wex-health-api/api-endpoints/plans-enrollment-and-elections/plans/create-plan.md): Create a new plan within a plan year. • [Update Plan](https://developers.wexhealth.com/wex-health-api/api-endpoints/plans-enrollment-and-elections/plans/update-plan.md): Fully replace an existing plan. All fields must be provided. • [Get Eligible Plans](https://developers.wexhealth.com/wex-health-api/api-endpoints/plans-enrollment-and-elections/plans/get-eligible-plans.md): Returns two views of the participant’s active, enrolled plans for the specified plan year: plans — one entry per enrolled offering with dates and… • [Get Plan Rules](https://developers.wexhealth.com/wex-health-api/api-endpoints/plans-enrollment-and-elections/plans/get-plan-rules.md): Returns the full plan-rules view for the given participant and plan, including: plan header information, filing dates, plan ordering (primary/parent… • [Users & Identity](https://developers.wexhealth.com/wex-health-api/api-endpoints/users-and-identity.md): Core operations for managing user profiles, identity verification, and account-level preferences. Users & Identity provides the foundation for… • [Businesses](https://developers.wexhealth.com/wex-health-api/api-endpoints/users-and-identity/businesses.md): Overview The Businesses resource group provides endpoints for searching and managing Business entities within the WEX Health and Benefits platform.A… • [Search Businesses](https://developers.wexhealth.com/wex-health-api/api-endpoints/users-and-identity/businesses/search-businesses.md): Searches for Business entities matching the specified criteria (name, EIN, or alias). Returns a paginated list of businesses sorted by relevance,… • [Update Businesses](https://developers.wexhealth.com/wex-health-api/api-endpoints/users-and-identity/businesses/update-businesses.md): Updates the specified Business entity by setting the values of the parameters provided. Any parameters not included in the request will remain… • [Notification Preference](https://developers.wexhealth.com/wex-health-api/api-endpoints/users-and-identity/notification-preference.md): Overview The Notification Preferences API suite provides full control over how and why consumers receive communications from the platform. It manages… • [Get External Notification Preferences](https://developers.wexhealth.com/wex-health-api/api-endpoints/users-and-identity/notification-preference/get-external-notification-preferences.md): Retrieves external notification preferences for the specified consumer. • [Update External Notification Preferences](https://developers.wexhealth.com/wex-health-api/api-endpoints/users-and-identity/notification-preference/update-external-notification-preferences.md): Updates external notification preferences for the specified consumer. • [Get Notification Preferences](https://developers.wexhealth.com/wex-health-api/api-endpoints/users-and-identity/notification-preference/get-notification-preferences.md): Retrieves notification preferences for the specified consumer. • [Update Notification Preferences](https://developers.wexhealth.com/wex-health-api/api-endpoints/users-and-identity/notification-preference/update-notification-preferences.md): Updates notification preferences for the specified consumer. • [Person](https://developers.wexhealth.com/wex-health-api/api-endpoints/users-and-identity/person.md): Overview The Person API centralizes the management of consumer, dependent, and beneficiary information, ensuring accurate and consistent person-level… • [Get Authorized Signers](https://developers.wexhealth.com/wex-health-api/api-endpoints/users-and-identity/person/get-authorized-signers.md): Overview The Get Authorized Signers endpoint retrieves the authorized signer records associated with a specific consumer. Business value This… • [Get Consumer](https://developers.wexhealth.com/wex-health-api/api-endpoints/users-and-identity/person/get-consumer.md): Overview The Get Consumer endpoint retrieves a single consumer record by consumerid . Business value This endpoint gives applications a reliable way… • [Lookup Consumers](https://developers.wexhealth.com/wex-health-api/api-endpoints/users-and-identity/person/lookup-consumers.md): Look up consumers within an administrator and employer using one or more consumer identifiers. • [Get Dependents](https://developers.wexhealth.com/wex-health-api/api-endpoints/users-and-identity/person/get-dependents.md): Overview The Get Dependents endpoint retrieves the dependent records associated with a specific consumer. Business value This endpoint returns a… • [List Employee Groups](https://developers.wexhealth.com/wex-health-api/api-endpoints/users-and-identity/person/list-employee-groups.md): Retrieves a paginated list of EmployeeGroup records. Results are scoped to the authenticated caller’s employer tenant. The employeraccountid query… • [Get Employee Group By Id](https://developers.wexhealth.com/wex-health-api/api-endpoints/users-and-identity/person/get-employee-group-by-id.md): Returns the full EmployeeGroup record including membership rules and hierarchy. Returns 403 Forbidden if the group belongs to a different employer… • [Get Employee Group Plan Visibility](https://developers.wexhealth.com/wex-health-api/api-endpoints/users-and-identity/person/get-employee-group-plan-visibility.md): Returns all plan mappings for an EmployeeGroup , enabling plan domains to determine which plans are visible for the given group. Returns 403… • [List Membership Rules](https://developers.wexhealth.com/wex-health-api/api-endpoints/users-and-identity/person/list-membership-rules.md): Returns all membership rules for a specific EmployeeGroup . Returns 403 Forbidden if the group belongs to a different employer tenant than the caller. • [Evaluate Membership Rules](https://developers.wexhealth.com/wex-health-api/api-endpoints/users-and-identity/person/evaluate-membership-rules.md): Evaluates the group’s membership rules against all employees for the same employer and returns a paginated page of the external IDs of those that… • [Create Employee Group](https://developers.wexhealth.com/wex-health-api/api-endpoints/users-and-identity/person/create-employee-group.md): Creates a new EmployeeGroup record. The operation is atomic: the group record is created and an EmployeeGroupCreatedEvent is staged in the… • [Add Membership Rule](https://developers.wexhealth.com/wex-health-api/api-endpoints/users-and-identity/person/add-membership-rule.md): Adds a membership rule (eligibility condition) to an EmployeeGroup . The operation is atomic. Returns 403 Forbidden if the group belongs to a… • [Update Employee Group](https://developers.wexhealth.com/wex-health-api/api-endpoints/users-and-identity/person/update-employee-group.md): Fully replaces EmployeeGroup top-level properties, including wholesale replacement of nested eligibility_defaults and metadata (cleared to null when… • [Deactivate Employee Group](https://developers.wexhealth.com/wex-health-api/api-endpoints/users-and-identity/person/deactivate-employee-group.md): Soft-deletes an EmployeeGroup by setting status to INACTIVE . The operation is atomic and stages an EmployeeGroupDeactivatedEvent in the… • [Get Employee By Id](https://developers.wexhealth.com/wex-health-api/api-endpoints/users-and-identity/person/get-employee-by-id.md): Returns a single employee by its unique identifier (UUID). Use the expand query parameter to include the PHONE_NUMBERS sub-resource. The VERSIONS… • [Create Employee](https://developers.wexhealth.com/wex-health-api/api-endpoints/users-and-identity/person/create-employee.md): Creates a new Employee record from the supplied request body. Returns the created Employee resource in the response body and a Location header for… • [Search Employees](https://developers.wexhealth.com/wex-health-api/api-endpoints/users-and-identity/person/search-employees.md): Returns a paginated list of employees that match the supplied search criteria. Submit filters such as employerid , partnerid , employeenumber ,… • [Patch Employee](https://developers.wexhealth.com/wex-health-api/api-endpoints/users-and-identity/person/patch-employee.md): Modifies only the fields present in the request body; omitted fields retain their current values. Explicit null values are rejected with 400 Bad… • [Replace Employee](https://developers.wexhealth.com/wex-health-api/api-endpoints/users-and-identity/person/replace-employee.md): Replaces all mutable fields of an existing employee. Optional fields omitted from the request body are cleared. Requires the current version for… • [Delete Employee](https://developers.wexhealth.com/wex-health-api/api-endpoints/users-and-identity/person/delete-employee.md): Permanently deletes an employee record. The operation is idempotent: subsequent calls for the same identifier return 404 Not Found . • [Get Person](https://developers.wexhealth.com/wex-health-api/api-endpoints/users-and-identity/person/get-person.md): Overview The Get Person endpoint retrieves a single person record by its unique identifier. Business Value This endpoint lets you look up a person by… • [Consumer Experiences](https://developers.wexhealth.com/wex-health-api/api-endpoints/consumer-experiences.md): Surface what a consumer needs to do next. Consumer Experiences enables developers to build timely, personalized experiences in their own apps by… • [Tasks](https://developers.wexhealth.com/wex-health-api/api-endpoints/consumer-experiences/tasks.md): Overview Retrieve the actions a person needs to complete. Tasks enables developers to show consumers and business contacts what needs their attention… • [Get Tasks Tasks](https://developers.wexhealth.com/wex-health-api/api-endpoints/consumer-experiences/tasks/get-tasks-tasks.md): Returns the visible, priority-ordered task list for the resolved person. Tasks are ordered by display priority (highest first); tasks with equal… • [Accounts Balances And Funding](https://developers.wexhealth.com/wex-health-api/api-endpoints/accounts-balances-and-funding.md): Core Account Services 1. Funded Account API The Funded Account API provides account-level data for a consumer’s funded accounts. Account Details:… • [HSA](https://developers.wexhealth.com/wex-health-api/api-endpoints/accounts-balances-and-funding/hsa.md): Overview Retrieve HSA contribution reporting data. HSA enables partners to access contribution details, participant-level summaries, and account… • [List Hsa Contribution Details](https://developers.wexhealth.com/wex-health-api/api-endpoints/accounts-balances-and-funding/hsa/list-hsa-contribution-details.md): Returns a paginated list of HsaContributionDetail records, one per posted contribution transaction. Results are scoped to the partner resolved from… • [List Hsa Contribution Summaries](https://developers.wexhealth.com/wex-health-api/api-endpoints/accounts-balances-and-funding/hsa/list-hsa-contribution-summaries.md): Returns a paginated list of HsaContributionSummary records, one per participant account, with year-to-date contribution totals and the governed… • [List Cdh Account Status Roster](https://developers.wexhealth.com/wex-health-api/api-endpoints/accounts-balances-and-funding/hsa/list-cdh-account-status-roster.md): Returns a paginated list of CdhAccountStatusRoster records, one for each participant account and plan type. Use this report to monitor participant… • [Overview](https://developers.wexhealth.com/wex-health-api/sdks/overview.md): The WEX Health SDK wraps the WEX Health and Benefits OpenAPI specification into a fully typed stable client. Each language-specific SDK handles the… • [.NET](https://developers.wexhealth.com/wex-health-api/sdks/net.md): The .NET section is the most complete. The same concepts — singleton configuration, OAuth 2.0, retry, error handling, logging — apply to every other… • [JavaScript](https://developers.wexhealth.com/wex-health-api/sdks/javascript.md): The concepts from the .NET section all apply here. This section covers the specifics for the JS/TS SDK. Install JavaScript npm install… • [Java](https://developers.wexhealth.com/wex-health-api/sdks/java.md): The same concepts apply. This section covers the Java-specific install, configuration, and patterns. Install Maven XML <dependency>… • [Python](https://developers.wexhealth.com/wex-health-api/sdks/python.md): Install Bash pip install wex-health-sdk Configure Create one ApiClient at application startup. In FastAPI, use the lifespan hook to share it across… • [Pre-Launch Checklist](https://developers.wexhealth.com/wex-health-api/sdks/pre-launch-checklist.md): [ ] Credentials stored in environment variables or a secrets vault — not in source code [ ] Integrating against different env credentials requested… • [License Agreement](https://developers.wexhealth.com/wex-health-api/sdks/license-agreement.md): WEX Software Development Kit (SDK) License Agreement v.4.1.26 SDK LICENSE AGREEMENT This Software Development Kit (SDK) License Agreement (Agreement)… • [Contact Support](https://developers.wexhealth.com/wex-health-api/contact-support.md): Thank you for helping us improve the Wex Health developer experience! This document outlines the process for reporting issues across our SDK…