Eligibility Check Workflow
The Eligibility API lets you determine whether a product is eligible for FSA/HSA reimbursement before the member completes a purchase.
When to Check Eligibility
Check eligibility at these points in your flow:
- At checkout — Before processing payment, verify the item is eligible
- On product pages — Show eligibility badges to members browsing your catalog
- In cart — Validate all items before the member proceeds to payment
Making an Eligibility Request
Send a POST request to /v1/product with the product details:
curl -X POST https://eligibility.withsilver.app/v1/product \
-H "apiKey: your-partner-api-key" \
-H "Content-Type: application/json" \
-d '{
"title": "Advil Ibuprofen Tablets, 200mg",
"description": "Pain reliever and fever reducer, 100 coated tablets",
"sku": "305730169301",
"sku_type": "UPC",
"vendor": "Advil"
}'
Only title is required. The more fields you provide, the more accurate the determination.
Always include SKU and vendor
When available, always send the sku, sku_type, and vendor fields. This significantly improves the accuracy of eligibility determinations.
Interpreting Results
The response includes an eligibility field with one of four values:
| Status | Meaning | Recommended Action |
|---|---|---|
eligible | The product is eligible for FSA/HSA reimbursement | Proceed with the transaction |
not_eligible | The product is not eligible | Inform the member; do not submit a claim |
eligible_with_lmn | Eligible only with a Letter of Medical Necessity | Prompt the member to provide an LMN |
unknown | Eligibility could not be determined | Consider allowing the purchase and submitting a claim for manual review |
Example: Eligible Response
{
"eligibility": "eligible",
"title": "Advil Ibuprofen Tablets, 200mg",
"description": "Pain reliever and fever reducer, 100 coated tablets",
"sku": "305730169301",
"sku_type": "UPC",
"image_url": "https://example.com/images/advil-200mg.jpg"
}
Example: Eligible with LMN
{
"eligibility": "eligible_with_lmn",
"title": "Standing Desk Converter",
"description": "Adjustable standing desk converter, 36 inches",
"sku": null,
"sku_type": null,
"image_url": null
}
Best Practices
- Cache results carefully — Eligibility can change as product databases are updated. Avoid caching results for more than a few minutes.
- Handle
unknowngracefully — If eligibility can't be determined, consider letting the member proceed and submitting the claim for manual review. - Always send SKU data — The
skuandsku_typefields improve determination accuracy. Send them whenever your product catalog includes this data. - Check before submitting — Always check eligibility before submitting a claim to reduce rejection rates.