Wex Health and Benefits APIs

Sections

Theme switcher

Get Recipients

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

person_idstring Required

The GUID of the person (participant)

Body Parameters

plan_idsarray Required

The plan GUIDs (BenefitsOffering.PlanSystemId) the claim is being filed against.

Show child attributes

Response

200
Object

Successfully resolved recipients

Response Attributes

recipientsarray

The available recipients (participant and/or dependents), sorted by display name.

Show child attributes

400
Object

Invalid request. Check query parameters and body.

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.

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

Not Found. No matching plans found.

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

POST

/

Select
1

Response

Was this section helpful?