Mantys Eligibility API

Test IDs

Canned 990- answers on the production host, and how a v4 test check behaves.

v4 answers test IDs on the production host, with your normal key, clinic and tenant. A test ID is a member ID that starts with 990-; the number after it picks a canned answer copied from a production case; every test ID is listed below. No payer is contacted and nothing is stored.

curl -X POST "$HOST/v4/eligibility-checks" \
  -H "X-Api-Key: Bearer $API_KEY" \
  -H "X-Clinic-Id: $CLINIC_ID" \
  -H "X-Client-ID: $TENANT" \
  -H "Content-Type: application/json" \
  -d '{"tpa_name": "TPA002", "identifiers": [{"id_type": "EMIRATESID", "id_value": "990-01"}], "visit_type": "OUTPATIENT"}'
  • Send the test ID inside identifiers, like any other ID. The request shape is still checked: a missing visit_type or an unknown field is 422.
  • It finishes after 10 seconds. The check reads IN_QUEUE for the first 3 seconds, NAVIGATING_WEBSITE until 5 seconds and EXTRACTING_DATA until 10, with both answer lists empty. Then it is COMPLETE with the case's answer, and stays that way.
IN_QUEUENAVIGATING_WEBSITEEXTRACTING_DATACOMPLETElists emptylists emptythe case's answer0 s3 s5 s10 s
Seconds since the create. The clock is the create's, not your polls': poll late and you see COMPLETE straight away.
  • Payer rules are skipped. tpa_name, id_type, visit_type and the doctor are not checked against the payer, so even an empty tpa_name is accepted, and the 784 Emirates ID format does not apply.
  • is_search_all follows the case, not tpa_name. 990-30 is a search-all whatever you send, and 990-01 with "tpa_name": "BOTH" is a single-payer check.
  • request echoes your own request, extra_args included. Keys you did not send keep the case's sample values, for example emirates_id or a sample id_type beside your identifiers. Match an answer to your request by the check id, not by request.
  • Test checks are never listed. GET /v4/eligibility-checks does not show them, and q does not find them.
  • Cancel runs the real rules but keeps no state. Cancelling 990-40 (Daman) is 202 every time, and the check stays COMPLETE; cancelling 990-01 (TPA002) is 409 NOT_SUBMITTED_TO_PAYER. Nothing is sent to a payer.
  • One test ID makes the whole check a test check. With several entries in identifiers, the first one that names a known case picks it, and the other entries are not searched. Test checks do not carry matched_identifier or identifier_attempts.
  • An unknown case is 400 VALIDATION_FAILED on identifiers[0].id_value, and the message lists every valid case number.
  • Another clinic's test check is 404 CHECK_NOT_FOUND, as for a real check.
  • POST /v4/appointment-checks refuses test IDs with a 400.
  • 990-90 to 990-99 are v4 only. They return benefit plans.

A test ID proves your client, not your payer setup

A test check never checks whether your clinic is configured for a payer or whether its portal credentials work. Before go-live, run one real check per payer you depend on.

Every test ID

Each ID below works on POST /v4/eligibility-checks, sent as the id_value of an identifiers entry. The case page explains the answer it returns. To watch one run, use Try it.

IDCase pageSampleShapeResult
990-01Eligible response structureeligibleSinglefound, eligible
990-10Networks and planstwo-networksSinglefound, eligible
990-11Networks and plansa1-a3Singlefound, eligible
990-12Networks and plansraw-vs-normalisedSinglefound, eligible
990-13Networks and plansenaya-goldSinglefound, eligible
990-14Networks and planssentence-networkSearch all1 found of 18
990-15Networks and plansunmapped-planSinglefound, eligible
990-20Copaysingle-benefitSinglefound, eligible
990-21Copayby-benefitSinglefound, eligible
990-22Copayby-locationSinglefound, eligible
990-30Search-alltwo-eligibleSearch all2 found of 18
990-31Search-alltwo-eligible-with-backoffSearch all2 found, 1 backoff
990-32Search-allfour-statusesSearch all1 found, 4 failed
990-33Search-allnone-eligibleSearch allNo found
990-34Search-allnot-configuredSearch all1 found, 3 tpa_not_configured
990-40Daman multi-carddaman-two-packagesSinglefound, eligible
990-41Daman multi-carddaman-gold-silverSinglefound, eligible
990-42Daman multi-carddaman-ultrasoundSinglefound, eligible
990-43Daman multi-carddaman-with-errorSinglefound, eligible
990-44Daman multi-cardtwo-cardsSearch all1 found, 1 member_not_found
990-45Daman multi-cardtwo-cards-bSinglefound, eligible
990-50Failuresinvalid-credentialsSingleinvalid_credentials
990-51Failuresboth-credentialsSinglefailed
990-52Failureserror-timeoutSingleerror
990-53Failureserror-keyerrorSingleerror
990-54Failuresfailed-bad-requestSearch all3 failed, no found
990-55FailuresbackoffSearch all4 failed, 1 error, 1 backoff
990-56Failuresthree-classesSearch all1 found, 1 failed, 1 invalid_credentials
990-57Failuresclinician-licence-primarySinglefailed
990-58Failuresclinician-licence-nameSearch all3 failed, no found
990-60Emirates ID not linkedeid-not-foundSinglemember_not_found
990-61Emirates ID not linkedcard-eligibleSinglefound, eligible
990-62Emirates ID not linkedcounter-firstSinglemember_not_found
990-63Emirates ID not linkedcounter-laterSinglefound, eligible
990-70Visit typesmaternity-not-eligibleSinglemember_not_found
990-71Visit typeschronic-outSinglemember_not_found
990-72Visit typesdaman-ultrasoundSinglefound, eligible
990-80Documents and warningsgatekeeperSinglefound, eligible
990-81Documents and warningsreferral-dropdownSinglefound, eligible
990-82Documents and warningsspecial-remarksSinglefound, eligible
990-90Benefit plans (v4)outpatient-stampedSinglefound, eligible; plan STAMPED
990-91Benefit plans (v4)two-visit-types-stampedSingle2 found; both plans STAMPED
990-92Benefit plans (v4)second-leg-not-coveredSingle1 found, 1 member_not_found
990-93Benefit plans (v4)inpatient-stampedSinglefound, eligible; plan STAMPED
990-94Benefit plans (v4)no-rate-foundSinglefound, eligible; plan NO_RATE_FOUND
990-95Benefit plans (v4)no-single-plan-matchSinglefound, eligible; NO_SINGLE_PLAN_MATCH
990-96Benefit plans (v4)member-not-foundSinglemember_not_found
990-97Benefit plans (v4)unknown-encounter-valueSinglefound, eligible; plan STAMPED
990-98Benefit plans (v4)portal-errorSingleerror; plan CHECK_FAILED
990-99Benefit plans (v4)health-plan-not-mappedSinglefound, eligible; plan STAMPED

On this page