Mantys Eligibility APIAppointment checks
POST /v4/appointment-checks: a check whose result is also pushed to your webhook.
POST /v4/appointment-checks starts a check for a booked appointment. Use it instead of
POST /v4/eligibility-checks when you want the result pushed to your webhook as well as available
to poll.
The body is the same as a normal check, identifiers included, plus:
| Field | Notes |
|---|---|
submitter | Your own references, passed through to the webhook so you can match it to your record: {"id": "...", "ref": "..."} |
user_id | Who booked the check in your system (optional) |
visit_type is required here on every account.
Response: 201 has the same fields as a normal check, plus cached and result.
- If result reuse is switched on for your account and the same patient was found eligible with the
same payer at the same clinic recently, you get 200 with
"cached": trueand theresultstraight away. No new check runs. - The webhook address is set up with Mantys, not sent in the request. Sending
callback_urlis 422. - Appointment checks need an appointments queue set up for your account. Without it you get 400
ROUTING_NOT_CONFIGURED; contact Mantys. - Test IDs are not accepted here. A
990-ID is 400VALIDATION_FAILED, with the message "Test IDs (990-...) are supported on POST /v4/eligibility-checks only".