Wex Health and Benefits APIs

Sections

Theme switcher

Get Eligible Plans

Header Parameters

X-Request-Idstring

Optional correlation ID associated with the request, comprised of alphanumeric or hyphen characters up to 36 characters in length.

Query Parameters

plan_year_idstring Required

Platform GUID of the plan year (BenefitsPackage.PackageSystemId).

consumer_idstring Required

Platform GUID of the participant (person_id).

Response

200
Object

Successfully retrieved eligible plans.

Response Attributes

plansarray

Per-plan details, one entry for each active enrolled offering.

Show child attributes

accountsarray

Plans merged (aggregated) by expense account base type.

Show child attributes

file_by_typestring

Indicates whether the consumer files claims against a specific plan or against an account type. WEX.Benefits.Claims.Domain.Enums.FileByType.FileByPlan when any account type groups more than one plan (the caller must disambiguate); WEX.Benefits.Claims.Domain.Enums.FileByType.FileByAccount when each account type has exactly one underlying plan.

status_effective_datestring

The date the participant's current status (e.g. Active, Terminated) took effect (ParticipantStatus.StatusEffectiveDt). Null when no status record exists for the participant, or when all status records have an effective date in the future (i.e. no record with EffectiveDate <= UtcNow).

400
Object

Invalid request parameters.

Response Attributes

typestring
titlestring
statusinteger
detailstring
instancestring
errorsobject

Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.

validation_errorsobject

Field-level validation errors keyed by field name. Each key maps to one or more structured error details.

401
Object

Unauthorized. Authentication failed or identity could not be resolved.

Response Attributes

typestring
titlestring
statusinteger
detailstring
instancestring
errorsobject

Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.

validation_errorsobject

Field-level validation errors keyed by field name. Each key maps to one or more structured error details.

404
Object

No eligible plans found for the given consumer and plan year.

Response Attributes

typestring
titlestring
statusinteger
detailstring
instancestring
errorsobject

Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.

validation_errorsobject

Field-level validation errors keyed by field name. Each key maps to one or more structured error details.

500
Object

Internal server error.

default
Object

Unexpected error

Response Attributes

typestring
titlestring
statusinteger
detailstring
instancestring
errorsobject

Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.

validation_errorsobject

Field-level validation errors keyed by field name. Each key maps to one or more structured error details.

Was this section helpful?

Base URL

Production:

Sandbox:

Language Box

GET

/

Select
1

Response

Was this section helpful?