Skip to main content
POST
Check Benefit eligibility

Authorizations

Authorization
string
header
required

A sandbox or production secret key.

Headers

Idempotency-Key
string
required

A caller-owned key for safely retrying one write.

Required string length: 8 - 255

Body

application/json
member_reference
string
required
Required string length: 1 - 100
Pattern: ^[A-Za-z0-9_-]+$
service_code
string
required
Required string length: 1 - 100
Pattern: ^[A-Za-z0-9._:-]+$
scheduled_at
string<date-time>
required
amount
integer
required

Requested amount in the currency's minor unit.

Required range: x >= 1
currency
enum<string>
required
Available options:
KES,
USD,
EUR,
GBP

Response

The original eligibility decision for an idempotent replay

id
string
required
Maximum string length: 100
Pattern: ^elig_[A-Za-z0-9_-]+$
object
string
required
Allowed value: "eligibility_check"
status
enum<string>
required
Available options:
eligible,
ineligible
reason_codes
enum<string>[]
required
Available options:
eligible,
coverage_not_found,
coverage_inactive,
outside_coverage_period,
benefit_exhausted,
amount_exceeds_benefit
service
object
required
amount
object
required
authorization_required
boolean
required
remaining_sessions
integer | null
required
Required range: x >= 0
coverage_valid_until
string<date-time> | null
required
checked_at
string<date-time>
required
Last modified on July 30, 2026