Credentials walkthrough

Both requests that carry credentials, end to end: a single-portal check and a search-all, with what gets checked and what comes back.

Sending credentials is the contract: the field, its two shapes and the validation rules. This page follows the two kinds of request that carry it from the first call to the answer, so you can see which portals get checked and what your code reads at the end.

The two requests side by side

	Single portal	Search all
`tpa_name`	one payer code, such as `TPA004`	`BOTH`, `DHPO` or `RIYATI`
`credentials` shape	keyed by code, or the single-login shorthand	keyed by code only; the shorthand returns 400
Portals checked	the one in `tpa_name`	only the ones you sent logins for, narrowed by the DHPO lookup
Logins Mantys holds for the clinic	used for any portal you did not send a login for	used for the DHPO lookup only
Poll until	`status` is `PROCESS_COMPLETE`	`status` is `SEARCH_ALL_COMPLETE`
The answer is in	`eligibility_result`	`aggregated_results`, one entry per portal
Wrong password	`eligibility_result.status` is `invalid_credentials`	that portal's entry is `invalid_credentials`; the rest carry on
Payer with no login	not applicable	reported as `tpa_not_configured` if DHPO lists the member there

Single portal

Send the request

Put the login under the payer code, or use the shorthand, which applies to tpa_name. Both of these do the same thing:

{
  "tpa_name": "TPA004",
  "id_type": "EMIRATESID",
  "id_value": "784-0000-0000000-0",
  "visit_type": "OUTPATIENT",
  "credentials": { "username": "sample.user@sampleclinic.com", "password": "..." }
}

{
  "tpa_name": "TPA004",
  "id_type": "EMIRATESID",
  "id_value": "784-0000-0000000-0",
  "visit_type": "OUTPATIENT",
  "credentials": {
    "TPA004": { "username": "sample.user@sampleclinic.com", "password": "..." }
  }
}

The response is the ordinary create-task response: keep the task_id. If the shape is wrong you get a 400 here instead, before any task exists; see Validation.

Poll

Poll /eligibility-result until status is PROCESS_COMPLETE. Nothing about polling changes because the login came from your request.

Read the answer

eligibility_result is the answer, exactly as for a check on stored logins. A login that worked gives you the portal's coverage:

The login worked

.json

{
"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"
}
}

Highlighted: eligibility_result.status. Every other key on the response is documented on Results.

A login the portal refused completes the task with invalid_credentials. The message names the username that was tried, which is how you confirm the portal saw your login and not the clinic's:

The portal refused the login

.json

