eligibility

Retrieve HSA/FSA catalog eligibility

Returns every item in your catalog that can be charged to an HSA/FSA card, with no customer in context.

This is catalog eligibility — a property of the product. An item appears here when its eligibility category is HSA/FSA-payable for your merchant account, whether it requires a Letter of Medical Necessity or is pre-approved and requires none. It is the widest possible answer: everything a customer could be eligible for, before anyone has qualified.

Whether a particular customer can put one of these items on their HSA/FSA card is a separate question — customer eligibility — answered by the keyed forms of this endpoint. Use this form to mark eligible items wherever you present your catalog, and a keyed form once you know who is shopping.

Because no customer is identified, eligibility_status and lmn_expires_at are both null. Nothing in the response depends on a customer, so it is safe to cache for as long as your catalog is stable.

get/api/v1/eligibility

Request

  • Base URL: https://dev-api.truemed.com
  • URL: https://dev-api.truemed.com/api/v1/eligibility
  • Auth: API key in header x-truemed-api-key

Response

Successful response

eligibility_status'approved' | 'pending' | 'expired' | 'rejected' | 'never_requested'

Where a customer's clinical eligibility stands. A statement of fact, never an instruction.

itemsstring[] required

The catalog items that can be charged to an HSA/FSA card, each identified exactly as it is in order_items when you charge.

lmn_expires_atstring date nullable

When the letter determining this customer's coverage expires (inclusive, UTC). Null for catalog eligibility, which identifies no customer.

Changes

No recorded changes to this operation across all 1 revision of this API.