Claims Settings
Overview
Retrieve the configuration and eligibility rules that govern claim filing. Claims Settings enables developers to read claim-related settings for a participant or employer, and to check which offerings a participant is eligible to file claims against across WEX platforms. It includes operations for retrieving settings and filing eligibility. Use this resource to shape claim submission experiences around each participant’s actual rules, so your app only offers options that will be accepted.
Why use the API?
- Modernization: It provides a standardized, clear, and modern RESTful endpoint, making it easier to integrate with current systems.
- Integration: It allows you to easily consume and integrate claim settings and eligibility data, powering your own consumer-facing experiences.
- Growth & Innovation: Using our API, you can improve your own products and create a smoother claim submission experience for your customers and consumers.
What can the API do?
The Claims Settings API allows you to perform functions related to the participant’s and employer’s:
- Claim settings
- Filing eligibility by offering
Key Features
- Returns claim settings for either a participant or an employer, with optional filters by offering or setting name.
- Requires exactly one of
person_idorbusiness_idon settings requests. Providing both returns 400. - Returns claim filing eligibility for a single offering, or for every offering the participant is actively enrolled in.
- Identifies the participant’s employer automatically, so you do not need to send an employer identifier for eligibility checks.
- Uses platform GUIDs for all identifiers.
Claims Settings API Operations
The Claims Settings API includes the following operations. Select the API Reference tab to find functional information about each one.
- Get Settings
- Get Filing Eligibility
Endpoints
/v1/claims/settings?person_id=person_id&business_id=business_id&offering_id=offering_id&se...
/v1/claims/filing-eligibility?person_id=person_id&offering_system_id=offering_system_id