{
"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: status, message. The rest of the keys are documented on Results.

Variants are separate portals

Aafiya's newer portal is TPA026__SALAMA. A login sent under TPA026 is used for the older Aafiya portal only. To check the newer one, send tpa_name: "TPA026__SALAMA" with the login under that code, or use the shorthand.

Search all

Send the request

Key the logins by payer, one key per portal you want checked. Here the integration holds logins for NAS (TPA004) and Nextcare (TPA002):

{
  "tpa_name": "BOTH",
  "id_type": "EMIRATESID",
  "id_value": "784-0000-0000000-0",
  "visit_type": "OUTPATIENT",
  "credentials": {
    "TPA004": { "username": "sample.user@sampleclinic.com", "password": "..." },
    "TPA002": { "username": "sample.user@sampleclinic.com", "password": "..." }
  }
}

The create response sets is_search_all: true. Keep the task_id.

Which portals get checked

The DHPO lookup runs first, on the login Mantys holds for the clinic, and reports the payers it lists the member under. The Riayati lookup does not run. DHPO's answer then decides which of your portals are checked:

DHPO lists the member under	Checked	Also in the answer
`TPA004`	`TPA004`
`TPA004` and `TPA003`	`TPA004`	`TPA003` as `tpa_not_configured`
`TPA003` only	`TPA004` and `TPA002`	`TPA003` as `tpa_not_configured`
nothing, or the lookup fails	`TPA004` and `TPA002`

So DHPO narrows your list when it agrees with it, and never checks a portal you did not send a login for. When it lists the member under a payer you have no login for, that payer comes back as tpa_not_configured: the member may be covered there, and that is the login to add. No other portal the clinic is configured for is touched, which is why the task finishes as soon as your portals answer.

Poll

Poll /eligibility-result and stop when the top-level status is SEARCH_ALL_COMPLETE, CANCELLED or FAILED. Do not stop on search_all_status; the polling page explains why.

Read the answer

aggregated_results holds one entry per portal, and each is read on its own as described in search-all response structure. A payer DHPO named without a login from you looks like this:

A payer with no login

.json

{
"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",
"request_start_time": 1776449698.1679382
},
"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": "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-17T18:15:53.176000",
"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": "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-17T18:16:24.618000",
"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": "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-17T18:15:55.878000",
"message": "TPA `TPA032` is not configured for the practice.",
"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-17T18:16:00.374000",
"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": "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 document shows a negative eligibility result with an explicit message 'NOT ELIGIBLE' due to an invalid Emirates ID, and no valid insurance information is provided.",
"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-17T18:16:11.400000",
"message": null,
"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-17T18:16:29.797000",
"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": "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-17T18:16:38.085000",
"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": "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-17T18:15:58.885000",
"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": "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-17T18:16:19.740000",
"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": "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-17T18:16:25.876000",
"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": "TPA008",
"status": "tpa_not_configured",
"data": {
"payer_id": "TPA008",
"show_data": false,
"is_eligible": false,
"screenshot_key": null,
"was_identified_by_aggregator": false
},
"created_at": "2026-04-17T18:15:54.414000",
"message": "TPA `TPA008` is not configured for the practice.",
"screenshot_url": null
},
{
"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-04-17T18:16:23.049000",
"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": "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-17T18:16:29.802000",
"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": "DHPO / Riayati",
"status": "delegated_to_search_all_pool",
"data": null,
"created_at": "2026-04-17T18:15:00.244000",
"message": "Identification via DHPO / Riayati failed, triggering pool-based search_all.",
"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-17T18:15:58.349000",
"message": "TPA `TPA037` is not configured for the practice.",
"screenshot_url": null
},
{
"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": "Maternity : No",
"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": "Inpatient",
"copay_currency": "AED",
"copay_percentage": 30,
"applicable_location": "Outside UAE",
"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": "30.0",
"coinsurance_percentage": null
},
{
"remarks": "Optical : No",
"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: 10% max. AED 30 | \n\n ",
"visit_type": "Outpatient",
"copay_amount": null,
"cost_sharing": {
"visit_type": "Outpatient",
"copay_amount": null,
"visit_setting": "Inpatient",
"copay_currency": "AED",
"copay_percentage": 10,
"applicable_location": "Outside UAE",
"copay_maximum_scope": null,
"copay_maximum_amount": 30,
"coinsurance_percentage": null
},
"visit_setting": "Inpatient",
"copay_currency": "AED",
"copay_max_scope": null,
"copay_max_amount": 30,
"copay_percentage": "10.0",
"coinsurance_percentage": null
},
{
"remarks": "Citation: OP : 10% on all services including medicine | \n\n Citation: OP - Ded : PC: 10% max. AED 30 | \n\n ",
"visit_type": "Outpatient",
"copay_amount": null,
"cost_sharing": {
"visit_type": "Outpatient",
"copay_amount": null,
"visit_setting": "Inpatient",
"copay_currency": "AED",
"copay_percentage": 10,
"applicable_location": "Outside UAE",
"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": "10.0",
"coinsurance_percentage": null
}
],
"waiting_period": "waiting_period_time=0 waiting_period_unit='Days' waiting_period_starting_from='policy_start_date'",
"special_remarks": [
],
"new_version_of_copay_analysis": {
"benefits": [
{
"limits": null,
"remarks": "Maternity : No",
"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": "Inpatient",
"copay_currency": "AED",
"copay_percentage": 30,
"applicable_location": "Outside 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": "Optical : No",
"conditions": null,
"cost_sharing": [
],
"coverage_status": "Not Covered",
"service_category_original": null,
"service_category_standardized": "Optical"
},
{
"limits": null,
"remarks": null,
"conditions": null,
"cost_sharing": [
{
"visit_type": "Outpatient",
"copay_amount": null,
"visit_setting": "Inpatient",
"copay_currency": "AED",
"copay_percentage": 10,
"applicable_location": "Outside UAE",
"copay_maximum_scope": null,
"copay_maximum_amount": 30,
"coinsurance_percentage": null
},
{
"visit_type": "Outpatient",
"copay_amount": null,
"visit_setting": "Inpatient",
"copay_currency": "AED",
"copay_percentage": 10,
"applicable_location": "Outside UAE",
"copay_maximum_scope": null,
"copay_maximum_amount": null,
"coinsurance_percentage": null
},
{
"visit_type": "Outpatient",
"copay_amount": null,
"visit_setting": "Inpatient",
"copay_currency": "AED",
"copay_percentage": 20,
"applicable_location": "Outside UAE",
"copay_maximum_scope": null,
"copay_maximum_amount": null,
"coinsurance_percentage": null
}
],
"coverage_status": "Covered",
"service_category_original": null,
"service_category_standardized": "Outpatient"
},
{
"limits": null,
"remarks": null,
"conditions": null,
"cost_sharing": [
{
"visit_type": "Outpatient",
"copay_amount": null,
"visit_setting": "Inpatient",
"copay_currency": "AED",
"copay_percentage": 20,
"applicable_location": "Outside UAE",
"copay_maximum_scope": null,
"copay_maximum_amount": null,
"coinsurance_percentage": null
},
{
"visit_type": "Outpatient",
"copay_amount": null,
"visit_setting": "Inpatient",
"copay_currency": "AED",
"copay_percentage": null,
"applicable_location": "Outside UAE",
"copay_maximum_scope": null,
"copay_maximum_amount": null,
"coinsurance_percentage": 20
}
],
"coverage_status": "Covered",
"service_category_original": null,
"service_category_standardized": "Inpatient"
}
],
"policy_info": {
"waiting_period": {
"waiting_period_time": 0,
"waiting_period_unit": "Days",
"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": [
],
"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": "COMPREHENSIVE",
"plan_code": "P167-2",
"visit_type": "OP (Out Patient)",
"network_code": null,
"network_value": "COMPREHENSIVE",
"raw_plan_string": "AL-BUHAIRA NATIONAL INSURANCE COMPANY - COMPREHENSIVE AND COMPREHENSIVE PLUS - SHJ",
"matched_plan_name": null,
"network_name_as_in_text": "Network (NW): IP & OP : Comprehensive Incl."
},
{
"network": "COMPREHENSIVE",
"plan_code": "P167-2",
"visit_type": "IP (In Patient)",
"network_code": null,
"network_value": "COMPREHENSIVE",
"raw_plan_string": "AL-BUHAIRA NATIONAL INSURANCE COMPANY - COMPREHENSIVE AND COMPREHENSIVE PLUS - SHJ",
"matched_plan_name": null,
"network_name_as_in_text": "Network (NW): IP & OP : Comprehensive Incl."
}
],
"package_name": null,
"is_gatekeeper": "Not Mentioned",
"waiting_period": null,
"policy_authority": "MOH",
"policy_plan_name": "Unified",
"work_site_covered": "Could not determine",
"policy_holder_name": "Sample Policy Holder",
"payer_name_as_in_text": "Sample Policy Holder",
"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": "10.0",
"deductible": "0",
"_copayAmount": "0",
"_maxDeductible": "0",
"_copayMaxAmount": "0",
"should_set_copay": true,
"_deductibleLegacy": "0"
},
"MEDICINES": {
"copay": "10.0",
"deductible": "0",
"_copayAmount": "0",
"_copayMaxAmount": "0",
"should_set_copay": true,
"_deductibleLegacy": "0"
},
"PROCEDURE": {
"copay": "10.0",
"deductible": "0",
"_copayAmount": "0",
"_copayMaxAmount": "0",
"should_set_copay": true,
"_deductibleLegacy": "0"
},
"RADIOLOGY": {
"copay": "10.0",
"deductible": "0",
"_copayAmount": "0",
"_copayMaxAmount": "0",
"should_set_copay": true,
"_deductibleLegacy": "0"
},
"DIAGNOSTICS": {
"copay": "10.0",
"deductible": "0",
"_copayAmount": "0",
"_copayMaxAmount": "0",
"should_set_copay": true,
"_deductibleLegacy": "0"
},
"CONSULTATION": {
"copay": "10.0",
"deductible": "0",
"_copayAmount": "0",
"_copayMaxAmount": "0",
"should_set_copay": true,
"_deductibleLegacy": "0"
},
"PHYSIOTHERAPY": {
"copay": "10.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": "COMPREHENSIVE",
"network_status": null,
"matched_plan_name": null
},
"available_networks": [
{
"network": "COMPREHENSIVE",
"plan_code": "P167-2",
"visit_type": "OP (Out Patient)",
"network_code": null,
"network_value": "COMPREHENSIVE",
"raw_plan_string": "AL-BUHAIRA NATIONAL INSURANCE COMPANY - COMPREHENSIVE AND COMPREHENSIVE PLUS - SHJ",
"matched_plan_name": null,
"network_name_as_in_text": "Network (NW): IP & OP : Comprehensive Incl."
},
{
"network": "COMPREHENSIVE",
"plan_code": "P167-2",
"visit_type": "IP (In Patient)",
"network_code": null,
"network_value": "COMPREHENSIVE",
"raw_plan_string": "AL-BUHAIRA NATIONAL INSURANCE COMPANY - COMPREHENSIVE AND COMPREHENSIVE PLUS - SHJ",
"matched_plan_name": null,
"network_name_as_in_text": "Network (NW): IP & OP : Comprehensive Incl."
}
],
"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": "COMPREHENSIVE",
"network_status": null,
"matched_plan_name": null
},
"available_networks": [
{
"network": "COMPREHENSIVE",
"plan_code": "P167-2",
"visit_type": "OP (Out Patient)",
"network_code": null,
"network_value": "COMPREHENSIVE",
"raw_plan_string": "AL-BUHAIRA NATIONAL INSURANCE COMPANY - COMPREHENSIVE AND COMPREHENSIVE PLUS - SHJ",
"matched_plan_name": null,
"network_name_as_in_text": "Network (NW): IP & OP : Comprehensive Incl."
},
{
"network": "COMPREHENSIVE",
"plan_code": "P167-2",
"visit_type": "IP (In Patient)",
"network_code": null,
"network_value": "COMPREHENSIVE",
"raw_plan_string": "AL-BUHAIRA NATIONAL INSURANCE COMPANY - COMPREHENSIVE AND COMPREHENSIVE PLUS - SHJ",
"matched_plan_name": null,
"network_name_as_in_text": "Network (NW): IP & OP : Comprehensive Incl."
}
],
"has_multiple_networks": true
},
{
"name": "Specialization",
"values_to_fill": {
"LAB": {
"copay": "10.0",
"deductible": "0",
"_copayAmount": "0",
"_maxDeductible": "0",
"_copayMaxAmount": "0",
"should_set_copay": true,
"_deductibleLegacy": "0",
"_is_outpatient_fallback": true
},
"MEDICINES": {
"copay": "10.0",
"deductible": "0",
"_copayAmount": "0",
"_copayMaxAmount": "0",
"should_set_copay": true,
"_deductibleLegacy": "0",
"_is_outpatient_fallback": true
},
"PROCEDURE": {
"copay": "10.0",
"deductible": "0",
"_copayAmount": "0",
"_copayMaxAmount": "0",
"should_set_copay": true,
"_deductibleLegacy": "0",
"_is_outpatient_fallback": true
},
"RADIOLOGY": {
"copay": "10.0",
"deductible": "0",
"_copayAmount": "0",
"_copayMaxAmount": "0",
"should_set_copay": true,
"_deductibleLegacy": "0",
"_is_outpatient_fallback": true
},
"DIAGNOSTICS": {
"copay": "10.0",
"deductible": "0",
"_copayAmount": "0",
"_copayMaxAmount": "0",
"should_set_copay": true,
"_deductibleLegacy": "0",
"_is_outpatient_fallback": true
},
"CONSULTATION": {
"copay": "10.0",
"deductible": "0",
"_copayAmount": "0",
"_copayMaxAmount": "0",
"should_set_copay": true,
"_deductibleLegacy": "0",
"_is_outpatient_fallback": true
},
"PHYSIOTHERAPY": {
"copay": "10.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": "COMPREHENSIVE",
"network_status": null,
"matched_plan_name": null
},
"available_networks": [
{
"network": "COMPREHENSIVE",
"plan_code": "P167-2",
"visit_type": "OP (Out Patient)",
"network_code": null,
"network_value": "COMPREHENSIVE",
"raw_plan_string": "AL-BUHAIRA NATIONAL INSURANCE COMPANY - COMPREHENSIVE AND COMPREHENSIVE PLUS - SHJ",
"matched_plan_name": null,
"network_name_as_in_text": "Network (NW): IP & OP : Comprehensive Incl."
},
{
"network": "COMPREHENSIVE",
"plan_code": "P167-2",
"visit_type": "IP (In Patient)",
"network_code": null,
"network_value": "COMPREHENSIVE",
"raw_plan_string": "AL-BUHAIRA NATIONAL INSURANCE COMPANY - COMPREHENSIVE AND COMPREHENSIVE PLUS - SHJ",
"matched_plan_name": null,
"network_name_as_in_text": "Network (NW): IP & OP : Comprehensive Incl."
}
],
"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": "COMPREHENSIVE",
"network_status": null,
"matched_plan_name": null
},
"available_networks": [
{
"network": "COMPREHENSIVE",
"plan_code": "P167-2",
"visit_type": "OP (Out Patient)",
"network_code": null,
"network_value": "COMPREHENSIVE",
"raw_plan_string": "AL-BUHAIRA NATIONAL INSURANCE COMPANY - COMPREHENSIVE AND COMPREHENSIVE PLUS - SHJ",
"matched_plan_name": null,
"network_name_as_in_text": "Network (NW): IP & OP : Comprehensive Incl."
},
{
"network": "COMPREHENSIVE",
"plan_code": "P167-2",
"visit_type": "IP (In Patient)",
"network_code": null,
"network_value": "COMPREHENSIVE",
"raw_plan_string": "AL-BUHAIRA NATIONAL INSURANCE COMPANY - COMPREHENSIVE AND COMPREHENSIVE PLUS - SHJ",
"matched_plan_name": null,
"network_name_as_in_text": "Network (NW): IP & OP : Comprehensive Incl."
}
],
"has_multiple_networks": true
}
],
"policy_holder_emirates_id": "784-0000-0000000-0",
"was_identified_by_aggregator": false
},
"created_at": "2026-04-17T18:16:39.315000",
"message": null,
"screenshot_url": null
},
{
"tpa_name": "INS012",
"status": "member_not_found",
"data": {
"network": null,
"payer_id": "INS012",
"show_data": false,
"payer_name": null,
"valid_upto": null,
"is_eligible": false,
"copay_details": null,
"other_details": null,
"failure_reason": "Ineligible - as indicated by the portal's transaction actions field",
"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-17T18:17:08.326000",
"message": null,
"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 document is a generic provider portal screen without any specific details about the patient's insurance eligibility or policy validity, so the patient 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": [
],
"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-17T18:17:00.815000",
"message": null,
"screenshot_url": null
}
],
"total_tpas_checked": 18,
"found_results": 1,
"created_at": "2026-04-17T18:14:58.179000",
"updated_at": "2026-04-17T18:16:41.403000"
}

Highlighted: aggregated_results.2. Every other key on the response is documented on Results.

That capture is from a search-all on stored logins, where the clinic had none for TPA032; a request-scoped search-all reports a missing login with the same entry. Treat it as "not checked", never as "not covered": data.is_eligible is false because nobody asked the portal.

Common mistakes

The shorthand on a search-all. "credentials": { "username": ..., "password": ... } with tpa_name: "BOTH" returns 400. A search-all has no single portal for the login to belong to.
A Daman login on a search-all. Daman is never part of a search-all, so the login is accepted and not used. Check Daman with its own request.
One Aafiya key for both portals. TPA026 and TPA026__SALAMA each need their own key.
Oman without licences. INS012 reads license_number at login; see the Oman example.
Expecting a missing payer to be checked on stored logins. On a search-all with credentials, the only stored login used is DHPO's. Send every login you want used.

On this page