Failures
The check did not produce a determination: the seven ways that happens, what each body looks like, and which are worth retrying.
A check that fails still finishes. The task reaches its terminal status,
PROCESS_COMPLETE on a single-payer check and SEARCH_ALL_COMPLETE on a
search-all, the response arrives on schedule, and the only thing that says
nothing was determined is eligibility_result.status, or the status on the
aggregated_results entry.
That is the single most expensive misreading of this API. A client that polls
until PROCESS_COMPLETE and then reads data_dump.data.is_eligible finds
nothing, gets undefined, and renders a patient with a broken portal session as
a patient who is not covered.
What the portal showed
Sign in
Rejected- Username
- REDACTED1
- Password
- ••••••••
The username or password you entered is incorrect.2
- 1The clinic's own portal login, not the patient's. Nothing on this screen is about the member, which is why the response carries no
datablock. - 2The check stops here. It reaches you as
status: "invalid_credentials"with the portal's wording inmessage. Retrying this is what produces a locked account.
What a failure body looks like
{"id": "00000000-0000-4000-a000-000000000001","tenant_id": "yourorg","clinic_id": "00000000-0000-4000-a000-000000000002","created_at": "2026-01-14T20:17:48.568000","updated_at": "2026-01-14T20:24:05.147000","task_id": "00000000-0000-4000-a000-000000000001","status": "PROCESS_COMPLETE","request_dump": {"phone": "+971 50 000 0000","id_type": "EMIRATESID","tpa_name": "TPA004","payerName": "NAS ADMINISTRATION SERVICES","doctorName": "Sample Clinician","extra_args": {"title": "LocationGroup","value": "OPTICAL","is_member_present_at_the_facility": false},"visit_type": "OPTICAL","emirates_id": "784-0000-0000000-0","practice_id": "00000000-0000-4000-a000-000000000002","is_special_location": true,"user_id": "00000000-0000-4000-a000-000000000003","name": null,"dob": null,"mode": "prod","test_mode": false},"interim_results": null,"is_search_all": false,"search_all_status": null,"created_by_user_id": null,"eligibility_result": {"id": "00000000-0000-4000-a000-000000000001:TPA004","tenant_id": "yourorg","clinic_id": "00000000-0000-4000-a000-000000000002","created_at": "2026-01-14T20:24:05.572000","updated_at": "2026-01-14T20:24:05.572000","data_dump": {"tpa": "TPA004","status": "invalid_credentials","message": "Invalid Credentials for TPA `NAS/Neuron`. Username used: `REDACTED`. Please ask your team admin to update the credentials.","error_type": "TPAInvalidCredentialsError","screenshot_key": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z","was_identified_by_aggregator": false},"search_id": "0000-0000-0000-0000","tpa_name": "TPA004","task_id": "00000000-0000-4000-a000-000000000001","user_id": null,"status": "invalid_credentials"}}
Note what is not there. On a failure, data_dump has exactly these keys:
status the failure class
error_type a stable identifier for the failure
message the text to put in front of a person
screenshot_key the portal at the moment it broke
tpa the payer
was_identified_by_aggregatorThere is no data key at all, so data_dump.data.is_eligible is not a value
that is false. It is a path that does not exist.
Every sample on this page is from a task that completed
The task lifecycle describes whether the work finished, not whether it answered. None of these
tasks reports FAILED; they report PROCESS_COMPLETE or, on a search-all, SEARCH_ALL_COMPLETE.
Branch on the per-payer status before you touch anything under data_dump.data.
The seven classes
status | Meaning | Retry |
|---|---|---|
invalid_credentials | The clinic's portal login was rejected | No. Fix the credentials. |
backoff | Too many recent credential failures; not attempted | No. Wait out the window. |
tpa_not_configured | No credentials on file for this payer | No. |
failed | The check ran and did not complete | Once. |
error | Something unexpected went wrong | Once. |
member_not_found | The payer has no such member | See not found, then found. |
delegated_to_search_all_pool | Routing bookkeeping, not a result | Not applicable. |
invalid_credentials
{"id": "00000000-0000-4000-a000-000000000001","tenant_id": "yourorg","clinic_id": "00000000-0000-4000-a000-000000000002","created_at": "2026-01-14T20:17:48.568000","updated_at": "2026-01-14T20:24:05.147000","task_id": "00000000-0000-4000-a000-000000000001","status": "PROCESS_COMPLETE","request_dump": {"phone": "+971 50 000 0000","id_type": "EMIRATESID","tpa_name": "TPA004","payerName": "NAS ADMINISTRATION SERVICES","doctorName": "Sample Clinician","extra_args": {"title": "LocationGroup","value": "OPTICAL","is_member_present_at_the_facility": false},"visit_type": "OPTICAL","emirates_id": "784-0000-0000000-0","practice_id": "00000000-0000-4000-a000-000000000002","is_special_location": true,"user_id": "00000000-0000-4000-a000-000000000003","name": null,"dob": null,"mode": "prod","test_mode": false},"interim_results": null,"is_search_all": false,"search_all_status": null,"created_by_user_id": null,"eligibility_result": {"id": "00000000-0000-4000-a000-000000000001:TPA004","tenant_id": "yourorg","clinic_id": "00000000-0000-4000-a000-000000000002","created_at": "2026-01-14T20:24:05.572000","updated_at": "2026-01-14T20:24:05.572000","data_dump": {"tpa": "TPA004","status": "invalid_credentials","message": "Invalid Credentials for TPA `NAS/Neuron`. Username used: `REDACTED`. Please ask your team admin to update the credentials.","error_type": "TPAInvalidCredentialsError","screenshot_key": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z","was_identified_by_aggregator": false},"search_id": "0000-0000-0000-0000","tpa_name": "TPA004","task_id": "00000000-0000-4000-a000-000000000001","user_id": null,"status": "invalid_credentials"}}
Highlighted on eligibility_result.data_dump: status, error_type, message. The rest of the keys are documented on Results.
The portal login your clinic has on file was rejected. Show the message, stop, and contact support. Retrying in a loop is what produces the next case.
backoff
{"task_id": "00000000-0000-4000-a000-000000000001","status": "SEARCH_ALL_COMPLETE","request_dump": {"phone": "+971 50 000 0000","id_type": "EMIRATESID","tpa_name": "BOTH","payerName": "","doctorName": "Sample Clinician","extra_args": {"title": "","value": "","is_member_present_at_the_facility": false},"visit_type": "OUTPATIENT","emirates_id": "784-0000-0000000-0","practice_id": "00000000-0000-4000-a000-000000000002","user_id": "00000000-0000-4000-a000-000000000003","name": null,"dob": null,"mode": "prod","test_mode": false},"is_search_all": true,"search_all_status": "SEARCH_ALL_COMPLETE","aggregated_results": [{"tpa_name": "TPA037","status": "failed","data": null,"created_at": "2025-12-20T04:25:22.523000","message": "TPA `TPA037` is not configured for the practice.","screenshot_url": null},{"tpa_name": "INS015","status": "error","data": null,"created_at": "2025-12-20T04:26:20.246000","message": "Unexpected error: Locator.click: Timeout 30000ms exceeded.\nCall log:\n - waiting for get_by_role(\"button\", name=\"Login\")\n - - locator resolved to <button name=\"button\" value=\"login\" class=\"btn btn-primary\">Login</button>\n - - attempting click action\n - - waiting for element to be visible, enabled and stable\n - - element is visible, enabled and stable\n - - scrolling into view if needed\n - - done scrolling\n - - performing click action\n - - click action done\n - - waiting for scheduled navigations to finish\n","screenshot_url": null},{"tpa_name": "INS012","status": "member_not_found","data": {"payer_id": "INS012","show_data": false,"is_eligible": false,"screenshot_key": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z","was_identified_by_aggregator": false},"created_at": "2025-12-20T04:25:38.857000","message": "Member Not Eligible for Insurance","screenshot_url": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z"},{"tpa_name": "TPA026","status": "member_not_found","data": {"payer_id": "TPA026","show_data": false,"is_eligible": false,"screenshot_key": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z","was_identified_by_aggregator": false},"created_at": "2025-12-20T04:25:37.263000","message": "Member with ID 784-0000-0000000-0 not found or referral code was incorrect.","screenshot_url": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z"},{"tpa_name": "TPA004","status": "member_not_found","data": {"network": null,"payer_id": "TPA004","show_data": false,"payer_name": null,"valid_upto": null,"is_eligible": false,"copay_details": null,"other_details": null,"failure_reason": "Explicit negative eligibility indicators are present ('Not Eligible' and 'Invalid Member Identifier'), overriding anyDates or treatment type information.","screenshot_key": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z","coverage_details": null,"is_policy_active": false,"policy_holder_dob": null,"policy_holder_name": null,"referral_documents": [{"tag": "Member Eligibility - Main Page","s3_url": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z"},{"tag": "Member Eligibility - Details Modal","s3_url": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z"},{"tag": "Member Eligibility - Alternative Screenshot","s3_url": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z"}],"policy_holder_phone": null,"policy_holder_gender": null,"policy_holder_last_name": null,"policy_holder_member_id": null,"payer_eligibility_status": null,"policy_holder_first_name": null,"policy_holder_card_number": null,"policy_holder_emirates_id": null,"policy_holder_middle_name": null,"policy_holder_relationship": null,"was_identified_by_aggregator": false},"created_at": "2025-12-20T04:26:20.926000","message": null,"screenshot_url": null},{"tpa_name": "INS017","status": "member_not_found","data": {"network": null,"payer_id": "INS017","show_data": false,"payer_name": null,"valid_upto": null,"is_eligible": false,"copay_details": null,"other_details": null,"failure_reason": "Explicit message: 'Given Member ID/Emirates ID is invalid' indicates the member cannot be identified in the system; no other eligibility indicators are present to confirm eligibility.","screenshot_key": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z","coverage_details": null,"is_policy_active": false,"policy_holder_dob": null,"policy_holder_name": null,"referral_documents": [],"policy_holder_phone": null,"policy_holder_gender": null,"policy_holder_last_name": null,"policy_holder_member_id": null,"payer_eligibility_status": null,"policy_holder_first_name": null,"policy_holder_card_number": null,"policy_holder_emirates_id": null,"policy_holder_middle_name": null,"policy_holder_relationship": null,"was_identified_by_aggregator": false},"created_at": "2025-12-20T04:26:32.120000","message": null,"screenshot_url": null},{"tpa_name": "TPA010","status": "failed","data": null,"created_at": "2025-12-20T04:25:22.400000","message": "TPA `TPA010` is not configured for the practice.","screenshot_url": null},{"tpa_name": "INS020","status": "member_not_found","data": {"payer_id": "INS020","show_data": false,"is_eligible": false,"screenshot_key": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z","was_identified_by_aggregator": false},"created_at": "2025-12-20T04:25:31.468000","message": "Member not found","screenshot_url": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z"},{"tpa_name": "TPA003","status": "member_not_found","data": {"network": null,"payer_id": "TPA003","show_data": false,"payer_name": null,"valid_upto": null,"is_eligible": false,"copay_details": null,"other_details": null,"failure_reason": "Document shows NOT ELIGIBLE with an invalid Emirates ID, indicating no active/valid eligibility.","screenshot_key": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z","coverage_details": null,"is_policy_active": false,"policy_holder_dob": null,"policy_holder_name": null,"referral_documents": [{"id": "member_eligibility_document","tag": "Member Eligibility Document","s3_url": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z"}],"policy_holder_phone": null,"policy_holder_gender": null,"policy_holder_last_name": null,"policy_holder_member_id": null,"payer_eligibility_status": null,"policy_holder_first_name": null,"policy_holder_card_number": null,"policy_holder_emirates_id": null,"policy_holder_middle_name": null,"policy_holder_relationship": null,"was_identified_by_aggregator": false},"created_at": "2025-12-20T04:25:39.192000","message": null,"screenshot_url": null},{"tpa_name": "INS010","status": "member_not_found","data": {"payer_id": "INS010","show_data": false,"is_eligible": false,"screenshot_key": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z","was_identified_by_aggregator": false},"created_at": "2025-12-20T04:27:44.518000","message": "Member not found","screenshot_url": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z"},{"tpa_name": "TPA036","status": "member_not_found","data": {"payer_id": "TPA036","show_data": false,"is_eligible": false,"screenshot_key": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z","was_identified_by_aggregator": false},"created_at": "2025-12-20T04:25:35.791000","message": "Member with ID 784-0000-0000000-0 not found","screenshot_url": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z"},{"tpa_name": "TPA032","status": "failed","data": null,"created_at": "2025-12-20T04:25:22.571000","message": "TPA `TPA032` is not configured for the practice.","screenshot_url": null},{"tpa_name": "TPA002","status": "member_not_found","data": {"payer_id": "TPA002","show_data": false,"is_eligible": false,"screenshot_key": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z","was_identified_by_aggregator": false},"created_at": "2025-12-20T04:25:36.147000","message": "`This beneficiary is Invalid ` was seen","screenshot_url": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z"},{"tpa_name": "DHPO / Riayati","status": "delegated_to_search_all_pool","data": null,"created_at": "2025-12-20T04:25:19.448000","message": "Identification via DHPO / Riayati failed, triggering pool-based search_all.","screenshot_url": null},{"tpa_name": "TPA008","status": "backoff","data": null,"created_at": "2025-12-20T04:25:22.713000","message": "Access to username `REDACTED` on TPA008 has been limited due to repeated incorrect password attempts. Please try again after 22 hours 59 minutes.","screenshot_url": null},{"tpa_name": "TPA001","status": "member_not_found","data": {"network": null,"payer_id": "TPA001","show_data": false,"payer_name": null,"valid_upto": null,"is_eligible": false,"copay_details": null,"other_details": null,"failure_reason": "Explicit negative indicators found: 'Invalid Member Identifier' and 'Not Eligible' in the eligibility details, which means the member is not eligible for coverage for the visit.","screenshot_key": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z","coverage_details": null,"is_policy_active": false,"policy_holder_dob": null,"policy_holder_name": null,"referral_documents": [{"tag": "Member Eligibility - Main Page","s3_url": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z"},{"tag": "Member Eligibility - Details Modal","s3_url": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z"},{"tag": "Member Eligibility - Alternative Screenshot","s3_url": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z"}],"policy_holder_phone": null,"policy_holder_gender": null,"policy_holder_last_name": null,"policy_holder_member_id": null,"payer_eligibility_status": null,"policy_holder_first_name": null,"policy_holder_card_number": null,"policy_holder_emirates_id": null,"policy_holder_middle_name": null,"policy_holder_relationship": null,"was_identified_by_aggregator": false},"created_at": "2025-12-20T04:26:17.142000","message": null,"screenshot_url": null},{"tpa_name": "TPA029","status": "failed","data": null,"created_at": "2025-12-20T04:25:23.128000","message": "TPA `TPA029` is not configured for the practice.","screenshot_url": null},{"tpa_name": "INS038","status": "member_not_found","data": {"payer_id": "INS038","show_data": false,"is_eligible": false,"screenshot_key": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z","was_identified_by_aggregator": false},"created_at": "2025-12-20T04:25:52.444000","message": "Member with ID 784-0000-0000000-0 not found","screenshot_url": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z"},{"tpa_name": "search_all_pool","status": "member_not_found","data": null,"created_at": "2025-12-20T04:27:45.649000","message": "Eligibility checks completed for all prioritized TPAs, no active policy found.","screenshot_url": null}],"total_tpas_checked": 19,"found_results": 0,"created_at": "2025-12-20T04:25:15.670000","updated_at": "2025-12-20T04:27:45.760000"}
Highlighted on aggregated_results.14: tpa_name, status, message. The rest of the keys are documented on Results.
The payer locked the account after repeated bad logins, so the check was never attempted. The window is real and it is long: 22 hours in this production example, 18 hours in another. The message carries the remaining time as prose, not as a field, so display it rather than parsing it.
error
error_type names the failure class. Two production examples:
{"id": "00000000-0000-4000-a000-000000000001","tenant_id": "yourorg","clinic_id": "00000000-0000-4000-a000-000000000002","created_at": "2026-02-17T06:01:41.920000","updated_at": "2026-02-17T06:03:49.065000","task_id": "00000000-0000-4000-a000-000000000001","status": "PROCESS_COMPLETE","request_dump": {"name": "Sample Patient","phone": "+971 50 000 0000","id_type": "CARDNUMBER","tpa_name": "INS020","payerName": "","doctorName": "Sample Clinician","extra_args": {"title": "","value": ""},"visit_type": "OUTPATIENT","emirates_id": "784-0000-0000000-0","practice_id": "00000000-0000-4000-a000-000000000002","user_id": "00000000-0000-4000-a000-000000000003","dob": null,"mode": "prod","test_mode": false},"interim_results": null,"is_search_all": false,"search_all_status": null,"created_by_user_id": null,"eligibility_result": {"id": "00000000-0000-4000-a000-000000000001:INS020","tenant_id": "yourorg","clinic_id": "00000000-0000-4000-a000-000000000002","created_at": "2026-02-17T06:03:49.217000","updated_at": "2026-02-17T06:03:49.217000","data_dump": {"tpa": "INS020","status": "error","message": "Unexpected error: Page.wait_for_selector: Timeout 30000ms exceeded.\nCall log:\n - waiting for locator(\"div.x-window:has-text(\\\"Member Card\\\")\") to be visible\n","error_type": "TimeoutError","screenshot_key": null,"was_identified_by_aggregator": false},"search_id": "0000-0000-0000-0000","tpa_name": "INS020","task_id": "00000000-0000-4000-a000-000000000001","user_id": null,"status": "error"}}
Highlighted on eligibility_result.data_dump: status, error_type, message. The rest of the keys are documented on Results.
{"id": "00000000-0000-4000-a000-000000000001","tenant_id": "yourorg","clinic_id": "00000000-0000-4000-a000-000000000002","created_at": "2025-12-21T20:19:51.652000","updated_at": "2025-12-21T20:19:57.215000","task_id": "00000000-0000-4000-a000-000000000001","status": "PROCESS_COMPLETE","request_dump": {"phone": "+971 50 000 0000","id_type": "EMIRATESID","tpa_name": "TPA002","payerName": "ARAB GULF HEALTH SERVICES (NEXTCARE)","doctorName": "Sample Clinician","extra_args": {"title": "LocationGroup","value": "MATERNITY"},"visit_type": "MATERNITY","emirates_id": "784-0000-0000000-0","practice_id": "00000000-0000-4000-a000-000000000002","is_special_location": true,"user_id": "00000000-0000-4000-a000-000000000003","name": null,"dob": null,"mode": "prod","test_mode": false},"interim_results": null,"is_search_all": false,"search_all_status": null,"created_by_user_id": null,"eligibility_result": {"id": "00000000-0000-4000-a000-000000000001:TPA002","tenant_id": "yourorg","clinic_id": "00000000-0000-4000-a000-000000000002","created_at": "2025-12-21T20:19:57.334000","updated_at": "2025-12-21T20:19:57.334000","data_dump": {"tpa": "TPA002","status": "error","message": "Unexpected error: None","error_type": "KeyError","screenshot_key": null,"was_identified_by_aggregator": false},"search_id": "0000-0000-0000-0000","tpa_name": "TPA002","task_id": "00000000-0000-4000-a000-000000000001","user_id": null,"status": "error"}}
Highlighted on eligibility_result.data_dump: status, error_type, message. The rest of the keys are documented on Results.
The second is the one to design for: "Unexpected error: None" is the whole of
what the payer side gave us. Your fallback copy has to work when message says
nothing useful.
error_type is not a public enum
TimeoutError, KeyError, KnownScrapingErrors and TPAInvalidCredentialsError all appear in
the samples on this page. New ones appear and existing ones get renamed without notice. Branch on
status; log error_type and quote it to support.
failed, on a clinician licence
doctorId is the clinician's professional licence ID. When it is wrong, the
payers that generate a claim form reject the whole check rather than returning a
determination.
{"id": "00000000-0000-4000-a000-000000000001","tenant_id": "yourorg","clinic_id": "00000000-0000-4000-a000-000000000002","created_at": "2026-01-02T18:03:54.443000","updated_at": "2026-01-02T18:08:14.517000","task_id": "00000000-0000-4000-a000-000000000001","status": "PROCESS_COMPLETE","request_dump": {"phone": "+971 50 000 0000","id_type": "EMIRATESID","tpa_name": "INS026","payerName": "THE NATIONAL INSURANCE COMPANY (DAMAN) PJSC","doctorName": "Sample Clinician","extra_args": {"title": "LocationGroup","value": "OUTPATIENT"},"visit_type": "OUTPATIENT","emirates_id": "784-0000-0000000-0","practice_id": "00000000-0000-4000-a000-000000000002","is_special_location": true,"user_id": "00000000-0000-4000-a000-000000000003","name": null,"dob": null,"mode": "prod","test_mode": false},"interim_results": null,"is_search_all": false,"search_all_status": null,"created_by_user_id": null,"eligibility_result": {"id": "00000000-0000-4000-a000-000000000001:INS026","tenant_id": "yourorg","clinic_id": "00000000-0000-4000-a000-000000000002","created_at": "2026-01-02T18:08:14.620000","updated_at": "2026-01-02T18:08:14.620000","data_dump": {"tpa": "INS026","status": "failed","message": "Primary credential failed: Error during API submission for primary: Eligibility Request failed for primary: ['Invalid clinician license']","error_type": "KnownScrapingErrors","screenshot_key": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z","was_identified_by_aggregator": false},"search_id": "0000-0000-0000-0000","tpa_name": "INS026","task_id": "00000000-0000-4000-a000-000000000001","user_id": null,"status": "failed"}}
Highlighted on eligibility_result.data_dump: status, error_type, message. The rest of the keys are documented on Results.
A second production example is more useful, because it quotes the value that was rejected:
{"task_id": "00000000-0000-4000-a000-000000000001","status": "SEARCH_ALL_COMPLETE","request_dump": {"phone": "+971 50 000 0000","id_type": "EMIRATESID","tpa_name": "BOTH","payerName": "BOTH","doctorName": "Sample Clinician","extra_args": {"title": "LocationGroup","value": "MATERNITY","request_start_time": 1779205696.599499},"visit_type": "MATERNITY","emirates_id": "784-0000-0000000-0","practice_id": "00000000-0000-4000-a000-000000000002","is_special_location": true,"user_id": "00000000-0000-4000-a000-000000000003","name": null,"dob": null,"mode": "prod","test_mode": false},"is_search_all": true,"search_all_status": "SEARCH_ALL_PROCESSING","aggregated_results": [{"tpa_name": "INS038","status": "failed","data": null,"created_at": "2026-05-19T16:15:34.492000","message": "Something went wrong","screenshot_url": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z"},{"tpa_name": "INS017","status": "member_not_found","data": {"payer_id": "INS017","show_data": false,"is_eligible": false,"screenshot_key": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z","was_identified_by_aggregator": false},"created_at": "2026-05-19T16:15:51.756000","message": "Member not eligible: Given Member ID/Emirates ID is invalid","screenshot_url": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z"},{"tpa_name": "TPA036","status": "member_not_found","data": {"payer_id": "TPA036","show_data": false,"is_eligible": false,"screenshot_key": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z","was_identified_by_aggregator": false},"created_at": "2026-05-19T16:15:17.984000","message": "Member with ID 784-0000-0000000-0 not found","screenshot_url": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z"},{"tpa_name": "TPA003","status": "member_not_found","data": {"payer_id": "TPA003","is_eligible": false,"patient_info": {"patient_emirates_id": "784-0000-0000000-0","policy_primary_member_id": "MBR-0000000","policy_primary_dha_member_id": "0000000000"},"copay_analysis": {"copay_details": [],"waiting_period": "Not Specified","special_remarks": [],"new_version_of_copay_analysis": {"benefits": [],"policy_info": {"waiting_period": "Not Specified","policy_period_end": null,"policy_jurisdiction": "Not Specified","policy_period_start": null,"beneficiary_start_date": null},"general_remarks": null,"abbreviations_defined": null}},"failure_reason": "The document explicitly indicates NOT ELIGIBLE with 'Invalid Emirates ID' and lacks any positive eligibility details.","policy_network": {"is_vip": "Not Mentioned","payer_name": "Could not determine","sponsor_id": null,"start_date": null,"valid_upto": null,"all_networks": [],"package_name": null,"is_gatekeeper": "Not Mentioned","waiting_period": null,"policy_authority": "Not Mentioned","policy_plan_name": null,"work_site_covered": "Could not determine","policy_holder_name": null,"payer_name_as_in_text": null,"is_general_physician_referral_required_for_specialist_referral": false},"screenshot_key": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z","referral_documents": [{"id": "member_eligibility_document","tag": "Member Eligibility Document","s3_url": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z"}],"copay_details_to_fill": [],"policy_holder_emirates_id": "784-0000-0000000-0","was_identified_by_aggregator": false},"created_at": "2026-05-19T16:15:34.586000","message": null,"screenshot_url": null},{"tpa_name": "TPA001","status": "member_not_found","data": {"payer_id": "TPA001","show_data": false,"is_eligible": false,"screenshot_key": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z","was_identified_by_aggregator": false},"created_at": "2026-05-19T16:16:59.957000","message": "Member not eligible (portal): Not Eligible","screenshot_url": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z"},{"tpa_name": "INS020","status": "member_not_found","data": {"payer_id": "INS020","show_data": false,"is_eligible": false,"screenshot_key": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z","was_identified_by_aggregator": false},"created_at": "2026-05-19T16:15:14.017000","message": "Member not found","screenshot_url": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z"},{"tpa_name": "TPA010","status": "member_not_found","data": {"payer_id": "TPA010","show_data": false,"is_eligible": false,"screenshot_key": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z","was_identified_by_aggregator": false},"created_at": "2026-05-19T16:15:26.338000","message": "Saw `No data found` for the given ID: 784-0000-0000000-0","screenshot_url": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z"},{"tpa_name": "TPA026","status": "member_not_found","data": {"payer_id": "TPA026","show_data": false,"is_eligible": false,"screenshot_key": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z","was_identified_by_aggregator": false},"created_at": "2026-05-19T16:15:30.388000","message": "Member with ID 784-0000-0000000-0 not found or member is inactive. Notification: member not found !!","screenshot_url": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z"},{"tpa_name": "TPA002","status": "member_not_found","data": {"payer_id": "TPA002","show_data": false,"is_eligible": false,"screenshot_key": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z","was_identified_by_aggregator": false},"created_at": "2026-05-19T16:15:41.335000","message": "`1216: Provider not within the Agreed Network` was seen","screenshot_url": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z"},{"tpa_name": "INS012","status": "failed","data": null,"created_at": "2026-05-19T16:26:03.730000","message": "Oman portal has not responded with the eligibility status after 500 seconds","screenshot_url": null},{"tpa_name": "TPA029","status": "member_not_found","data": {"payer_id": "TPA029","show_data": false,"is_eligible": false,"screenshot_key": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z","was_identified_by_aggregator": false},"created_at": "2026-05-19T16:15:50.050000","message": "Member with ID 784-0000-0000000-0 not found","screenshot_url": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z"},{"tpa_name": "TPA004","status": "member_not_found","data": {"payer_id": "TPA004","show_data": false,"is_eligible": false,"screenshot_key": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z","was_identified_by_aggregator": false},"created_at": "2026-05-19T16:16:20.414000","message": "Member not eligible (portal): Not Eligible","screenshot_url": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z"},{"tpa_name": "INS015","status": "member_not_found","data": {"payer_id": "INS015","is_eligible": false,"patient_info": {"patient_emirates_id": null,"policy_primary_dha_member_id": "0000000000"},"copay_analysis": {"copay_details": [],"waiting_period": "Not Specified","special_remarks": [],"new_version_of_copay_analysis": {"benefits": [],"policy_info": {"waiting_period": "Not Specified","policy_period_end": null,"policy_jurisdiction": "Not Specified","policy_period_start": null,"beneficiary_start_date": null},"general_remarks": [],"abbreviations_defined": []}},"failure_reason": "The content is merely a provider portal navigation page without any actual insurance details or eligibility information. It does not provide any explicit indicators that the patient is eligible, hence the determination is False.","policy_network": {"is_vip": "Not Mentioned","payer_name": "Not Applicable","sponsor_id": null,"start_date": null,"valid_upto": null,"all_networks": [],"package_name": null,"is_gatekeeper": "Not Mentioned","waiting_period": null,"policy_authority": "Not Mentioned","policy_plan_name": null,"work_site_covered": "Could not determine","policy_holder_name": null,"payer_name_as_in_text": null,"is_general_physician_referral_required_for_specialist_referral": false},"screenshot_key": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z","referral_documents": [],"copay_details_to_fill": [],"policy_holder_emirates_id": null,"was_identified_by_aggregator": false},"created_at": "2026-05-19T16:16:00.465000","message": null,"screenshot_url": null},{"tpa_name": "INS010","status": "member_not_found","data": {"payer_id": "INS010","show_data": false,"is_eligible": false,"screenshot_key": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z","was_identified_by_aggregator": false},"created_at": "2026-05-19T16:16:42.850000","message": "Member not found","screenshot_url": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z"},{"tpa_name": "INS026","status": "failed","data": null,"created_at": "2026-05-19T16:16:39.027000","message": "Both credentials failed. Primary: Error during API submission for primary: Eligibility Request failed for primary: Doctor with license 'Sample Clinician' not found in the system. Please verify the doctor license ID.; Secondary: Error during API submission for secondary: Eligibility Request failed for secondary: Doctor with license 'Sample Clinician' not found in the system. Please verify the doctor license ID.","screenshot_url": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z"}],"total_tpas_checked": 15,"found_results": 0,"created_at": "2026-05-19T15:48:16.609000","updated_at": "2026-05-19T16:45:46.472000"}
Highlighted on aggregated_results.14: tpa_name, status, message. The rest of the keys are documented on Results.
The value sent was a clinician's name where a licence ID belongs. That is the
failure mode integrators actually hit: the HIS field mapped to doctorId held
the display name, not the licence. Read the quoted value in the message when you
are debugging one of these; it is usually the answer.
Three failures in one response
A search-all can carry several classes at once. This production check has
invalid_credentials, failed and tpa_not_configured side by side.
{"task_id": "00000000-0000-4000-a000-000000000001","status": "SEARCH_ALL_COMPLETE","request_dump": {"phone": "+971 50 000 0000","id_type": "EMIRATESID","tpa_name": "BOTH","payerName": "AL-BUHAIRA NATIONAL INSURANCE COMPANY","doctorName": "Sample Clinician","extra_args": {"title": "LocationGroup","value": "OUTPATIENT"},"visit_type": "OUTPATIENT","emirates_id": "784-0000-0000000-0","practice_id": "00000000-0000-4000-a000-000000000002","user_id": "00000000-0000-4000-a000-000000000003","name": null,"dob": null,"mode": "prod","test_mode": false},"is_search_all": true,"search_all_status": "SEARCH_ALL_COMPLETE","aggregated_results": [{"tpa_name": "TPA032","status": "tpa_not_configured","data": {"payer_id": "TPA032","show_data": false,"is_eligible": false,"screenshot_key": null,"was_identified_by_aggregator": false},"created_at": "2026-04-06T11:50:31.391000","message": "TPA `TPA032` is not configured for the practice.","screenshot_url": null},{"tpa_name": "TPA001","status": "member_not_found","data": {"payer_id": "TPA001","show_data": false,"is_eligible": false,"screenshot_key": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z","was_identified_by_aggregator": false},"created_at": "2026-04-06T11:51:17.110000","message": "Member not found, Final page was not member not found page.","screenshot_url": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z"},{"tpa_name": "TPA036","status": "member_not_found","data": {"payer_id": "TPA036","show_data": false,"is_eligible": false,"screenshot_key": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z","was_identified_by_aggregator": false},"created_at": "2026-04-06T11:50:11.718000","message": "Member with ID 784-0000-0000000-0 not found","screenshot_url": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z"},{"tpa_name": "INS015","status": "member_not_found","data": {"network": null,"payer_id": "INS015","show_data": false,"payer_name": null,"valid_upto": null,"is_eligible": false,"copay_details": null,"other_details": null,"failure_reason": "The provided page content shows a Member Eligibility portal header but contains no actual insurance details (no copay info, policy number, eligibility status, or active/valid indicators). Without explicit eligibility indicators, we cannot confirm coverage for the patient in Sample Facility (Sharjah, UAE). Therefore, not eligible based on missing information.","screenshot_key": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z","coverage_details": null,"is_policy_active": false,"policy_holder_dob": null,"policy_holder_name": null,"referral_documents": [],"policy_holder_phone": null,"policy_holder_gender": null,"policy_holder_last_name": null,"policy_holder_member_id": null,"payer_eligibility_status": null,"policy_holder_first_name": null,"policy_holder_card_number": null,"policy_holder_emirates_id": null,"policy_holder_middle_name": null,"policy_holder_relationship": null,"was_identified_by_aggregator": false},"created_at": "2026-04-06T11:51:18.417000","message": null,"screenshot_url": null},{"tpa_name": "TPA002","status": "member_not_found","data": {"payer_id": "TPA002","show_data": false,"is_eligible": false,"screenshot_key": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z","was_identified_by_aggregator": false},"created_at": "2026-04-06T11:50:12.392000","message": "`This beneficiary is Invalid ` was seen","screenshot_url": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z"},{"tpa_name": "DHPO / Riayati","status": "delegated_to_search_all_pool","data": null,"created_at": "2026-04-06T09:27:44.335000","message": "Identification via DHPO / Riayati failed, triggering pool-based search_all.","screenshot_url": null},{"tpa_name": "TPA010","status": "member_not_found","data": {"payer_id": "TPA010","show_data": false,"is_eligible": false,"screenshot_key": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z","was_identified_by_aggregator": false},"created_at": "2026-04-06T11:51:14.189000","message": "Saw `No data found` for the given ID: 784-0000-0000000-0","screenshot_url": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z"},{"tpa_name": "INS038","status": "member_not_found","data": {"payer_id": "INS038","show_data": false,"is_eligible": false,"screenshot_key": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z","was_identified_by_aggregator": false},"created_at": "2026-04-06T11:50:29.375000","message": "Member with ID 784-0000-0000000-0 not found","screenshot_url": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z"},{"tpa_name": "TPA004","status": "member_not_found","data": {"payer_id": "TPA004","show_data": false,"is_eligible": false,"screenshot_key": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z","was_identified_by_aggregator": false},"created_at": "2026-04-06T11:50:33.341000","message": "Member not found, Final page was not member not found page.","screenshot_url": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z"},{"tpa_name": "TPA003","status": "member_not_found","data": {"network": null,"payer_id": "TPA003","show_data": false,"payer_name": null,"valid_upto": null,"is_eligible": false,"copay_details": null,"other_details": null,"failure_reason": "Document explicitly states NOT ELIGIBLE and Invalid Emirates ID, indicating the member is not eligible.","screenshot_key": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z","coverage_details": null,"is_policy_active": false,"policy_holder_dob": null,"policy_holder_name": null,"referral_documents": [{"id": "member_eligibility_document","tag": "Member Eligibility Document","s3_url": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z"}],"policy_holder_phone": null,"policy_holder_gender": null,"policy_holder_last_name": null,"policy_holder_member_id": null,"payer_eligibility_status": null,"policy_holder_first_name": null,"policy_holder_card_number": null,"policy_holder_emirates_id": null,"policy_holder_middle_name": null,"policy_holder_relationship": null,"was_identified_by_aggregator": false},"created_at": "2026-04-06T11:50:41.900000","message": null,"screenshot_url": null},{"tpa_name": "INS012","status": "failed","data": null,"created_at": "2026-04-06T11:58:32.434000","message": "Oman portal has not responded with the eligibility status after 500 seconds","screenshot_url": null},{"tpa_name": "TPA037","status": "tpa_not_configured","data": {"payer_id": "TPA037","show_data": false,"is_eligible": false,"screenshot_key": null,"was_identified_by_aggregator": false},"created_at": "2026-04-06T11:50:34.665000","message": "TPA `TPA037` is not configured for the practice.","screenshot_url": null},{"tpa_name": "TPA029","status": "member_not_found","data": {"payer_id": "TPA029","show_data": false,"is_eligible": false,"screenshot_key": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z","was_identified_by_aggregator": false},"created_at": "2026-04-06T11:50:46.932000","message": "Member with ID 784-0000-0000000-0 not found","screenshot_url": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z"},{"tpa_name": "INS020","status": "found","data": {"payer_id": "INS020","is_eligible": true,"patient_info": {"policy_holder_dob": "1990-01-01","policy_holder_name": "Sample Policy Holder","patient_emirates_id": "784-0000-0000000-0","policy_primary_member_id": "MBR-0000000","policy_primary_dha_member_id": "0000000000"},"copay_analysis": {"copay_details": [{"remarks": "Explicitly mentioned as not covered in the input.","visit_type": "Maternity","copay_amount": null,"visit_setting": "Outpatient","copay_currency": null,"copay_max_scope": null,"copay_max_amount": null,"copay_percentage": "Not Covered","deductible_scope": null,"deductible_amount": null,"deductible_currency": null,"coinsurance_percentage": null},{"remarks": "Citation: Dental : Yes 30% Copay | \n\n ","visit_type": "Dental","copay_amount": null,"cost_sharing": {"visit_type": "Outpatient","copay_amount": null,"visit_setting": "Outpatient","copay_currency": "AED","copay_percentage": 30,"applicable_location": "UAE","copay_maximum_scope": null,"copay_maximum_amount": null,"coinsurance_percentage": null},"visit_setting": "Outpatient","copay_currency": "AED","copay_max_scope": null,"copay_max_amount": null,"copay_percentage": "30.0","coinsurance_percentage": null},{"remarks": "Explicitly mentioned as not covered in the input.","visit_type": "Optical","copay_amount": null,"visit_setting": "Outpatient","copay_currency": null,"copay_max_scope": null,"copay_max_amount": null,"copay_percentage": "Not Covered","deductible_scope": null,"deductible_amount": null,"deductible_currency": null,"coinsurance_percentage": null},{"remarks": "Citation: Op - Ded : Pc: 20% Max. Aed 30 | \n\n General deductible applied to outpatient services.","visit_type": "Consultation","copay_amount": null,"cost_sharing": {"visit_type": "Outpatient","copay_amount": null,"visit_setting": "Outpatient","copay_currency": "AED","copay_percentage": 20,"applicable_location": "UAE","copay_maximum_scope": "per visit","copay_maximum_amount": 30,"coinsurance_percentage": null},"visit_setting": "Outpatient","copay_currency": "AED","copay_max_scope": "per visit","copay_max_amount": 30,"copay_percentage": "20.0","coinsurance_percentage": null},{"remarks": "Citation: Op : 20% On All Services Including Medicine | \n\n ","visit_type": "Pharmacy","copay_amount": null,"cost_sharing": {"visit_type": "Outpatient","copay_amount": null,"visit_setting": "Outpatient","copay_currency": "AED","copay_percentage": 20,"applicable_location": "UAE","copay_maximum_scope": null,"copay_maximum_amount": null,"coinsurance_percentage": null},"visit_setting": "Outpatient","copay_currency": "AED","copay_max_scope": null,"copay_max_amount": null,"copay_percentage": "20.0","coinsurance_percentage": null},{"remarks": "Citation: Op : 20% On All Services Including Medicine | \n\n ","visit_type": "Outpatient Services","copay_amount": null,"cost_sharing": {"visit_type": "Outpatient","copay_amount": null,"visit_setting": "Outpatient","copay_currency": "AED","copay_percentage": 20,"applicable_location": "UAE","copay_maximum_scope": null,"copay_maximum_amount": null,"coinsurance_percentage": null},"visit_setting": "Outpatient","copay_currency": "AED","copay_max_scope": null,"copay_max_amount": null,"copay_percentage": "20.0","coinsurance_percentage": null}],"waiting_period": "Not Specified","special_remarks": [],"new_version_of_copay_analysis": {"benefits": [{"limits": null,"remarks": "Explicitly mentioned as not covered in the input.","conditions": null,"cost_sharing": [],"coverage_status": "Not Covered","service_category_original": null,"service_category_standardized": "Maternity"},{"limits": null,"remarks": null,"conditions": null,"cost_sharing": [{"visit_type": "Outpatient","copay_amount": null,"visit_setting": "Outpatient","copay_currency": "AED","copay_percentage": 30,"applicable_location": "UAE","copay_maximum_scope": null,"copay_maximum_amount": null,"coinsurance_percentage": null}],"coverage_status": "Covered","service_category_original": null,"service_category_standardized": "Dental"},{"limits": null,"remarks": "Explicitly mentioned as not covered in the input.","conditions": null,"cost_sharing": [],"coverage_status": "Not Covered","service_category_original": null,"service_category_standardized": "Optical"},{"limits": null,"remarks": "General deductible applied to outpatient services.","conditions": null,"cost_sharing": [{"visit_type": "Outpatient","copay_amount": null,"visit_setting": "Outpatient","copay_currency": "AED","copay_percentage": 20,"applicable_location": "UAE","copay_maximum_scope": "per visit","copay_maximum_amount": 30,"coinsurance_percentage": null}],"coverage_status": "Covered","service_category_original": "Op - Ded : Pc: 20% Max. Aed 30","service_category_standardized": "Consultation"},{"limits": null,"remarks": null,"conditions": null,"cost_sharing": [{"visit_type": "Outpatient","copay_amount": null,"visit_setting": "Outpatient","copay_currency": "AED","copay_percentage": 20,"applicable_location": "UAE","copay_maximum_scope": null,"copay_maximum_amount": null,"coinsurance_percentage": null}],"coverage_status": "Covered","service_category_original": "Op : 20% On All Services Including Medicine","service_category_standardized": "Pharmacy"},{"limits": null,"remarks": null,"conditions": null,"cost_sharing": [{"visit_type": "Outpatient","copay_amount": null,"visit_setting": "Outpatient","copay_currency": "AED","copay_percentage": 20,"applicable_location": "UAE","copay_maximum_scope": null,"copay_maximum_amount": null,"coinsurance_percentage": null}],"coverage_status": "Covered","service_category_original": "Op : 20% On All Services Including Medicine","service_category_standardized": "Outpatient Services"},{"limits": null,"remarks": null,"conditions": null,"cost_sharing": [{"visit_type": "Outpatient","copay_amount": null,"visit_setting": "Outpatient","copay_currency": "AED","copay_percentage": 20,"applicable_location": "UAE","copay_maximum_scope": null,"copay_maximum_amount": null,"coinsurance_percentage": null}],"coverage_status": "Covered","service_category_original": "Ip : 20% At Al Zahra Hosp.-Shj (Azhs) & Zulekha Hosps.","service_category_standardized": "Inpatient"}],"policy_info": {"waiting_period": "Not Specified","policy_period_end": null,"policy_jurisdiction": "Not Specified","policy_period_start": null,"beneficiary_start_date": null},"general_remarks": null,"abbreviations_defined": null}},"failure_reason": null,"policy_network": {"is_vip": "Not Mentioned","payer_name": "Not Applicable","sponsor_id": null,"start_date": "2026-01-01","valid_upto": "2026-12-31","all_networks": [{"network": "LIMITED","plan_code": "L003","visit_type": "IP (In Patient)","network_code": null,"network_value": "LIMITED","raw_plan_string": "LIMITED NETWORK - SHJ","matched_plan_name": null,"network_name_as_in_text": "Network (NW): IP & OP : Limited Incl. NMC"},{"network": "LIMITED","plan_code": "L003","visit_type": "OP (Out Patient)","network_code": null,"network_value": "LIMITED","raw_plan_string": "LIMITED NETWORK - SHJ","matched_plan_name": null,"network_name_as_in_text": "Network (NW): IP & OP : Limited Incl. NMC"},{"network": "LIMITED","plan_code": "L003","visit_type": "Not Specified","network_code": null,"network_value": "LIMITED","raw_plan_string": "LIMITED NETWORK - SHJ","matched_plan_name": null,"network_name_as_in_text": "Covered Networks : 1.Limited Incl. NMC Royal Hosp.-Shj (ex.AZHS)"}],"package_name": null,"is_gatekeeper": "Not Mentioned","waiting_period": null,"policy_authority": "MOH","policy_plan_name": "E","work_site_covered": "Could not determine","policy_holder_name": "Sample Policy Holder","payer_name_as_in_text": null,"is_general_physician_referral_required_for_specialist_referral": false},"screenshot_key": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z","policy_holder_dob": "1990-01-01","policy_holder_name": "Sample Policy Holder","referral_documents": [{"id": "member_eligibility_document_main_page","tag": "Member Eligibility Document - Main Page","s3_url": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z"},{"id": "member_eligibility_document","tag": "Member Eligibility Document","s3_url": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z"}],"copay_details_to_fill": [{"name": "Outpatient","values_to_fill": {"LAB": {"copay": "20.0","deductible": "0","_copayAmount": "0","_maxDeductible": "0","_copayMaxAmount": "0","should_set_copay": true,"_deductibleLegacy": "0"},"MEDICINES": {"copay": "20.0","deductible": "0","_copayAmount": "0","_copayMaxAmount": "0","should_set_copay": true,"_deductibleLegacy": "0"},"PROCEDURE": {"copay": "20.0","deductible": "0","_copayAmount": "0","_copayMaxAmount": "0","should_set_copay": true,"_deductibleLegacy": "0"},"RADIOLOGY": {"copay": "20.0","deductible": "0","_copayAmount": "0","_copayMaxAmount": "0","should_set_copay": true,"_deductibleLegacy": "0"},"DIAGNOSTICS": {"copay": "20.0","deductible": "0","_copayAmount": "0","_copayMaxAmount": "0","should_set_copay": true,"_deductibleLegacy": "0"},"CONSULTATION": {"copay": "20.0","deductible": "0","_copayAmount": "0","_copayMaxAmount": "30.0","should_set_copay": true,"_deductibleLegacy": "30.0"},"PHYSIOTHERAPY": {"copay": "20.0","deductible": "0","_copayAmount": "0","_copayMaxAmount": "0","should_set_copay": true,"_deductibleLegacy": "0"},"DENTAL CONSULTATION & PROCEDURE": {"copay": "30.0","deductible": "0","_copayAmount": "0","_copayMaxAmount": "0","should_set_copay": true,"_deductibleLegacy": "0"}},"primary_network": {"network": "LIMITED","network_status": null,"matched_plan_name": null},"available_networks": [{"network": "LIMITED","plan_code": "L003","visit_type": "IP (In Patient)","network_code": null,"network_value": "LIMITED","raw_plan_string": "LIMITED NETWORK - SHJ","matched_plan_name": null,"network_name_as_in_text": "Network (NW): IP & OP : Limited Incl. NMC"},{"network": "LIMITED","plan_code": "L003","visit_type": "OP (Out Patient)","network_code": null,"network_value": "LIMITED","raw_plan_string": "LIMITED NETWORK - SHJ","matched_plan_name": null,"network_name_as_in_text": "Network (NW): IP & OP : Limited Incl. NMC"},{"network": "LIMITED","plan_code": "L003","visit_type": "Not Specified","network_code": null,"network_value": "LIMITED","raw_plan_string": "LIMITED NETWORK - SHJ","matched_plan_name": null,"network_name_as_in_text": "Covered Networks : 1.Limited Incl. NMC Royal Hosp.-Shj (ex.AZHS)"}],"has_multiple_networks": true},{"name": "Maternity","values_to_fill": {"LAB": {"copay": "0","deductible": "0","_copayAmount": "0","_maxDeductible": "0","_copayMaxAmount": "0","should_set_copay": true,"_deductibleLegacy": "0"},"MEDICINES": {"copay": "0","deductible": "0","_copayAmount": "0","_copayMaxAmount": "0","should_set_copay": true,"_deductibleLegacy": "0"},"PROCEDURE": {"copay": "0","deductible": "0","_copayAmount": "0","_copayMaxAmount": "0","should_set_copay": true,"_deductibleLegacy": "0"},"RADIOLOGY": {"copay": "0","deductible": "0","_copayAmount": "0","_copayMaxAmount": "0","should_set_copay": true,"_deductibleLegacy": "0"},"DIAGNOSTICS": {"copay": "0","deductible": "0","_copayAmount": "0","_copayMaxAmount": "0","should_set_copay": true,"_deductibleLegacy": "0"},"CONSULTATION": {"copay": "0","deductible": "0","_copayAmount": "0","_copayMaxAmount": "0","should_set_copay": true,"_deductibleLegacy": "0"},"PHYSIOTHERAPY": {"copay": "0","deductible": "0","_copayAmount": "0","_copayMaxAmount": "0","should_set_copay": true,"_deductibleLegacy": "0"},"DENTAL CONSULTATION & PROCEDURE": {"copay": "0","deductible": "0","_copayAmount": "0","_copayMaxAmount": "0","should_set_copay": true}},"primary_network": {"network": "LIMITED","network_status": null,"matched_plan_name": null},"available_networks": [{"network": "LIMITED","plan_code": "L003","visit_type": "IP (In Patient)","network_code": null,"network_value": "LIMITED","raw_plan_string": "LIMITED NETWORK - SHJ","matched_plan_name": null,"network_name_as_in_text": "Network (NW): IP & OP : Limited Incl. NMC"},{"network": "LIMITED","plan_code": "L003","visit_type": "OP (Out Patient)","network_code": null,"network_value": "LIMITED","raw_plan_string": "LIMITED NETWORK - SHJ","matched_plan_name": null,"network_name_as_in_text": "Network (NW): IP & OP : Limited Incl. NMC"},{"network": "LIMITED","plan_code": "L003","visit_type": "Not Specified","network_code": null,"network_value": "LIMITED","raw_plan_string": "LIMITED NETWORK - SHJ","matched_plan_name": null,"network_name_as_in_text": "Covered Networks : 1.Limited Incl. NMC Royal Hosp.-Shj (ex.AZHS)"}],"has_multiple_networks": true},{"name": "Specialization","values_to_fill": {"LAB": {"copay": "20.0","deductible": "0","_copayAmount": "0","_maxDeductible": "0","_copayMaxAmount": "0","should_set_copay": true,"_deductibleLegacy": "0","_is_outpatient_fallback": true},"MEDICINES": {"copay": "20.0","deductible": "0","_copayAmount": "0","_copayMaxAmount": "0","should_set_copay": true,"_deductibleLegacy": "0","_is_outpatient_fallback": true},"PROCEDURE": {"copay": "20.0","deductible": "0","_copayAmount": "0","_copayMaxAmount": "0","should_set_copay": true,"_deductibleLegacy": "0","_is_outpatient_fallback": true},"RADIOLOGY": {"copay": "20.0","deductible": "0","_copayAmount": "0","_copayMaxAmount": "0","should_set_copay": true,"_deductibleLegacy": "0","_is_outpatient_fallback": true},"DIAGNOSTICS": {"copay": "20.0","deductible": "0","_copayAmount": "0","_copayMaxAmount": "0","should_set_copay": true,"_deductibleLegacy": "0","_is_outpatient_fallback": true},"CONSULTATION": {"copay": "20.0","deductible": "0","_copayAmount": "0","_copayMaxAmount": "30.0","should_set_copay": true,"_deductibleLegacy": "30.0","_is_outpatient_fallback": true},"PHYSIOTHERAPY": {"copay": "20.0","deductible": "0","_copayAmount": "0","_copayMaxAmount": "0","should_set_copay": true,"_deductibleLegacy": "0","_is_outpatient_fallback": true},"DENTAL CONSULTATION & PROCEDURE": {"copay": "30.0","deductible": "0","_copayAmount": "0","_copayMaxAmount": "0","should_set_copay": true,"_deductibleLegacy": "0","_is_outpatient_fallback": true}},"primary_network": {"network": "LIMITED","network_status": null,"matched_plan_name": null},"available_networks": [{"network": "LIMITED","plan_code": "L003","visit_type": "IP (In Patient)","network_code": null,"network_value": "LIMITED","raw_plan_string": "LIMITED NETWORK - SHJ","matched_plan_name": null,"network_name_as_in_text": "Network (NW): IP & OP : Limited Incl. NMC"},{"network": "LIMITED","plan_code": "L003","visit_type": "OP (Out Patient)","network_code": null,"network_value": "LIMITED","raw_plan_string": "LIMITED NETWORK - SHJ","matched_plan_name": null,"network_name_as_in_text": "Network (NW): IP & OP : Limited Incl. NMC"},{"network": "LIMITED","plan_code": "L003","visit_type": "Not Specified","network_code": null,"network_value": "LIMITED","raw_plan_string": "LIMITED NETWORK - SHJ","matched_plan_name": null,"network_name_as_in_text": "Covered Networks : 1.Limited Incl. NMC Royal Hosp.-Shj (ex.AZHS)"}],"has_multiple_networks": true},{"name": "Inpatient","values_to_fill": {"LAB": {"copay": "0","deductible": "0","_copayAmount": "0","_copayMaxAmount": "0","should_set_copay": true},"MEDICINES": {"copay": "0","deductible": "0","_copayAmount": "0","_copayMaxAmount": "0","should_set_copay": true},"PROCEDURE": {"copay": "0","deductible": "0","_copayAmount": "0","_copayMaxAmount": "0","should_set_copay": true},"RADIOLOGY": {"copay": "0","deductible": "0","_copayAmount": "0","_copayMaxAmount": "0","should_set_copay": true},"DIAGNOSTICS": {"copay": "0","deductible": "0","_copayAmount": "0","_copayMaxAmount": "0","should_set_copay": true},"CONSULTATION": {"copay": "0","deductible": "0","_copayAmount": "0","_copayMaxAmount": "0","should_set_copay": true},"PHYSIOTHERAPY": {"copay": "0","deductible": "0","_copayAmount": "0","_copayMaxAmount": "0","should_set_copay": true},"DENTAL CONSULTATION & PROCEDURE": {"copay": "0","deductible": "0","_copayAmount": "0","_copayMaxAmount": "0","should_set_copay": true}},"primary_network": {"network": "LIMITED","network_status": null,"matched_plan_name": null},"available_networks": [{"network": "LIMITED","plan_code": "L003","visit_type": "IP (In Patient)","network_code": null,"network_value": "LIMITED","raw_plan_string": "LIMITED NETWORK - SHJ","matched_plan_name": null,"network_name_as_in_text": "Network (NW): IP & OP : Limited Incl. NMC"},{"network": "LIMITED","plan_code": "L003","visit_type": "OP (Out Patient)","network_code": null,"network_value": "LIMITED","raw_plan_string": "LIMITED NETWORK - SHJ","matched_plan_name": null,"network_name_as_in_text": "Network (NW): IP & OP : Limited Incl. NMC"},{"network": "LIMITED","plan_code": "L003","visit_type": "Not Specified","network_code": null,"network_value": "LIMITED","raw_plan_string": "LIMITED NETWORK - SHJ","matched_plan_name": null,"network_name_as_in_text": "Covered Networks : 1.Limited Incl. NMC Royal Hosp.-Shj (ex.AZHS)"}],"has_multiple_networks": true}],"policy_holder_emirates_id": "784-0000-0000000-0","was_identified_by_aggregator": false},"created_at": "2026-04-06T11:51:01.039000","message": null,"screenshot_url": null},{"tpa_name": "INS010","status": "member_not_found","data": {"payer_id": "INS010","show_data": false,"is_eligible": false,"screenshot_key": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z","was_identified_by_aggregator": false},"created_at": "2026-04-06T11:51:20.808000","message": "Member not found","screenshot_url": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z"},{"tpa_name": "TPA026","status": "member_not_found","data": {"payer_id": "TPA026","show_data": false,"is_eligible": false,"screenshot_key": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z","was_identified_by_aggregator": false},"created_at": "2026-04-06T11:51:29.852000","message": "Member with ID 784-0000-0000000-0 not found or member is inactive. Notification: member not found !!","screenshot_url": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z"},{"tpa_name": "INS017","status": "member_not_found","data": {"network": null,"payer_id": "INS017","show_data": false,"payer_name": null,"valid_upto": null,"is_eligible": false,"copay_details": null,"other_details": null,"failure_reason": "No visible policy details or eligibility indicators are present. The document contains an explicit 'Given Member ID/Emirates ID is invalid' message and lacks any validation indicators (policy ID, network, eligibility status). Therefore, eligibility cannot be established and is treated as not eligible based on the invalid ID instruction.","screenshot_key": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z","coverage_details": null,"is_policy_active": false,"policy_holder_dob": null,"policy_holder_name": null,"referral_documents": [],"policy_holder_phone": null,"policy_holder_gender": null,"policy_holder_last_name": null,"policy_holder_member_id": null,"payer_eligibility_status": null,"policy_holder_first_name": null,"policy_holder_card_number": null,"policy_holder_emirates_id": null,"policy_holder_middle_name": null,"policy_holder_relationship": null,"was_identified_by_aggregator": false},"created_at": "2026-04-06T11:52:20.288000","message": null,"screenshot_url": null},{"tpa_name": "TPA008","status": "invalid_credentials","data": null,"created_at": "2026-04-06T11:52:24.118000","message": "Invalid Credentials for TPA `Inayah`. Username used: `REDACTED`. Please ask your team admin to update the credentials.","screenshot_url": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z"}],"total_tpas_checked": 18,"found_results": 1,"created_at": "2026-04-06T09:22:16.177000","updated_at": "2026-04-06T12:09:36.567000"}
Highlighted on every entry of aggregated_results: tpa_name, status, message. The rest of the keys are documented on Results.
Each of those is a different message to a different person: the credential error
goes to whoever administers the clinic's payer logins, the timeout is worth one
retry, and tpa_not_configured is a fact about the clinic's setup that nobody
needs to see on a per-check basis.
What your code has to do
Check eligibility_result.status first, before reading anything under
data_dump.data. On a search-all, do it per entry in aggregated_results.
Never render a failure as "not covered". Say the check did not complete and
show message.
Retry failed and error once, and nothing else. Retrying
invalid_credentials is what causes backoff, and unlocking a locked payer
account takes manual intervention.
Log error_type and task_id. Those two are what support needs to find the
check.