Mantys Eligibility API

API v4

Mantys Eligibility API v4: one error format, clearer status codes, paging, and a safer cancel.

v4 is the current version of the Mantys eligibility API. It does what v3 does, with one error format, clearer status codes, paging, and a safer cancel. v3 keeps working unchanged while you move over.

How it works

Mantys asks the payer's own system, so a check takes seconds to a minute. You create the check, then poll it until it is finished:

EVERY CHECK, SINGLE PAYER OR SEARCH-ALL1 · CREATEPOST /v4/eligibility-checks201 · returns the check id2 · POLLGET /v4/eligibility-checks/{id}IN_QUEUE, NAVIGATING_WEBSITE, …3 · DONECOMPLETE · FAILED · CANCELLEDthe body is the answersame request, every 5 to 10 secondsSEARCH-ALL (tpa_name BOTH, DHPO or RIYATI)The 201 says is_search_all: true. Poll the same way: status reads COMPLETE once every payer has answered,with one row per payer across eligible_responses and other_responses.CANCEL (optional)POST /v4/eligibility-checks/{id}/cancellation202, then poll until CANCELLED
Two calls. The poll is the same request every time; when its status is final, the body you already have is the answer. There is no separate result endpoint.

Start here

Getting started

Credentials, hosts, your first check with a test ID, statuses, errors and a complete client.

Try it

Create and poll a test check in the browser, with the cURL for each call.

Test IDs

Canned answers for every case your client has to handle. No payer is contacted.

Moving from v3

The checklist for switching an existing v3 client.

What changed from v3

Same checks, same payers, same results. What changes is how you call the API and how it answers.

v3v4
Base path/v2/api-integration-v3/.../v4/...
ErrorsTwo shapes ({success, message} and {detail}), English text onlyOne shape with a fixed code you can branch on
Wrong clinic for your key401403 CLINIC_NOT_AUTHORIZED (your key is fine)
Bad inputFails on the first problemLists every problem at once
Unknown body fieldsSilently ignoredRejected (422), so typos are caught
Patient IDid_type + id_valueAn identifiers list of 1 to 5 IDs
Answerseligibility_result, or aggregated_results on a search-alleligible_responses and other_responses, the same shape on every check
Check listFixed 10 per page, offset pagingUp to 100 per page, cursor paging (no duplicates)
Another clinic's check404404 (unchanged)
CancelYou send the Daman eligibility_id and tpa_nameYou send only the check id; we look up the rest
Several IDs for one patientOne ID per checkUp to 5 IDs in one check; the result names the ID that matched
Policy authorityNested inside the resultAlso at the top level as policy_authority
Test mode (mode, test_mode)AcceptedRemoved. Use test IDs

Getting started

From an API key to a finished v4 check: hosts, headers, the two-call flow, statuses, errors and a complete client.

On this page

How it worksStart hereWhat changed from v3