Providers
Overview
Manage the providers (payees) participants file claims for, and the recipients those claims cover. Providers enables developers to resolve who a claim can be filed for, retrieve a participant’s recently used providers, and create or update provider records across WEX platforms. It includes operations for recipients, recently used providers, and provider records. Use this resource to build claim submission experiences where participants pick a recipient and provider quickly, without re-entering details.
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 provider and recipient data, powering your own consumer-facing claim 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 Providers API allows you to perform functions related to the participant’s:
- Claim recipients
- Recently used providers
- Provider records (create and update)
Key Features
- Resolves the participant and dependents eligible to receive a claim, based on the plans selected.
- Applies plan type rules automatically: Dependent Care plans exclude the participant, and Mass Transit and Parking plans exclude dependents.
- Returns a paginated list of the participant’s most recently used providers, newest first, so common choices appear at the top.
- Allows the participant to add a new provider with name, mailing address, and optional account number, external provider ID (for example, NPI), and provider TIN.
- Allows the participant to update an existing provider’s address, account number, and accessibility status.
Providers API Operations
The Providers API includes the following operations. Select the API Reference tab to find functional information about each one.
- Get Recipients
- Get Last Used Providers
- Create Provider
- Put Provider
Endpoints
/v1/claims/recipients?person_id=person_id
/v1/claims/providers/last-used?person_id=person_id&page_size=page_size&index=index
/v1/claims/providers?person_id=person_id
/v1/claims/providers/{id}?person_id=person_id