Retrieve Provision Request Eligibility

Returns **customer eligibility** for a customer who does not hold a payment token yet, keyed on the provision request id you received from `create_payment_token`. The token-keyed form and this one answer the same question — which items *this* customer can charge to their HSA/FSA card — and differ only in how you name the customer. Use this one for a customer's first order, where you have a provision request but no token; switch to the token form once the token arrives. This is the only form that returns `pending`, and the window it covers is the wait for a clinical decision: the customer has answered the survey, no clinician has decided, and you still need something to present your catalog with. In that state `items` carries what the survey predicts the letter will cover, intersected with your catalog, and `lmn_expires_at` is null because no letter exists yet. Those items are a prediction, not a decision — present them as provisional. `items` is empty only while the survey itself is unfinished. Once a clinician decides, this key keeps working and starts answering exactly as the token-keyed form does: `approved`, `expired`, `rejected`, or `never_requested`, with a real coverage date where one exists. That makes it a reliable poll if the `payment_token.updated` webhook is ever lost — and unlike the Retrieve Provision Token Request endpoint, whose `payment_token` is null for both outcomes, this one tells a pending letter apart from a rejected one.

Authentication

x-truemed-api-keystring

Sales channel API key for merchant server-to-server authentication

Path parameters

provision_token_request_idstringRequired

The ID of the ProvisionTokenRequest returned by create_payment_token

Response

Successful response
itemslist of strings

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

eligibility_statusenum or nullOptional

Where this customer’s clinical eligibility stands. Named apart from the payment status on other Truemed payloads, which is a different vocabulary. Per-value meanings are listed on the enum. Null for catalog eligibility, which identifies no customer.

One of:

  • approved — A verified, unexpired letter stands for this customer.
  • pending — A survey is with a clinician; the outcome is not decided yet.
  • expired — The letter that covered this customer has lapsed and not been renewed.
  • rejected — A clinician reviewed this customer’s most recent survey and declined it.
  • never_requested — No letter has ever been requested for this customer here.
lmn_expires_atdatetime or nullOptional

When the letter determining this customer’s coverage expires: in the future while approved, in the past once expired. Null for catalog eligibility, which identifies no customer.

Errors

400
Bad Request Error
404
Not Found Error
405
Method Not Allowed Error
500
Internal Server Error
501
Not Implemented Error