Get Started
Make your first check
Use the mock endpoint to test your integration without consuming credits or hitting the payer network. Mock requests use real auth and are logged in your workspace — they just return a fixture instead of a live response.
Send a mock request
Replace YOUR_API_KEY and YOUR_CLIENT_ID with the values from the previous steps.
curl -X POST https://eligibility.dev/api/eligibility/check/mock \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "X-Client-Id: YOUR_CLIENT_ID" \
-H "Content-Type: application/json" \
-d '{
"payerName": "Aetna",
"memberId": "W123456789",
"patientFirstName": "Jane",
"patientLastName": "Smith",
"patientDateOfBirth": "1985-03-22",
"mockFixture": "aetna-dependent1"
}'Example response
On success the API returns HTTP 200. The success field indicates whether coverage was confirmed; benefitSummary contains the normalized benefit data.
{
"success": true,
"benefitSummary": {
"coverageActive": true,
"planName": "Aetna Choice POS II",
"payerName": "Aetna",
"deductibleRemaining": 850.00,
"outOfPocketRemaining": 2400.00,
"coinsurancePercent": 20,
"copayAmount": 30,
"inNetworkPreferred": true
},
"traceId": "abc123",
"upstreamStatusCode": 200,
"latencyMs": 312,
"errorMessage": null
}Check the logs
Every mock request is logged in your workspace under Logs with a mock tag. Open a log entry to see the full request and response payloads.
Ready for production?
Switch to POST /api/eligibility/check (drop the mockFixture field and /mock path suffix) and the request will hit the live payer network. Make sure your wallet has credits or a subscription is active.