Mantys Eligibility APIPolling
Poll GET /eligibility-result until the task reaches a terminal status. The response you are polling is the result.
GET /eligibility-result/{task_id}Use GET /eligibility-result/{task_id} to retrieve task progress and results.
It reports the task's current state while the check runs, and returns the
parsed result once the check is done, so the poll and the read are the same
request and an integration needs only two endpoints.
If your existing code uses task-status, see
the comparison at the bottom of this page.
When to stop
Stop when status is one of three values:
status | Meaning |
|---|---|
PROCESS_COMPLETE | Finished. The body you are holding is the result. |
CANCELLED | Stopped before finishing. |
FAILED | The task failed. Inspect eligibility_result for details. |
Anything else means the task is still running. Today those values are
IN_QUEUE, NAVIGATING_WEBSITE and EXTRACTING_DATA.
Most of the wait is spent in NAVIGATING_WEBSITE
A task enters this state as soon as the check starts and stays there for the whole exchange with the payer. Expect it on almost every poll, and do not read a long stretch of it as a stall.
EXTRACTING_DATA is not a stage every task passes through
It appears once there is a payer page to parse. A check that ends before that, because the login
was rejected or the payer was never reached, goes straight from NAVIGATING_WEBSITE to a terminal
status. Stop on the terminal statuses above, never on having seen a particular in-flight one.
Test for the terminal three, not against the in-flight ones
Write ["PROCESS_COMPLETE", "CANCELLED", "FAILED"].includes(status), not
status !== "IN_QUEUE" && …. The set of in-flight statuses can grow; the
terminal set has been stable. With an allowlist, a status you have never seen
makes your client keep waiting, which is correct, instead of making it read a
result that is not there.
CHECKING_ELIGIBILITY shows why this matters in both directions. It is defined
in the status enum and appears in older integration notes, but it is never
emitted. Do not build a state machine that waits for it.
PROCESS_COMPLETE does not mean eligible
It means the task is over. The member may not have been found, the portal credentials may have
been rejected, or the policy may have lapsed. The answer is eligibility_result.status plus
eligibility_result.data_dump.data.is_eligible; see Results.
Response
Prop
Type
{"id": "00000000-0000-4000-a000-000000000001","tenant_id": "yourorg","clinic_id": "00000000-0000-4000-a000-000000000002","created_at": "2026-03-18T20:17:12.012000","updated_at": "2026-03-18T20:26:05.740000","task_id": "00000000-0000-4000-a000-000000000001","status": "PROCESS_COMPLETE","request_dump": {"phone": "+971 50 000 0000","id_type": "CARDNUMBER","tpa_name": "TPA036","payerName": "MEDNET GLOBAL HEALTHCARE SOLUTIONS L.L.C.","doctorName": "Sample Clinician","extra_args": {"title": "LocationGroup","value": "OUTPATIENT"},"visit_type": "OUTPATIENT","emirates_id": "MBR-0000000","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": {"tpa_name": "TPA036","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"},{"id": "claim_form","tag": "Claim form","s3_url": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z"}]},"is_search_all": false,"search_all_status": null,"created_by_user_id": null,"eligibility_result": {"id": "00000000-0000-4000-a000-000000000001:TPA036","tenant_id": "yourorg","clinic_id": "00000000-0000-4000-a000-000000000002","created_at": "2026-03-18T20:26:05.904000","updated_at": "2026-03-18T20:26:05.904000","data_dump": {"tpa": "TPA036","data": {"payer_id": "TPA036","is_eligible": true,"patient_info": {"policy_holder_dob": "1990-01-01","policy_holder_name": "Sample Policy Holder","patient_emirates_id": null,"policy_holder_phone": "+971 50 000 0000","policy_holder_last_name": "Sample Policy Holder","policy_holder_first_name": "Sample Policy Holder","policy_primary_member_id": "MBR-0000000","policy_primary_dha_member_id": "0000000000"},"copay_analysis": {"copay_details": [{"remarks": "Citation: physician consultation deductible 50 aed | \n\n ","visit_type": "Consultation - Northern Emirates (NE)","copay_amount": null,"cost_sharing": {"visit_type": "Outpatient","copay_amount": null,"visit_setting": "Inpatient","copay_currency": null,"copay_percentage": null,"applicable_location": "Northern Emirates (NE)","copay_maximum_scope": null,"copay_maximum_amount": null,"coinsurance_percentage": null},"visit_setting": "Inpatient","copay_currency": null,"copay_max_scope": null,"copay_max_amount": null,"copay_percentage": "None","coinsurance_percentage": null},{"remarks": "Citation: laboratory services copayment 0% | \n\n ","visit_type": "Laboratory - Northern Emirates (NE)","copay_amount": 0,"cost_sharing": {"visit_type": "Outpatient","copay_amount": 0,"visit_setting": "Inpatient","copay_currency": "AED","copay_percentage": 0,"applicable_location": "Northern Emirates (NE)","copay_maximum_scope": null,"copay_maximum_amount": null,"coinsurance_percentage": null},"visit_setting": "Inpatient","copay_currency": "AED","copay_max_scope": null,"copay_max_amount": null,"copay_percentage": "0.0","coinsurance_percentage": null},{"remarks": "Citation: radiology services copayment 0% | \n\n ","visit_type": "Radiology - Northern Emirates (NE)","copay_amount": 0,"cost_sharing": {"visit_type": "Outpatient","copay_amount": 0,"visit_setting": "Inpatient","copay_currency": "AED","copay_percentage": 0,"applicable_location": "Northern Emirates (NE)","copay_maximum_scope": null,"copay_maximum_amount": null,"coinsurance_percentage": null},"visit_setting": "Inpatient","copay_currency": "AED","copay_max_scope": null,"copay_max_amount": null,"copay_percentage": "0.0","coinsurance_percentage": null},{"remarks": "Citation: outpatient services copayment 0% | \n\n ","visit_type": "Outpatient Services - Northern Emirates (NE)","copay_amount": 0,"cost_sharing": {"visit_type": "Outpatient","copay_amount": 0,"visit_setting": "Inpatient","copay_currency": "AED","copay_percentage": 0,"applicable_location": "Northern Emirates (NE)","copay_maximum_scope": null,"copay_maximum_amount": null,"coinsurance_percentage": null},"visit_setting": "Inpatient","copay_currency": "AED","copay_max_scope": null,"copay_max_amount": null,"copay_percentage": "0.0","coinsurance_percentage": null},{"remarks": "Citation: pharmaceutical copayment 0% | \n\n ","visit_type": "Pharmacy - Northern Emirates (NE)","copay_amount": 0,"cost_sharing": {"visit_type": "Outpatient","copay_amount": 0,"visit_setting": "Inpatient","copay_currency": "AED","copay_percentage": 0,"applicable_location": "Northern Emirates (NE)","copay_maximum_scope": null,"copay_maximum_amount": null,"coinsurance_percentage": null},"visit_setting": "Inpatient","copay_currency": "AED","copay_max_scope": null,"copay_max_amount": null,"copay_percentage": "0.0","coinsurance_percentage": null},{"remarks": "Citation: dental copayment 20% | \n\n Dental access covered on direct billing","visit_type": "Dental - Northern Emirates (NE)","copay_amount": null,"cost_sharing": {"visit_type": "Outpatient","copay_amount": null,"visit_setting": "Inpatient","copay_currency": "AED","copay_percentage": 20,"applicable_location": "Northern Emirates (NE)","copay_maximum_scope": null,"copay_maximum_amount": null,"coinsurance_percentage": null},"visit_setting": "Inpatient","copay_currency": "AED","copay_max_scope": null,"copay_max_amount": null,"copay_percentage": "20.0","coinsurance_percentage": null},{"remarks": "Citation: alternative medicine copayment 0% | \n\n Alternative medicine access reimbursment only","visit_type": "Alternative Medicine - Northern Emirates (NE)","copay_amount": 0,"cost_sharing": {"visit_type": "Outpatient","copay_amount": 0,"visit_setting": "Inpatient","copay_currency": "AED","copay_percentage": 0,"applicable_location": "Northern Emirates (NE)","copay_maximum_scope": null,"copay_maximum_amount": null,"coinsurance_percentage": null},"visit_setting": "Inpatient","copay_currency": "AED","copay_max_scope": null,"copay_max_amount": null,"copay_percentage": "0.0","coinsurance_percentage": null},{"remarks": "","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": "","visit_type": "Wellness","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": "Vaccination access covered on direct billing","visit_type": "Vaccination","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: maternity ip plan covered | \n\n ","visit_type": "Maternity Inpatient - Northern Emirates (NE)","copay_amount": 0,"cost_sharing": {"visit_type": "Maternity","copay_amount": 0,"visit_setting": "Inpatient","copay_currency": "AED","copay_percentage": 0,"applicable_location": "Northern Emirates (NE)","copay_maximum_scope": null,"copay_maximum_amount": null,"coinsurance_percentage": null},"visit_setting": "Inpatient","copay_currency": "AED","copay_max_scope": null,"copay_max_amount": null,"copay_percentage": "0.0","coinsurance_percentage": null},{"remarks": "Citation: physiotherapy services copayment 0% | \n\n ","visit_type": "Physiotherapy - Northern Emirates (NE)","copay_amount": 0,"cost_sharing": {"visit_type": "Outpatient","copay_amount": 0,"visit_setting": "Inpatient","copay_currency": "AED","copay_percentage": 0,"applicable_location": "Northern Emirates (NE)","copay_maximum_scope": null,"copay_maximum_amount": null,"coinsurance_percentage": null},"visit_setting": "Inpatient","copay_currency": "AED","copay_max_scope": null,"copay_max_amount": null,"copay_percentage": "0.0","coinsurance_percentage": null},{"remarks": "Citation: inpatient copay 0% | \n\n ","visit_type": "Inpatient - Northern Emirates (NE)","copay_amount": 0,"cost_sharing": {"visit_type": "Outpatient","copay_amount": 0,"visit_setting": "Inpatient","copay_currency": "AED","copay_percentage": 0,"applicable_location": "Northern Emirates (NE)","copay_maximum_scope": null,"copay_maximum_amount": null,"coinsurance_percentage": null},"visit_setting": "Inpatient","copay_currency": "AED","copay_max_scope": null,"copay_max_amount": null,"copay_percentage": "0.0","coinsurance_percentage": null},{"remarks": "","visit_type": "Psychiatric Inpatient","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": "","visit_type": "Wellness Check Up","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": "","visit_type": "Check-up","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}],"waiting_period": "waiting_period_time=0 waiting_period_unit='Months' waiting_period_starting_from='policy_start_date'","special_remarks": ["outpatient plan covered","pre-existing conditions waiting period (months) 0 month(s)","chronic condition waiting period (months) 0 month(s)"],"new_version_of_copay_analysis": {"benefits": [{"limits": null,"remarks": null,"conditions": null,"cost_sharing": [{"visit_type": "Outpatient","copay_amount": null,"visit_setting": "Inpatient","copay_currency": null,"copay_percentage": null,"applicable_location": "Northern Emirates (NE)","copay_maximum_scope": null,"copay_maximum_amount": null,"coinsurance_percentage": null}],"coverage_status": "Covered","service_category_original": "Physician Consultation","service_category_standardized": "Consultation"},{"limits": null,"remarks": null,"conditions": null,"cost_sharing": [{"visit_type": "Outpatient","copay_amount": 0,"visit_setting": "Inpatient","copay_currency": "AED","copay_percentage": 0,"applicable_location": "Northern Emirates (NE)","copay_maximum_scope": null,"copay_maximum_amount": null,"coinsurance_percentage": null}],"coverage_status": "Covered","service_category_original": "Laboratory Services","service_category_standardized": "Laboratory"},{"limits": null,"remarks": null,"conditions": null,"cost_sharing": [{"visit_type": "Outpatient","copay_amount": 0,"visit_setting": "Inpatient","copay_currency": "AED","copay_percentage": 0,"applicable_location": "Northern Emirates (NE)","copay_maximum_scope": null,"copay_maximum_amount": null,"coinsurance_percentage": null}],"coverage_status": "Covered","service_category_original": "Radiology Services","service_category_standardized": "Radiology"},{"limits": null,"remarks": null,"conditions": null,"cost_sharing": [{"visit_type": "Outpatient","copay_amount": 0,"visit_setting": "Inpatient","copay_currency": "AED","copay_percentage": 0,"applicable_location": "Northern Emirates (NE)","copay_maximum_scope": null,"copay_maximum_amount": null,"coinsurance_percentage": null}],"coverage_status": "Covered","service_category_original": null,"service_category_standardized": "Outpatient Services"},{"limits": null,"remarks": null,"conditions": null,"cost_sharing": [{"visit_type": "Outpatient","copay_amount": 0,"visit_setting": "Inpatient","copay_currency": "AED","copay_percentage": 0,"applicable_location": "Northern Emirates (NE)","copay_maximum_scope": null,"copay_maximum_amount": null,"coinsurance_percentage": null}],"coverage_status": "Covered","service_category_original": "Pharmaceutical","service_category_standardized": "Pharmacy"},{"limits": null,"remarks": "Dental access covered on direct billing","conditions": null,"cost_sharing": [{"visit_type": "Outpatient","copay_amount": null,"visit_setting": "Inpatient","copay_currency": "AED","copay_percentage": 20,"applicable_location": "Northern Emirates (NE)","copay_maximum_scope": null,"copay_maximum_amount": null,"coinsurance_percentage": null}],"coverage_status": "Covered","service_category_original": "Dental","service_category_standardized": "Dental"},{"limits": null,"remarks": "Alternative medicine access reimbursment only","conditions": null,"cost_sharing": [{"visit_type": "Outpatient","copay_amount": 0,"visit_setting": "Inpatient","copay_currency": "AED","copay_percentage": 0,"applicable_location": "Northern Emirates (NE)","copay_maximum_scope": null,"copay_maximum_amount": null,"coinsurance_percentage": null}],"coverage_status": "Covered","service_category_original": "Alternative Medicine","service_category_standardized": "Alternative Medicine"},{"limits": null,"remarks": null,"conditions": null,"cost_sharing": [],"coverage_status": "Not Covered","service_category_original": "Optical","service_category_standardized": "Optical"},{"limits": null,"remarks": null,"conditions": null,"cost_sharing": [],"coverage_status": "Not Covered","service_category_original": null,"service_category_standardized": "Wellness"},{"limits": null,"remarks": "Vaccination access covered on direct billing","conditions": null,"cost_sharing": [],"coverage_status": "Not Covered","service_category_original": null,"service_category_standardized": "Vaccination"},{"limits": null,"remarks": null,"conditions": null,"cost_sharing": [{"visit_type": "Maternity","copay_amount": 0,"visit_setting": "Inpatient","copay_currency": "AED","copay_percentage": 0,"applicable_location": "Northern Emirates (NE)","copay_maximum_scope": null,"copay_maximum_amount": null,"coinsurance_percentage": null}],"coverage_status": "Covered","service_category_original": "Maternity IP","service_category_standardized": "Maternity Inpatient"},{"limits": null,"remarks": null,"conditions": null,"cost_sharing": [{"visit_type": "Outpatient","copay_amount": 0,"visit_setting": "Inpatient","copay_currency": "AED","copay_percentage": 0,"applicable_location": "Northern Emirates (NE)","copay_maximum_scope": null,"copay_maximum_amount": null,"coinsurance_percentage": null}],"coverage_status": "Covered","service_category_original": "Physiotherapy Services","service_category_standardized": "Physiotherapy"},{"limits": null,"remarks": null,"conditions": null,"cost_sharing": [{"visit_type": "Outpatient","copay_amount": 0,"visit_setting": "Inpatient","copay_currency": "AED","copay_percentage": 0,"applicable_location": "Northern Emirates (NE)","copay_maximum_scope": null,"copay_maximum_amount": null,"coinsurance_percentage": null}],"coverage_status": "Covered","service_category_original": null,"service_category_standardized": "Inpatient"},{"limits": null,"remarks": null,"conditions": null,"cost_sharing": [],"coverage_status": "Not Covered","service_category_original": "Psychiatric IP","service_category_standardized": "Psychiatric Inpatient"},{"limits": null,"remarks": null,"conditions": null,"cost_sharing": [],"coverage_status": "Not Covered","service_category_original": null,"service_category_standardized": "Wellness Check Up"},{"limits": null,"remarks": null,"conditions": null,"cost_sharing": [],"coverage_status": "Not Covered","service_category_original": null,"service_category_standardized": "Check-up"}],"policy_info": {"waiting_period": {"waiting_period_time": 0,"waiting_period_unit": "Months","waiting_period_starting_from": "policy_start_date"},"policy_period_end": null,"policy_jurisdiction": "Not Specified","policy_period_start": null,"beneficiary_start_date": null},"general_remarks": ["pre-existing conditions waiting period (months) 0 month(s)","chronic condition waiting period (months) 0 month(s)","outpatient plan covered"],"abbreviations_defined": []}},"failure_reason": null,"policy_network": {"is_vip": "Not Mentioned","payer_name": "ORIENT INSURANCE PJSC - INS008","sponsor_id": null,"start_date": "2025-06-02","valid_upto": "2026-06-01","all_networks": [{"network": "Silver Premium","plan_code": "P025-2-DXB","visit_type": "OP (Out Patient)","network_code": null,"network_value": "Silver Premium","raw_plan_string": "INS008 - ORIENT INSURANCE COMPANY - MEDNET - SILVER PREMIUM - DXB","matched_plan_name": null,"network_name_as_in_text": "Silver Premium"}],"package_name": null,"is_gatekeeper": "Not Mentioned","waiting_period": null,"policy_authority": "DOH","policy_plan_name": null,"work_site_covered": "Could not determine","policy_holder_name": "Sample Policy Holder","payer_name_as_in_text": "Orient Insurance PJSC_Enhanced_Individual_52","HAAD_or_DHA_Approval_Number": "REF-0000000","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","warning_messages": [],"policy_holder_dob": "1990-01-01","policy_holder_name": "Sample Policy Holder","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"},{"id": "claim_form","tag": "Claim form","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": "0.0","deductible": "0.0","_copayAmount": "0.0","_maxDeductible": "0","_copayMaxAmount": "0","should_set_copay": true,"_deductibleLegacy": "0.0"},"MEDICINES": {"copay": "0.0","deductible": "0.0","_copayAmount": "0.0","_copayMaxAmount": "0","should_set_copay": true,"_deductibleLegacy": "0.0"},"PROCEDURE": {"copay": "0.0","deductible": "0.0","_copayAmount": "0.0","_copayMaxAmount": "0","should_set_copay": true,"_deductibleLegacy": "0.0"},"RADIOLOGY": {"copay": "0.0","deductible": "0.0","_copayAmount": "0.0","_copayMaxAmount": "0","should_set_copay": true,"_deductibleLegacy": "0.0"},"CONSULTATION": {"copay": "0.0","deductible": "0.0","_copayAmount": "0.0","_copayMaxAmount": "0","should_set_copay": true,"_deductibleLegacy": "0.0"},"PHYSIOTHERAPY": {"copay": "0.0","deductible": "0.0","_copayAmount": "0.0","_copayMaxAmount": "0","should_set_copay": true,"_deductibleLegacy": "0.0"},"DENTAL CONSULTATION & PROCEDURE": {"copay": "20.0","deductible": "0","_copayAmount": "0","_copayMaxAmount": "0","should_set_copay": true,"_deductibleLegacy": "0"}},"primary_network": {"network": "Silver Premium","network_status": null,"matched_plan_name": null},"available_networks": [{"network": "Silver Premium","plan_code": "P025-2-DXB","visit_type": "OP (Out Patient)","network_code": null,"network_value": "Silver Premium","raw_plan_string": "INS008 - ORIENT INSURANCE COMPANY - MEDNET - SILVER PREMIUM - DXB","matched_plan_name": null,"network_name_as_in_text": "Silver Premium"}],"has_multiple_networks": false},{"name": "Maternity","values_to_fill": {"LAB": {"copay": "0.0","deductible": "0.0","_copayAmount": "0.0","_maxDeductible": "0","_copayMaxAmount": "0","should_set_copay": true,"_deductibleLegacy": "0.0"},"MEDICINES": {"copay": "0.0","deductible": "0.0","_copayAmount": "0.0","_copayMaxAmount": "0","should_set_copay": true,"_deductibleLegacy": "0.0"},"PROCEDURE": {"copay": "0.0","deductible": "0.0","_copayAmount": "0.0","_copayMaxAmount": "0","should_set_copay": true,"_deductibleLegacy": "0.0"},"RADIOLOGY": {"copay": "0.0","deductible": "0.0","_copayAmount": "0.0","_copayMaxAmount": "0","should_set_copay": true,"_deductibleLegacy": "0.0"},"CONSULTATION": {"copay": "0.0","deductible": "0.0","_copayAmount": "0.0","_copayMaxAmount": "0","should_set_copay": true,"_deductibleLegacy": "0.0"},"PHYSIOTHERAPY": {"copay": "0.0","deductible": "0.0","_copayAmount": "0.0","_copayMaxAmount": "0","should_set_copay": true,"_deductibleLegacy": "0.0"},"DENTAL CONSULTATION & PROCEDURE": {"copay": "0","deductible": "0","_copayAmount": "0","_copayMaxAmount": "0","should_set_copay": true}},"primary_network": {"network": "Silver Premium","network_status": null,"matched_plan_name": null},"available_networks": [{"network": "Silver Premium","plan_code": "P025-2-DXB","visit_type": "OP (Out Patient)","network_code": null,"network_value": "Silver Premium","raw_plan_string": "INS008 - ORIENT INSURANCE COMPANY - MEDNET - SILVER PREMIUM - DXB","matched_plan_name": null,"network_name_as_in_text": "Silver Premium"}],"has_multiple_networks": false},{"name": "Specialization","values_to_fill": {"LAB": {"copay": "0.0","deductible": "0.0","_copayAmount": "0.0","_maxDeductible": "0","_copayMaxAmount": "0","should_set_copay": true,"_deductibleLegacy": "0.0","_is_outpatient_fallback": true},"MEDICINES": {"copay": "0.0","deductible": "0.0","_copayAmount": "0.0","_copayMaxAmount": "0","should_set_copay": true,"_deductibleLegacy": "0.0","_is_outpatient_fallback": true},"PROCEDURE": {"copay": "0.0","deductible": "0.0","_copayAmount": "0.0","_copayMaxAmount": "0","should_set_copay": true,"_deductibleLegacy": "0.0","_is_outpatient_fallback": true},"RADIOLOGY": {"copay": "0.0","deductible": "0.0","_copayAmount": "0.0","_copayMaxAmount": "0","should_set_copay": true,"_deductibleLegacy": "0.0","_is_outpatient_fallback": true},"CONSULTATION": {"copay": "0.0","deductible": "0.0","_copayAmount": "0.0","_copayMaxAmount": "0","should_set_copay": true,"_deductibleLegacy": "0.0","_is_outpatient_fallback": true},"PHYSIOTHERAPY": {"copay": "0.0","deductible": "0.0","_copayAmount": "0.0","_copayMaxAmount": "0","should_set_copay": true,"_deductibleLegacy": "0.0","_is_outpatient_fallback": true},"DENTAL CONSULTATION & PROCEDURE": {"copay": "20.0","deductible": "0","_copayAmount": "0","_copayMaxAmount": "0","should_set_copay": true,"_deductibleLegacy": "0","_is_outpatient_fallback": true}},"primary_network": {"network": "Silver Premium","network_status": null,"matched_plan_name": null},"available_networks": [{"network": "Silver Premium","plan_code": "P025-2-DXB","visit_type": "OP (Out Patient)","network_code": null,"network_value": "Silver Premium","raw_plan_string": "INS008 - ORIENT INSURANCE COMPANY - MEDNET - SILVER PREMIUM - DXB","matched_plan_name": null,"network_name_as_in_text": "Silver Premium"}],"has_multiple_networks": false},{"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},"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": "Silver Premium","network_status": null,"matched_plan_name": null},"available_networks": [{"network": "Silver Premium","plan_code": "P025-2-DXB","visit_type": "OP (Out Patient)","network_code": null,"network_value": "Silver Premium","raw_plan_string": "INS008 - ORIENT INSURANCE COMPANY - MEDNET - SILVER PREMIUM - DXB","matched_plan_name": null,"network_name_as_in_text": "Silver Premium"}],"has_multiple_networks": false}],"policy_holder_emirates_id": null,"was_identified_by_aggregator": false},"status": "found"},"search_id": "0000-0000-0000-0000","tpa_name": "TPA036","task_id": "00000000-0000-4000-a000-000000000001","user_id": null,"status": "found"}}
While the task is in flight, eligibility_result is absent. Once it appears,
the task is done or nearly so, and its data_dump is the full result.
Interim results
Partway through a check the payer's response and any accompanying documents
are available, but parsing is not finished. At that point this endpoint starts
returning an interim_results block.
Prop
Type
{"id": "00000000-0000-4000-a000-000000000001","tenant_id": "yourorg","clinic_id": "00000000-0000-4000-a000-000000000002","created_at": "2026-01-20T04:06:49.200000","updated_at": "2026-01-20T04:08:27.477000","task_id": "00000000-0000-4000-a000-000000000001","status": "PROCESS_COMPLETE","request_dump": {"phone": "+971 50 000 0000","id_type": "CARDNUMBER","tpa_name": "INS012","payerName": "","doctorName": "Sample Clinician","extra_args": {"title": "","value": ""},"visit_type": "OUTPATIENT","emirates_id": "MBR-0000000","practice_id": "00000000-0000-4000-a000-000000000002","user_id": "00000000-0000-4000-a000-000000000003","name": null,"dob": null,"mode": "prod","test_mode": false},"interim_results": {"tpa_name": "INS012","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"}]},"is_search_all": false,"search_all_status": null,"created_by_user_id": null,"eligibility_result": {"id": "00000000-0000-4000-a000-000000000001:INS012","tenant_id": "yourorg","clinic_id": "00000000-0000-4000-a000-000000000002","created_at": "2026-01-20T04:08:27.622000","updated_at": "2026-01-20T04:08:27.622000","data_dump": {"tpa": "INS012","data": {"payer_id": "INS012","is_eligible": true,"patient_info": {"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": "Citation: Mediclinic group DXB all OP Copay @20% excludes Maternity related service | \n\n Provider Terms: Mediclinic group DXB all OP Copay @20% excludes Maternity related service; NIL All OP/Maternity Copay for In house clinics(Dubai medical & Al Taweelah)","visit_type": "Consultation - Other Hospitals or Clinics - Dubai","copay_amount": null,"cost_sharing": {"visit_type": "Outpatient","copay_amount": null,"visit_setting": "Outpatient","copay_currency": "AED","copay_percentage": 20,"applicable_location": "Dubai","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: NIL All OP/Maternity Copay for In house clinics(Dubai medical & Al Taweelah) | \n\n Citation: Mediclinic group DXB all OP Copay @20% excludes Maternity related service | \n\n Provider Terms: Mediclinic group DXB all OP Copay @20% excludes Maternity related service; NIL All OP/Maternity Copay for In house clinics(Dubai medical & Al Taweelah)","visit_type": "Consultation - Other Hospitals or Clinics - Dubai and Northern Emirates","copay_amount": null,"cost_sharing": {"visit_type": "Outpatient","copay_amount": null,"visit_setting": "Outpatient","copay_currency": "AED","copay_percentage": 0,"applicable_location": "Dubai and Northern Emirates","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": "0.0","coinsurance_percentage": null},{"remarks": "Citation: Other Providers OP Cons:20% Max AED 50/- Per visit | \n\n Citation: NIL All OP/Maternity Copay for In house clinics(Dubai medical & Al Taweelah) | \n\n Citation: Mediclinic group DXB all OP Copay @20% excludes Maternity related service | \n\n Provider Terms: Mediclinic group DXB all OP Copay @20% excludes Maternity related service; NIL All OP/Maternity Copay for In house clinics(Dubai medical & Al Taweelah)","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": 50,"coinsurance_percentage": null},"visit_setting": "Outpatient","copay_currency": "AED","copay_max_scope": "per visit","copay_max_amount": 50,"copay_percentage": "20.0","coinsurance_percentage": null},{"remarks": "Citation: NIL All OP/Maternity Copay for In house clinics(Dubai medical & Al Taweelah) | \n\n Provider Terms: NIL All OP/Maternity Copay for In house clinics(Dubai medical & Al Taweelah)","visit_type": "Maternity Consultation - Other Hospitals or Clinics - Dubai and Northern Emirates","copay_amount": null,"cost_sharing": {"visit_type": "Maternity","copay_amount": null,"visit_setting": "Outpatient","copay_currency": "AED","copay_percentage": 0,"applicable_location": "Dubai and Northern Emirates","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": "0.0","coinsurance_percentage": null},{"remarks": "Citation: All Other providers Maternity Cons:10% Max AED50/- per visit | \n\n Citation: NIL All OP/Maternity Copay for In house clinics(Dubai medical & Al Taweelah) | \n\n Provider Terms: NIL All OP/Maternity Copay for In house clinics(Dubai medical & Al Taweelah)","visit_type": "Maternity Consultation","copay_amount": null,"cost_sharing": {"visit_type": "Maternity","copay_amount": null,"visit_setting": "Outpatient","copay_currency": "AED","copay_percentage": 10,"applicable_location": "UAE","copay_maximum_scope": "per visit","copay_maximum_amount": 50,"coinsurance_percentage": null},"visit_setting": "Outpatient","copay_currency": "AED","copay_max_scope": "per visit","copay_max_amount": 50,"copay_percentage": "10.0","coinsurance_percentage": null},{"remarks": "Citation: OP Pharmacy:20% Coinsurance | \n\n ","visit_type": "Pharmacy","copay_amount": null,"cost_sharing": {"visit_type": "Outpatient","copay_amount": null,"visit_setting": "Outpatient","copay_currency": null,"copay_percentage": 20,"applicable_location": "UAE","copay_maximum_scope": null,"copay_maximum_amount": null,"coinsurance_percentage": null},"visit_setting": "Outpatient","copay_currency": null,"copay_max_scope": null,"copay_max_amount": null,"copay_percentage": "20.0","coinsurance_percentage": null},{"remarks": "Citation: OP Mat Pharma:10% Coins | \n\n ","visit_type": "Pharmacy (Maternity)","copay_amount": null,"cost_sharing": {"visit_type": "Maternity","copay_amount": null,"visit_setting": "Outpatient","copay_currency": null,"copay_percentage": 10,"applicable_location": "UAE","copay_maximum_scope": null,"copay_maximum_amount": null,"coinsurance_percentage": null},"visit_setting": "Outpatient","copay_currency": null,"copay_max_scope": null,"copay_max_amount": null,"copay_percentage": "10.0","coinsurance_percentage": null},{"remarks": "Citation: Routine Dental:20% Copay | \n\n ","visit_type": "Dental","copay_amount": null,"cost_sharing": {"visit_type": "Outpatient","copay_amount": null,"visit_setting": "Outpatient","copay_currency": null,"copay_percentage": 20,"applicable_location": "UAE","copay_maximum_scope": null,"copay_maximum_amount": null,"coinsurance_percentage": null},"visit_setting": "Outpatient","copay_currency": null,"copay_max_scope": null,"copay_max_amount": null,"copay_percentage": "20.0","coinsurance_percentage": null},{"remarks": "Citation: Optical Benefit:20% Copay on RI | \n\n ","visit_type": "Optical","copay_amount": null,"cost_sharing": {"visit_type": "Outpatient","copay_amount": null,"visit_setting": "Outpatient","copay_currency": null,"copay_percentage": 20,"applicable_location": "UAE","copay_maximum_scope": null,"copay_maximum_amount": null,"coinsurance_percentage": null},"visit_setting": "Outpatient","copay_currency": null,"copay_max_scope": null,"copay_max_amount": null,"copay_percentage": "20.0","coinsurance_percentage": null}],"waiting_period": "Not Specified","special_remarks": ["Provider Terms: NIL All OP/Maternity Copay for In house clinics(Dubai medical & Al Taweelah)","NIL All OP/Maternity Copay for In house clinics (Dubai medical & Al Taweelah)","Network Restrictions: EDGE Network","Provider Terms: Mediclinic group DXB all OP Copay @20% excludes Maternity related service; NIL All OP/Maternity Copay for In house clinics(Dubai medical & Al Taweelah)","Mediclinic group DXB all OP Copay @20% excludes Maternity related service"],"new_version_of_copay_analysis": {"benefits": [{"limits": null,"remarks": null,"conditions": {"referral_required": null,"referral_exceptions": null,"network_restrictions": "EDGE Network","pre_approval_required": "No","provider_specific_terms": "Mediclinic group DXB all OP Copay @20% excludes Maternity related service; NIL All OP/Maternity Copay for In house clinics(Dubai medical & Al Taweelah)","pre_approval_threshold_scope": null,"pre_approval_threshold_amount": null,"pre_approval_specific_services": null,"pre_approval_threshold_currency": null},"cost_sharing": [{"visit_type": "Outpatient","copay_amount": null,"visit_setting": "Outpatient","copay_currency": "AED","copay_percentage": 20,"applicable_location": "Dubai","copay_maximum_scope": null,"copay_maximum_amount": null,"coinsurance_percentage": null},{"visit_type": "Outpatient","copay_amount": null,"visit_setting": "Outpatient","copay_currency": "AED","copay_percentage": 0,"applicable_location": "Dubai and Northern Emirates","copay_maximum_scope": null,"copay_maximum_amount": null,"coinsurance_percentage": null},{"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": 50,"coinsurance_percentage": null}],"coverage_status": "Covered","service_category_original": "OP Cons","service_category_standardized": "Consultation"},{"limits": null,"remarks": null,"conditions": {"referral_required": null,"referral_exceptions": null,"network_restrictions": "EDGE Network","pre_approval_required": "No","provider_specific_terms": "NIL All OP/Maternity Copay for In house clinics(Dubai medical & Al Taweelah)","pre_approval_threshold_scope": null,"pre_approval_threshold_amount": null,"pre_approval_specific_services": null,"pre_approval_threshold_currency": null},"cost_sharing": [{"visit_type": "Maternity","copay_amount": null,"visit_setting": "Outpatient","copay_currency": "AED","copay_percentage": 0,"applicable_location": "Dubai and Northern Emirates","copay_maximum_scope": null,"copay_maximum_amount": null,"coinsurance_percentage": null},{"visit_type": "Maternity","copay_amount": null,"visit_setting": "Outpatient","copay_currency": "AED","copay_percentage": 10,"applicable_location": "UAE","copay_maximum_scope": "per visit","copay_maximum_amount": 50,"coinsurance_percentage": null}],"coverage_status": "Covered","service_category_original": "Maternity Cons","service_category_standardized": "Maternity Consultation"},{"limits": null,"remarks": null,"conditions": {"referral_required": null,"referral_exceptions": null,"network_restrictions": "EDGE Network","pre_approval_required": "No","provider_specific_terms": null,"pre_approval_threshold_scope": null,"pre_approval_threshold_amount": null,"pre_approval_specific_services": null,"pre_approval_threshold_currency": null},"cost_sharing": [{"visit_type": "Outpatient","copay_amount": null,"visit_setting": "Outpatient","copay_currency": null,"copay_percentage": 20,"applicable_location": "UAE","copay_maximum_scope": null,"copay_maximum_amount": null,"coinsurance_percentage": null}],"coverage_status": "Covered","service_category_original": "OP Pharmacy","service_category_standardized": "Pharmacy"},{"limits": null,"remarks": null,"conditions": {"referral_required": null,"referral_exceptions": null,"network_restrictions": "EDGE Network","pre_approval_required": "No","provider_specific_terms": null,"pre_approval_threshold_scope": null,"pre_approval_threshold_amount": null,"pre_approval_specific_services": null,"pre_approval_threshold_currency": null},"cost_sharing": [{"visit_type": "Maternity","copay_amount": null,"visit_setting": "Outpatient","copay_currency": null,"copay_percentage": 10,"applicable_location": "UAE","copay_maximum_scope": null,"copay_maximum_amount": null,"coinsurance_percentage": null}],"coverage_status": "Covered","service_category_original": "OP Mat Pharma","service_category_standardized": "Pharmacy (Maternity)"},{"limits": null,"remarks": null,"conditions": {"referral_required": null,"referral_exceptions": null,"network_restrictions": "EDGE Network","pre_approval_required": "No","provider_specific_terms": null,"pre_approval_threshold_scope": null,"pre_approval_threshold_amount": null,"pre_approval_specific_services": null,"pre_approval_threshold_currency": null},"cost_sharing": [{"visit_type": "Outpatient","copay_amount": null,"visit_setting": "Outpatient","copay_currency": null,"copay_percentage": 20,"applicable_location": "UAE","copay_maximum_scope": null,"copay_maximum_amount": null,"coinsurance_percentage": null}],"coverage_status": "Covered","service_category_original": "Routine Dental","service_category_standardized": "Dental"},{"limits": null,"remarks": null,"conditions": {"referral_required": null,"referral_exceptions": null,"network_restrictions": "EDGE Network","pre_approval_required": "No","provider_specific_terms": null,"pre_approval_threshold_scope": null,"pre_approval_threshold_amount": null,"pre_approval_specific_services": null,"pre_approval_threshold_currency": null},"cost_sharing": [{"visit_type": "Outpatient","copay_amount": null,"visit_setting": "Outpatient","copay_currency": null,"copay_percentage": 20,"applicable_location": "UAE","copay_maximum_scope": null,"copay_maximum_amount": null,"coinsurance_percentage": null}],"coverage_status": "Covered","service_category_original": "Optical Benefit","service_category_standardized": "Optical"}],"policy_info": {"waiting_period": "Not Specified","policy_period_end": {"DD": 31,"MM": 12,"YYYY": 2026},"policy_jurisdiction": "DHA","policy_period_start": {"DD": 1,"MM": 1,"YYYY": 2026},"beneficiary_start_date": {"DD": 1,"MM": 1,"YYYY": 2026}},"general_remarks": ["Mediclinic group DXB all OP Copay @20% excludes Maternity related service","NIL All OP/Maternity Copay for In house clinics (Dubai medical & Al Taweelah)"],"abbreviations_defined": []}},"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": "SUKOON EDGE - OP","plan_code": "DXSHJ-P787","visit_type": "OP (Out Patient)","network_code": null,"network_value": "Edge","raw_plan_string": "INS012 - OMAN (SUKOON) INSURANCE COMPANY - SUKOON(OMAN) - EDGE - DXB-SHJ","matched_plan_name": "SUKOON EDGE - OP","network_name_as_in_text": "NETWORK: EDGE / BENEFITS: Direct Billing"}],"package_name": null,"is_gatekeeper": "Not Mentioned","waiting_period": null,"policy_authority": "DHA","policy_plan_name": null,"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","warning_messages": [],"policy_holder_name": "Sample Policy Holder","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": [{"name": "Outpatient","values_to_fill": {"LAB": {"copay": "0","deductible": "0","_copayAmount": "0","_copayMaxAmount": "0","should_set_copay": true},"MEDICINES": {"copay": "20.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},"RADIOLOGY": {"copay": "0","deductible": "0","_copayAmount": "0","_copayMaxAmount": "0","should_set_copay": true},"CONSULTATION": {"copay": "20.0","deductible": "0","_copayAmount": "0","_copayMaxAmount": "50.0","should_set_copay": true,"_deductibleLegacy": "50.0"},"DENTAL CONSULTATION & PROCEDURE": {"copay": "20.0","deductible": "0","_copayAmount": "0","_copayMaxAmount": "0","should_set_copay": true,"_deductibleLegacy": "0"}},"primary_network": {"network": "SUKOON EDGE - OP","network_status": null,"matched_plan_name": "SUKOON EDGE - OP"},"available_networks": [{"network": "SUKOON EDGE - OP","plan_code": "DXSHJ-P787","visit_type": "OP (Out Patient)","network_code": null,"network_value": "Edge","raw_plan_string": "INS012 - OMAN (SUKOON) INSURANCE COMPANY - SUKOON(OMAN) - EDGE - DXB-SHJ","matched_plan_name": "SUKOON EDGE - OP","network_name_as_in_text": "NETWORK: EDGE / BENEFITS: Direct Billing"}],"has_multiple_networks": false},{"name": "Maternity","values_to_fill": {"LAB": {"copay": "0","deductible": "0","_copayAmount": "0","_copayMaxAmount": "0","should_set_copay": true},"MEDICINES": {"copay": "10.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},"RADIOLOGY": {"copay": "0","deductible": "0","_copayAmount": "0","_copayMaxAmount": "0","should_set_copay": true},"CONSULTATION": {"copay": "0.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": "SUKOON EDGE - OP","network_status": null,"matched_plan_name": "SUKOON EDGE - OP"},"available_networks": [{"network": "SUKOON EDGE - OP","plan_code": "DXSHJ-P787","visit_type": "OP (Out Patient)","network_code": null,"network_value": "Edge","raw_plan_string": "INS012 - OMAN (SUKOON) INSURANCE COMPANY - SUKOON(OMAN) - EDGE - DXB-SHJ","matched_plan_name": "SUKOON EDGE - OP","network_name_as_in_text": "NETWORK: EDGE / BENEFITS: Direct Billing"}],"has_multiple_networks": false},{"name": "Specialization","values_to_fill": {"LAB": {"copay": "0","deductible": "0","_copayAmount": "0","_copayMaxAmount": "0","should_set_copay": true},"MEDICINES": {"copay": "20.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},"RADIOLOGY": {"copay": "0","deductible": "0","_copayAmount": "0","_copayMaxAmount": "0","should_set_copay": true},"CONSULTATION": {"copay": "20.0","deductible": "0","_copayAmount": "0","_copayMaxAmount": "50.0","should_set_copay": true,"_deductibleLegacy": "50.0"},"DENTAL CONSULTATION & PROCEDURE": {"copay": "20.0","deductible": "0","_copayAmount": "0","_copayMaxAmount": "0","should_set_copay": true,"_deductibleLegacy": "0"}},"primary_network": {"network": "SUKOON EDGE - OP","network_status": null,"matched_plan_name": "SUKOON EDGE - OP"},"available_networks": [{"network": "SUKOON EDGE - OP","plan_code": "DXSHJ-P787","visit_type": "OP (Out Patient)","network_code": null,"network_value": "Edge","raw_plan_string": "INS012 - OMAN (SUKOON) INSURANCE COMPANY - SUKOON(OMAN) - EDGE - DXB-SHJ","matched_plan_name": "SUKOON EDGE - OP","network_name_as_in_text": "NETWORK: EDGE / BENEFITS: Direct Billing"}],"has_multiple_networks": false},{"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},"CONSULTATION": {"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": "SUKOON EDGE - OP","network_status": null,"matched_plan_name": "SUKOON EDGE - OP"},"available_networks": [{"network": "SUKOON EDGE - OP","plan_code": "DXSHJ-P787","visit_type": "OP (Out Patient)","network_code": null,"network_value": "Edge","raw_plan_string": "INS012 - OMAN (SUKOON) INSURANCE COMPANY - SUKOON(OMAN) - EDGE - DXB-SHJ","matched_plan_name": "SUKOON EDGE - OP","network_name_as_in_text": "NETWORK: EDGE / BENEFITS: Direct Billing"}],"has_multiple_networks": false}],"policy_holder_emirates_id": "784-0000-0000000-0","was_identified_by_aggregator": false},"status": "found"},"search_id": "0000-0000-0000-0000","tpa_name": "INS012","task_id": "00000000-0000-4000-a000-000000000001","user_id": null,"status": "found"}}
Highlighted: interim_results. Every other key on the response is documented on Results.
Use it to show the user the portal screenshot while the parse finishes. It is not a substitute for the result: the parsed coverage, copay and network data only exist once the task is complete.
interim_results is null on a task that has not reached that stage, and it
is absent entirely on search-all tasks.
interim_results is only on this endpoint
task-status never returns it, so an integration polling that endpoint has to call this one as
well to show anything before the check finishes.
Search all
A search-all task carries a different envelope: no eligibility_result, an
aggregated_results array instead.
Prop
Type
Each entry in aggregated_results is one payer's answer:
Prop
Type
{"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": ""},"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": "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-10-12T10:00:45.657000","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": "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-10-12T10:02:18.221000","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": "TPA029","status": "failed","data": null,"created_at": "2025-10-12T10:00:29.075000","message": "TPA `TPA029` is not configured for the practice.","screenshot_url": null},{"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-10-12T10:00:39.046000","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": "INS038","status": "failed","data": null,"created_at": "2025-10-12T10:00:47.429000","message": "Failed to login - invalid credentials","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": "The page does not provide valid insurance details or confirmation of eligibility. It specifically shows a 'Member not found' error message, lacking any policy details or copay 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": "2025-10-12T10:00:52.589000","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": "2025-10-12T10:00:39.969000","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": "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": "2025-10-12T10:00:41.289000","message": "No results 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": "TPA008","status": "member_not_found","data": {"network": null,"payer_id": "TPA008","show_data": false,"payer_name": null,"valid_upto": null,"is_eligible": false,"copay_details": null,"other_details": null,"failure_reason": "The document contains an error ('Member ID does not match...') and lacks evidence of eligibility, making the person 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": "2025-10-12T10:01:48.878000","message": null,"screenshot_url": null},{"tpa_name": "DHPO / Riayati","status": "delegated_to_search_all_pool","data": null,"created_at": "2025-10-12T10:00:27.636000","message": "Identification via DHPO / Riayati failed, triggering pool-based search_all.","screenshot_url": null},{"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 page lacks concrete insurance details such as copay information, policy numbers, or eligibility checkboxes. It serves only as a navigation portal without the necessary information 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-10-12T10:01:20.503000","message": null,"screenshot_url": null},{"tpa_name": "TPA004","status": "found","data": {"payer_id": "TPA004","is_eligible": true,"patient_info": {"patient_id_info": {"client_number": "INS016","dha_member_id": "0000000000","policy_number": "POL-0000000","tpa_member_id": "MBR-0000000","reference_number": "REF-0000000"},"policy_holder_dob": "01-01-1990","policy_holder_name": "Sample Policy Holder","patient_emirates_id": "784-0000-0000000-0","policy_holder_phone": null,"policy_holder_gender": "MALE","policy_primary_member_id": "MBR-0000000","policy_holder_relationship": null,"policy_holder_date_of_birth": "01-01-1990","policy_primary_dha_member_id": "0000000000"},"copay_analysis": {"copay_details": [{"remarks": "Citation: Copay 20% applicable for : Consultation / Evaluation and Management, Laboratory, Ultrasound, X-Ray, C.T Scan, M.R.I, Radiology NEC, Physiotherapy, PET Scan, Endoscopy, Teleconsultations, Diagnostics NEC | \n\n ","visit_type": "Consultation","copay_amount": null,"visit_setting": "Outpatient","copay_currency": "AED","copay_max_scope": null,"copay_max_amount": null,"copay_percentage": "20.0","coinsurance_percentage": null},{"remarks": "Citation: Copay 20% applicable for : Consultation / Evaluation and Management, Laboratory, Ultrasound, X-Ray, C.T Scan, M.R.I, Radiology NEC, Physiotherapy, PET Scan, Endoscopy, Teleconsultations, Diagnostics NEC | \n\n ","visit_type": "Laboratory","copay_amount": null,"visit_setting": "Outpatient","copay_currency": "AED","copay_max_scope": null,"copay_max_amount": null,"copay_percentage": "20.0","coinsurance_percentage": null},{"remarks": "Citation: Copay 20% applicable for : Consultation / Evaluation and Management, Laboratory, Ultrasound, X-Ray, C.T Scan, M.R.I, Radiology NEC, Physiotherapy, PET Scan, Endoscopy, Teleconsultations, Diagnostics NEC | \n\n ","visit_type": "Radiology","copay_amount": null,"visit_setting": "Outpatient","copay_currency": "AED","copay_max_scope": null,"copay_max_amount": null,"copay_percentage": "20.0","coinsurance_percentage": null},{"remarks": "Citation: Copay 20% applicable for : Consultation / Evaluation and Management, Laboratory, Ultrasound, X-Ray, C.T Scan, M.R.I, Radiology NEC, Physiotherapy, PET Scan, Endoscopy, Teleconsultations, Diagnostics NEC | \n\n ","visit_type": "Physiotherapy","copay_amount": null,"visit_setting": "Outpatient","copay_currency": "AED","copay_max_scope": null,"copay_max_amount": null,"copay_percentage": "20.0","coinsurance_percentage": null},{"remarks": "Citation: Copay 20% applicable for : Acute Drugs, Chronic Drugs, Immunomodulators, Vitamins | \n\n ","visit_type": "Pharmacy","copay_amount": null,"visit_setting": "Outpatient","copay_currency": "AED","copay_max_scope": null,"copay_max_amount": null,"copay_percentage": "20.0","coinsurance_percentage": null},{"remarks": "Citation: Copay 50% applicable for : Circumcision | \n\n ","visit_type": "Other Services","copay_amount": null,"visit_setting": "Outpatient","copay_currency": "AED","copay_max_scope": null,"copay_max_amount": null,"copay_percentage": "50.0","coinsurance_percentage": null},{"remarks": "Citation: Copay 20% applicable for : Consultation / Evaluation and Management, Laboratory, Ultrasound, X-Ray, C.T Scan, M.R.I, Radiology NEC, Physiotherapy, PET Scan, Endoscopy, Teleconsultations, Diagnostics NEC | \n\n Automatically added as Consultation, Lab, and Radiology have same copay.","visit_type": "Procedure","copay_amount": 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": ["No referral required for specialist consultation"],"new_version_of_copay_analysis": {"benefits": [{"limits": null,"remarks": null,"conditions": null,"cost_sharing": [{"visit_type": "Outpatient","copay_amount": null,"visit_setting": "Outpatient","copay_currency": "AED","copay_percentage": 20,"copay_maximum_scope": null,"copay_maximum_amount": null,"coinsurance_percentage": null}],"coverage_status": "Covered","service_category_original": "Consultation / Evaluation and Management","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,"copay_maximum_scope": null,"copay_maximum_amount": null,"coinsurance_percentage": null}],"coverage_status": "Covered","service_category_original": null,"service_category_standardized": "Laboratory"},{"limits": null,"remarks": null,"conditions": null,"cost_sharing": [{"visit_type": "Outpatient","copay_amount": null,"visit_setting": "Outpatient","copay_currency": "AED","copay_percentage": 20,"copay_maximum_scope": null,"copay_maximum_amount": null,"coinsurance_percentage": null}],"coverage_status": "Covered","service_category_original": "Radiology NEC","service_category_standardized": "Radiology"},{"limits": null,"remarks": null,"conditions": null,"cost_sharing": [{"visit_type": "Outpatient","copay_amount": null,"visit_setting": "Outpatient","copay_currency": "AED","copay_percentage": 20,"copay_maximum_scope": null,"copay_maximum_amount": null,"coinsurance_percentage": null}],"coverage_status": "Covered","service_category_original": null,"service_category_standardized": "Physiotherapy"},{"limits": null,"remarks": null,"conditions": null,"cost_sharing": [{"visit_type": "Outpatient","copay_amount": null,"visit_setting": "Outpatient","copay_currency": "AED","copay_percentage": 20,"copay_maximum_scope": null,"copay_maximum_amount": null,"coinsurance_percentage": null}],"coverage_status": "Covered","service_category_original": null,"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": 50,"copay_maximum_scope": null,"copay_maximum_amount": null,"coinsurance_percentage": null}],"coverage_status": "Covered","service_category_original": "Circumcision","service_category_standardized": "Other Services"},{"limits": null,"remarks": "Automatically added as Consultation, Lab, and Radiology have same copay.","conditions": null,"cost_sharing": [{"visit_type": "Outpatient","copay_amount": null,"visit_setting": "Outpatient","copay_currency": "AED","copay_percentage": 20,"copay_maximum_scope": null,"copay_maximum_amount": null,"coinsurance_percentage": null}],"coverage_status": "Covered","service_category_original": null,"service_category_standardized": "Procedure"}],"policy_info": {"waiting_period": "Not Specified","policy_period_end": null,"policy_jurisdiction": "Not Specified","policy_period_start": null,"beneficiary_start_date": null},"general_remarks": ["No referral required for specialist consultation"],"abbreviations_defined": null}},"failure_reason": null,"policy_network": {"is_vip": "Not Mentioned","payer_name": "SUKOON TAKAFUL - INS016","sponsor_id": "INS016","start_date": "2025-06-01","valid_upto": "2026-05-31","all_networks": [{"network": "GN","visit_type": "Not Specified","network_code": null,"network_value": "General Network","raw_plan_string": "INS012 - SUKOON TAKAFUL - NAS - GN - DXB-SHJ","matched_plan_name": null,"network_name_as_in_text": "Restricted Network [Applicable Tariff: General Network]"}],"package_name": null,"is_gatekeeper": "Not Mentioned","waiting_period": null,"policy_authority": "DHA","policy_plan_name": null,"applicable_tariff": "General Network","work_site_covered": "Yes","policy_holder_name": null,"network_payment_limit": 700,"payer_name_as_in_text": "Sukoon Takaful","is_consultation_excluded_from_payment_limit": true,"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": "01-01-1990","policy_holder_name": "Sample Policy Holder","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"},{"tag": "Member Eligibility - Approval Requirements","s3_url": "https://storage.example.com/eligibility/00000000-0000-4000-a000-000000000001/document.png?sig=PLACEHOLDER&se=2026-01-01T00%3A00%3A00Z"},{"id": "claim_form","tag": "Consultation/Claim form","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"},"CONSULTATION": {"copay": "20.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": "GN","network_status": null,"matched_plan_name": null},"available_networks": [{"network": "GN","visit_type": "Not Specified","network_code": null,"network_value": "General Network","raw_plan_string": "INS012 - SUKOON TAKAFUL - NAS - GN - DXB-SHJ","matched_plan_name": null,"network_name_as_in_text": "Restricted Network [Applicable Tariff: General Network]"}],"has_multiple_networks": false},{"name": "Maternity","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},"CONSULTATION": {"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": "GN","network_status": null,"matched_plan_name": null},"available_networks": [{"network": "GN","visit_type": "Not Specified","network_code": null,"network_value": "General Network","raw_plan_string": "INS012 - SUKOON TAKAFUL - NAS - GN - DXB-SHJ","matched_plan_name": null,"network_name_as_in_text": "Restricted Network [Applicable Tariff: General Network]"}],"has_multiple_networks": false},{"name": "Specialization","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"},"CONSULTATION": {"copay": "20.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": "GN","network_status": null,"matched_plan_name": null},"available_networks": [{"network": "GN","visit_type": "Not Specified","network_code": null,"network_value": "General Network","raw_plan_string": "INS012 - SUKOON TAKAFUL - NAS - GN - DXB-SHJ","matched_plan_name": null,"network_name_as_in_text": "Restricted Network [Applicable Tariff: General Network]"}],"has_multiple_networks": false},{"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},"CONSULTATION": {"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": "GN","network_status": null,"matched_plan_name": null},"available_networks": [{"network": "GN","visit_type": "Not Specified","network_code": null,"network_value": "General Network","raw_plan_string": "INS012 - SUKOON TAKAFUL - NAS - GN - DXB-SHJ","matched_plan_name": null,"network_name_as_in_text": "Restricted Network [Applicable Tariff: General Network]"}],"has_multiple_networks": false}],"policy_holder_emirates_id": "784-0000-0000000-0","was_identified_by_aggregator": false},"created_at": "2025-10-12T10:02:06.820000","message": null,"screenshot_url": null},{"tpa_name": "TPA037","status": "failed","data": null,"created_at": "2025-10-12T10:00:29.064000","message": "TPA `TPA037` is not configured for the practice.","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": "The insurance eligibility check failed because the document indicates that the provided Member ID/Emirates ID is invalid, which serves as an explicit disqualification.","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-10-12T10:01:02.727000","message": null,"screenshot_url": null},{"tpa_name": "INS012","status": "failed","data": null,"created_at": "2025-10-12T10:00:28.360000","message": "TPA `INS012` 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-10-12T10:00:57.922000","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": "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": "The insurance eligibility page clearly states 'Not Eligible' and shows an invalid member identifier, leading to a final determination of not eligible despite the effective dates matching today's date.","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"}],"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-10-12T10:01:21.295000","message": null,"screenshot_url": null}],"total_tpas_checked": 17,"found_results": 1,"created_at": "2025-10-12T10:00:25.317000","updated_at": "2025-10-12T10:02:26.837000"}
Stop when the top-level status is SEARCH_ALL_COMPLETE, CANCELLED or
FAILED. Then partition aggregated_results as described in search-all
response structure.
Do not stop on search_all_status
It is derived from a rule that calls a sweep complete only once seventeen entries are present, and
seventeen is a hard-coded constant rather than the real pool size. A sweep that finishes with
fewer entries reports SEARCH_ALL_PROCESSING on a task whose own status already reads
SEARCH_ALL_COMPLETE, so a loop waiting on it runs to its own timeout. Two of the captured
production sweeps on this site behave exactly that way. See the two
statuses.
total_tpas_checked counts answers, not attempts
It is the length of aggregated_results: the payers that have responded so far. It is not the
number of payers queried, and it does not tell you how many are still outstanding. Stop on the
top-level status.
How completion is decided
A search-all is reported complete when any of the following holds:
- 17 payers have responded. This threshold is fixed and is lower than the number of payers queried for most organisations.
- Every payer that has responded found the member.
- A single aggregator has responded and the check that dispatched it has finished or returned an error.
Otherwise the check is still processing.
The fixed threshold gets it wrong in both directions, and only one of the two is survivable.
Completion does not guarantee a response from every payer
Because the threshold is fixed at 17, a search-all can be reported complete while other payers are
still working. Treat aggregated_results as the record of which payers actually responded, and
handle the returned results as potentially incomplete. If a specific payer matters to your
workflow, check it directly with a single-payer task rather than relying on search-all.
And a small sweep is never reported complete at all
A finished sweep with fewer than 17 entries fails all three tests, so search_all_status stays
SEARCH_ALL_PROCESSING for ever. The task's own status is already terminal at that point, which
is why it, and not this field, is the one to poll.
Recommended loop
- Poll every 5 seconds. Faster does not make the payer portal answer sooner.
- Set a polling timeout of 5 minutes for a single payer, 10 minutes for search-all. Both are recommended starting points, not guarantees; confirm them before you build a hard timeout.
- On a 5xx, retry the poll rather than recreating the task. Creating a second task runs a second real check at the payer.
- A task id stays valid after your timeout. Surface it as "still checking", keep the id, and poll again later.
Polling at this interval is inexpensive, and polling eligibility-result costs
no more than polling task-status.
Why not task-status
GET /task-status/{task_id} is supported and documented in
Endpoints. It returns a subset of what
eligibility-result returns, which is why these docs poll the latter.
eligibility-result (poll this) | task-status | |
|---|---|---|
| Parsed result | eligibility_result.data_dump | eligibility_result.data, the same object |
interim_results | returned | never returned |
| Document and screenshot links | re-signed on every read | returned as stored, and may have expired |
| Terminal status | PROCESS_COMPLETE | COMPLETE |
| In-flight status | the specific lifecycle state | reported as PROCESSING |
| Search-all completion | reported at 17 responses | requires 22 responses |
| Search-all payer list | omits responses missing an internal key | includes them |
Three differences drive the recommendation:
interim_results is available only here. Anything you display before the
check finishes comes from this endpoint.
Document links are re-signed on every read. task-status returns links as
they were stored, so on an older task they may already have expired.
Search-all completion is reported reliably. task-status requires 22
responses before it reports a search-all complete, and around 19 payers are
queried, so its search_all_status can remain SEARCH_ALL_PROCESSING
indefinitely. eligibility-result uses a threshold of 17, which is reached.
The two completion thresholds are under review
17 and 22 are two different values for the same quantity, and neither matches the number of payers
actually queried. Both are documented here as current behaviour. Until they are reconciled, read
aggregated_results for the record of which payers responded rather than inferring it from either
threshold.
task-status does offer a smaller status vocabulary: four values instead of
seven. If you would rather branch on PROCESSING versus not, it is available.
Do not mix the two endpoints in one client: the same finished task is
COMPLETE on one and PROCESS_COMPLETE on the other.