> For the complete documentation index, see [llms.txt](https://docs.oomus.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.oomus.org/getting-started/overview.md).

# Overview

> **Version** : 5.14.1 · **Date** : 2026-05-30

## Vision

Oomus CampaignID was born from a simple observation: in many countries in sub-Saharan Africa and in low-resource countries (PRFI), public health systems suffer from three major shortcomings:

1. **Paper cards** — easily lost, forged, or damaged, with no possibility of cross-checking
2. **System fragmentation** — each program (vaccination, nutrition, malaria, HIV) manages its own lists, its own cards, creating massive duplication and an inability to have a longitudinal view of the beneficiary
3. **The lack of offline verification** — in areas with intermittent connectivity, health workers cannot verify the authenticity of a card without an Internet connection

Oomus CampaignID addresses these three challenges with a sovereign, interoperable infrastructure designed to operate in real field conditions.

***

## The problem solved

### Paper cards → Secure digital cards

Each card generated by Oomus CampaignID is:

* Linked to a cryptographically secure unique identifier (CSPRNG Base36)
* Signed by an opaque-token QR code (non-reversible, SHA-256 based)
* Verifiable offline via a downloadable static portal
* Verifiable online via the public route `/verify?p=…&s=…` — without authentication
* Instantly distributable via WhatsApp, SMS, or Google Wallet

### Fragmented systems → Unified MPI identity

The sovereign Master Patient Index (MPI) enables each citizen to have a unique digital health identifier, usable across all health programs. The same beneficiary can receive a vaccination card, a nutrition card, and a health insurance card — all linked to the same sovereign identity, with automatic deduplication.

### Impossible verification → Universal offline verification

The Oomus CampaignID verification portal is a static artifact (HTML + JSON) that works without any connection to the server. The health worker downloads the portal once, then can verify thousands of cards in completely offline mode.

***

## Key capabilities

### Large-scale card generation

* Asynchronous batch generation (Celery + Redis)
* Up to 10 million beneficiaries per program
* DPI options: 300 dpi (standard), 450 dpi (enhanced), 600 dpi (PVC printing)
* PDF export (front/back) + ZIP archive + offline verification portal
* **11 visual templates** including the template **Sovereign** (boarding pass 1011×375 px @ 300 DPI, configurable via `SovereignCardConfig`, fingerprint icon)

### Card Studio — Visual template editor

* 11 ready-to-use templates covering the main health programs
* Full customization: logos, colors, dynamic fields, QR code
* Real-time PNG preview
* Export configurations in YAML/JSON

### DHIS2 Tracker integration

* Direct connection to your DHIS2 instance (v2.36+)
* Automatic enrollment synchronization (configurable cron)
* DHIS2 attributes mapping → card fields
* Automatic MPI resolution during synchronization
* Protection of sensitive data (AI guard — 7 categories)

### Sovereign Wallet

* Digitally signed HMAC-SHA256 passes — verifiable offline
* Encrypted offline bundle for on-device synchronization
* Multi-device management with synchronization history
* Audited and time-stamped revocation
* Public pass verification portal: `/verify?p=<payload>&s=<sig>`

### Country & currency configuration

Oomus CampaignID includes a directory of **40 African countries** grouped into 4 regions, each associated with its ISO 4217 currency:

| Region              | Covered countries                                                                                    |
| ------------------- | ---------------------------------------------------------------------------------------------------- |
| **West Africa**     | Senegal, Mali, Burkina Faso, Niger, Guinea, Côte d'Ivoire, Ghana, Togo, Benin, Nigeria, and 5 others |
| **Central Africa**  | Cameroon, Chad, CAR, DRC, Republic of the Congo, Gabon                                               |
| **East Africa**     | Rwanda, Uganda, Kenya, Tanzania, Ethiopia, Somalia, and 3 others                                     |
| **Southern Africa** | South Africa, Zambia, Zimbabwe, Botswana, Namibia, and 4 others                                      |

Selecting a country in the program settings automatically fills in the currency (XOF, XAF, NGN, KES, ZAR…). The 21 unique currencies covered are available in the Preferences menu.

### Multichannel distribution

* **WhatsApp** : Meta Graph API v25.0 — card image + custom message
* **SMS** : Orange SMS API OAuth2 — West Africa coverage
* **Google Wallet** : generic pass with QR, name, program, date — individual or bulk issuance (100 cards)

### Simulation and governance engine

* Complete pro forma estimate before commitment
* Multi-level admin approval workflow
* Contract generation (PDF, Excel, JSON/YAML)

### Admin Panel v5.14 — Full governance

The administration panel provides complete operational management of the platform in **9 sections** dedicated to:

| Admin section              | Capabilities                                                                                  |
| -------------------------- | --------------------------------------------------------------------------------------------- |
| **Overview**               | Global platform statistics, program management, recharge validation, billing engine config    |
| **DHIS2 integration**      | Config management, circuit breaker, sync metrics, field mapping, error diagnostics            |
| **Verification Portals**   | Portal revocation, scan metrics, CDN deployment or self-hosting                               |
| **Platform Analytics**     | Aggregated business KPIs, revenue, trends, enterprise module usage, CSV/Excel exports         |
| **AI Fraud Detection**     | IsolationForest alerts, min\_risk filters, distribution by type (brute\_force, invalid HMAC…) |
| **All Campaigns**          | Multi-program overview, status/type/search filters                                            |
| **Generation Jobs**        | Async Celery monitoring, real-time statuses, automatic quota refund, WebSocket                |
| **PVC Orders**             | pending→delivered cycle, admin pricing config, tracking number, automatic invoices            |
| **Sovereign MPI Register** | Cross-program federation, duplicate merging, KYC verification, complete audit trail           |

### Security and compliance

* Secure JWT authentication (fixed algorithm, token versioning) + strong hashing, institutional RBAC
* Strengthened password policy (length + complexity)
* Network isolation: databases and internal services with no exposed external ports
* Strict CORS, Content-Security-Policy, HSTS in production
* Immutable audit trail (SHA-256)
* AI anomaly detection (IsolationForest)
* Automatic guarding of sensitive data (HIV, TB, biometrics, etc.)
* Sovereign hosting option

***

## Target users

| Organization type                | Examples                                                      |
| -------------------------------- | ------------------------------------------------------------- |
| **National health programs**     | National immunization directorate, NMCP (malaria), NACP (HIV) |
| **Ministries of Health**         | Health IT department, universal health insurance directorate  |
| **Humanitarian agencies & NGOs** | UNHCR, UNICEF, MSF, World Vision, Plan International          |
| **Government agencies**          | National identification agencies                              |
| **Local authorities**            | Regions, health districts                                     |

***

## Supported use cases

| Program                     | Card type                               | Distribution                     |
| --------------------------- | --------------------------------------- | -------------------------------- |
| Vaccination (EPI)           | Digital vaccination card                | WhatsApp + SMS                   |
| Malaria / ITN               | Mosquito net distribution card          | Google Wallet + SMS              |
| Nutrition                   | Nutrition tracking card                 | WhatsApp                         |
| Maternal health (ANC/PMTCT) | Antenatal tracking card                 | WhatsApp + SMS                   |
| HIV/PMTCT                   | Program card (sensitive data protected) | SMS only                         |
| Health insurance            | Membership card                         | Google Wallet + WhatsApp         |
| Refugee identification      | Humanitarian ID card                    | SMS + offline                    |
| Agricultural health         | Farmer card / rural health              | SMS                              |
| Laboratory                  | Results card (lab)                      | WhatsApp                         |
| National health identity    | Sovereign health ID card                | Google Wallet + Sovereign Wallet |

***

## High-level architecture

```
┌──────────────────────────────────────────────────────────────────┐
│                      Oomus CampaignID v5.14.1                    │
├──────────────┬──────────────────┬───────────────────┬────────────┤
│  Card Studio │  Campaign Engine │  MPI Sovereign    │  Admin v5.14│
│  (11 templates)│  (Celery async)  │  Identity         │  (9 pages) │
├──────────────┴──────────────────┴───────────────────┴────────────┤
│              DHIS2 Tracker Integration (safe read-only guard)     │
├──────────────┬──────────────────┬───────────────────┬────────────┤
│  WhatsApp    │  SMS (Orange)    │  Google Wallet    │  Sovereign │
│  (Meta v25)  │  (OAuth2)        │  (Generic Pass)   │  Wallet    │
├──────────────┴──────────────────┴───────────────────┴────────────┤
│  Verify Portal (Offline + /verify public) │  HL7 FHIR R4         │
└──────────────────────────────────────────────────────────────────┘
```

***

## Next steps

* [Quick start](/getting-started/quick-start.md) — Create your first campaign in 5 steps
* [Plans & Features](/getting-started/plans-and-pricing.md) — Choose the plan suited to your program
* [Sovereign MPI identity](/features/mpi-sovereign-identity.md) — Understand the digital identity system
* [Enterprise Modules v5.2+](/enterprise-modules/enterprise-modules.md) — AI, Geo, Trust Score, Sovereign Wallet


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.oomus.org/getting-started/overview.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.