Eligibility (coming soon)
Live HMO eligibility and pre-authorisation checks are coming soon. Only a simulated preview is available, and only in sandbox.
Coming soon
Live eligibility and pre-authorisation checks aren't available yet. With a live key,
POST /partners/eligibility returns 501 feature_not_available. Only the simulated sandbox preview described below works today. Don't depend on it in production.When it launches, the eligibility endpoint will let HMOs and sponsors check a member's physiotherapy cover before referring them. Until then, refer covered members with billing_mode: "hmo_direct_billing" and put your own authorisation reference in partner_reference or metadata. See the HMO integration guide.
Sandbox preview
POST /partners/eligibilityWith a sk_test_ key, the endpoint returns a simulated result so you can prototype your flow. No HMO is contacted, and the result means nothing outside sandbox.
| Field | Type | Description |
|---|---|---|
member_id | string | The member's ID with their HMO. |
hmo_code | string | Your HMO code, for example wellahealth. |
requested_sessions | integer | Number of sessions you want to check. |
Simulation rules:
- Any
member_idcontainingEXPIREDreturnseligible: falsewithreason: "policy_inactive". - Any other
member_idreturnseligible: true, withapproved_sessionsequal torequested_sessions.
curl https://api.physioaroundme.com/v1/partners/eligibility \
-X POST \
-H "Authorization: Bearer $REHABIFY_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "member_id": "WH-123", "hmo_code": "wellahealth", "requested_sessions": 6 }'200 OK (sandbox)
{
"object": "eligibility_check",
"simulated": true,
"eligible": true,
"member_id": "WH-123",
"approved_sessions": 6,
"reason": null
}With a live key:
501 Not Implemented (live)
{
"error": {
"type": "api_error",
"code": "feature_not_available",
"message": "Eligibility checks are not yet available in live.",
"request_id": "req_2c7e9b4a1d6f4e8a9b0c3d5e",
"doc_url": "https://docs.physioaroundme.com/getting-started/errors#feature_not_available"
}
}What isn't available
- Real-time verification against HMO systems.
- Pre-authorisation codes or tokens. No referral field accepts one.
- Session allowances, co-payments or policy details.
We'll announce the live endpoint in these docs when it's ready.