LEAP MIS API

Public reference for integrating with LEAP Management Information System HTTP APIs. All endpoints under /api/v1 return JSON and require a valid session token unless a page states otherwise. Sign in with POST /api/v1/session, then send the token via token, Authorization: Bearer, or x-access-token.

Description

LEAP MIS exposes REST-style endpoints for configuration, enrollment, and payment service provider workflows. This documentation set currently covers:

  • Locations — read Ghana administrative hierarchy (regions, districts, communities) used across enrollment and targeting.
  • PSP Enrollment — list caregiver enrollment records assigned to a payment service provider and submit primary caregiver ezwich card numbers.
  • PSP Statistics — household and caregiver counts for a payment service provider, nested by region, district, and community.

Choose a guide below for request parameters, response schemas, authentication requirements, and example curl calls.

Locations API
GET

Retrieve regions, districts, and communities. Filter by parent codes and look up single records by code or id.

/api/v1/regions
/api/v1/districts
/api/v1/communities

Open Locations docs
PSP Enrollment API
GET PUT

List caregiver enrollment data for the authenticated payment service provider, optionally filtered by location code prefixes, then submit ezwich card numbers.

/api/v1/psp_enrollment

Open PSP Enrollment docs
PSP Statistics API
GET

Household and caregiver counts for the authenticated PSP, nested by region → district → community. Filter by location codes.

/api/v1/psp_statistics

Open PSP Statistics docs