Scopes - Heyrafiki

Scopes are attached to a key when it is issued.

Scope	Access
`practitioners:read`	List and retrieve synthetic Practitioner profiles
`availability:read`	Read recurring Practitioner availability
`bookings:read`	List and retrieve synthetic Bookings
`bookings:write`	Create synthetic Bookings
`sessions:read`	List and retrieve synthetic Sessions
`benefits:read`	Retrieve synthetic eligibility and pre-authorization decisions
`benefits:write`	Check synthetic eligibility and create pre-authorizations
`claims:read`	List and retrieve project-scoped synthetic Claims
`claims:write`	Submit Claims and fulfil information requests
`claims:adjudicate`	Request evidence and record payer decisions
`remittances:read`	List and retrieve remittances
`remittances:write`	Record and reconcile remittance allocations
`webhooks:read`	List and retrieve Webhook endpoints
`webhooks:write`	Create, disable and test Webhook endpoints

An authenticated request without the required scope returns 403 permission_denied. Use separate keys when systems need different access. Avoid the wildcard scope outside controlled sandbox testing.

Last modified on August 14, 2026