Note that this currently only works with our Aetna (018f7dfa-3e85-7f38-a0fe-71a9bf6a64c2) Payor in QA and code 11 (Commercial). Other codes and payors are a work in progress!
How It Works
In our QA environment, every benefits check request is intercepted and returns a synthetic response based on the patient’s member number. No real payor calls are made. This lets you:- Test your integration against realistic benefit data for a Commercial plan
- Simulate authorization requirements, referral requirements, and visit limits
- Create a patient plan with a specially formatted member number
- Create a benefits check to trigger the check
- Get the benefits check to retrieve results
- Poll until
statusisCOMPLETE
Member Number Format
The member number has three parts:
Examples:
Quick Start
Step 1 — Create a patient plan with a test member number
Set the member number on the patient plan to control what the benefits check returns. For a basic Commercial plan test:Step 2: Trigger a benefits check
Use the Create Benefits Check API:Step 3: Retrieve the results
Use the Get Benefits Check V2 API with the returned ID. Poll untilstatus is COMPLETE. The benefits check typically processes within a few seconds.
Insurance Type Codes
The last two characters of the member number select the insurance type and plan data returned. Currently only code11 (Commercial) is supported.
Fields returned
Code 11 populates these top-level response fields:eligibility_status→ELIGIBLEplan_start_date→2025-01-01plan_end_date→2025-12-31plan_type→Open Access MCinsurance_type→COMMERCIAL
specialty_fields):
IN = in-network, OON = out-of-network
Requirement Flags
Include these keywords anywhere in the middle of the member number (between theA prefix and the two-digit insurance code) to toggle specific requirements. You can combine multiple flags in a single member number.
How flags appear in the V2 response
AUTH_REQ populates authorization_requirements:
REF_REQ populates referral_requirements:
VISIT_REQ populates visit_limits:
visits_used available as a separate field on the response.
Combining flags
Flags can be combined freely. For example,AAUTH_REQREF_REQVISIT_REQ11 enables all three on a Commercial plan.
Complete Example Responses
All examples below show V2 responses from Get Benefits Check V2.Commercial plan with all requirement flags
Member Number:AAUTH_REQREF_REQVISIT_REQ11
Commercial plan with no flags
Member Number:ATEST00000011