An official developer portal of the Government of the Republic of Zambia · Test environmentVerify a certificate
Pamodzi Developer HubBuild, integrate and learn the e-Services framework
Documentation

Guides

How the platform works and how to build on it. Each guide is written from the platform's code and kept with it.

Start here

Getting startedWhat the Pamodzi Developer Hub offers, how to sign in with Pamodzi Pass or ZamPass, completing your profile and which course to take first.Platform overviewWhat the Pamodzi e-Services framework is, what it is made of and how its main capabilities fit together.ArchitectureThe platform's components, the three platform roles (combined, hub, node), how applying, paying and verifying travel, where data lives, and the four environments.

Integrate

Partner APICall the platform's Partner API (/api/v1) with OAuth 2 client credentials: getting a client, tokens, scopes, errors, limits, secret rotation and versioning.Webhooks and eventsReceive signed CloudEvents from the platform: subscriptions, event types, verifying X-GSB-Signature, retries, replay and idempotent processing.Document verificationCheck permits, licences, certificates and receipts the platform issued: QR codes, verify endpoints, the signed trust list, seals and time-stamps, and how to report a result honestly.

Identity

Sign in with Pamodzi PassConnect a government system to Pamodzi Pass, the national single sign-on being introduced: registration, code flow with PKCE, ID token validation, scopes and claims, assurance levels, MFA and logout.ZamPass and the move to Pamodzi PassHow ZamPass works today, how the platform maps its claims safely, how the move to Pamodzi Pass will happen, and what integrators should do now.

Payments

Payments with ZamPayHow money moves on the platform: server-side quotes, ZamPay invoices and checkout, callbacks, the one finalisation path, pay-points, POS, receipts, federation and the rules every integrator follows.

Data and registers

Registers and data sharingThe National Data Registers, register packs and field sensitivity, access levels and masks, data-sharing agreements, per-agreement API specifications, open data and consented prefill.Geospatial data and NGDRThe National Geospatial Data Repository (NGDR) adapter, the "Location / area on map" form field, geo validators, reference and module layers, partner feeds and the public parcel search.

Build on the platform

Designing a serviceA service is configuration, not code: its form, process, fees, documents, output templates and capabilities, published as approved versions and federated to the national portal.Building modulesWhen to build a module, a reusable capability or plain configuration; what a module contains; how it is generated, switched on per ministry, tested and released.Extension pointsReference of every extension point a module can contribute to, grouped by area, with its calling mode and purpose, and how to propose a new generic point.

Test and document

End-to-end testingThe e2e kit boots the whole platform on your machine with provider test doubles and drives every service journey in a real browser, on both seed profiles and in the federated topology.Service documentationEach service's end-to-end run generates its documentation (screenshots, Markdown and a Word document from the standard template), the service status list records five checks, and done means published to the central documentation share.

Operate

EnvironmentsDevelopment, test, staging and production: where each runs, what data it holds, and how a change moves from one to the next by configuration and promotion, never by code branches.Federation: hub and nodesHow one national portal (the hub) and many MDA back offices (nodes) work together over the signed, versioned /fed/v1 contract, what data lives where, how to change the contract and how to onboard a new node.

Security

Security and data protectionHow the platform applies the Data Protection Act No. 3 of 2021, the policy decision point, least privilege and maker-checker, audit, masking, tokens, secrets, uploads, outbound calls and rate limits, and what integrators must do.