Mantys Eligibility API

Moving from v3

A checklist for switching a v3 client to v4.

  • Change paths from /v2/api-integration-v3/... to /v4/... (see Endpoints).
  • Send all three headers on every call, with Bearer before the key.
  • Send the patient's IDs in identifiers, not as id_type + id_value.
  • Read errors from error.code and error.details[].code, not from message text.
  • Treat 403 CLINIC_NOT_AUTHORIZED as a clinic setup issue, not a bad key.
  • Remove mode and test_mode from requests, and any other field not listed here.
  • Poll GET /v4/eligibility-checks/{id} until COMPLETE, FAILED or CANCELLED.
  • Read answers from eligible_responses and other_responses, branching on each row's tpa_id and status.
  • Page the list with next_cursor instead of page numbers.
  • Cancel with the check id only; stop sending eligibility_id and tpa_name.
  • Run your client against test IDs before switching production traffic.

Questions or a new clinic to add to your key: contact your Mantys account team, quoting the request_id for any error.