Wex Health and Benefits APIs

Sections

Theme switcher

File Claim

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

Platform GUID of the participant.

Path Parameters

worksheet_idstring Required

The public UUID identifying the worksheet, returned from POST /v1/claims.

Body Parameters

send_notificationsboolean

Whether to send notifications to the participant after filing.

attach_receiptsboolean

Whether to attach receipts to the filed claim.

send_auto_denial_letterboolean

Whether to send an auto-denial letter if the claim is denied.

submissionsarray

Original claim submissions used to create the draft. Required to adjudicate the claim.

Show child attributes

consumer_tracked_expense_idstring

Optional public UUID of a consumer-tracked expense to link to the filed claim. For immediately paid claims, the service validates the expense, creates a capped ConsumerTrackedExpenseAllocation, and updates the expense status to Paid or PartiallyPaid. For deferred claims, the service creates a zero-amount association and leaves the expense status unchanged until the claim becomes payable. Omit for standard claim filing.

Response

200
Object

Claim filed successfully.

Response Attributes

worksheet_idstring

Gets or sets the public UUID of the worksheet (ClaimWorksheetExternal_guid).

filed_claimsarray

Gets or sets the list of filed claim summaries.

Show child attributes

400
Object

Invalid request or draft already processed/expired.

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.

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

Draft not 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?