> For the complete documentation index, see [llms.txt](https://docs.mosip.io/1.2.0/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.mosip.io/1.2.0/setup/cookbook.md).

# CookBook

## About this Functional Pilot Guide

The 'MOSIP Functional Pilot' Guide is a practical, step-by-step recipe for running a rapid MOSIP functional pilot in any country, end to end, in 3 to 4 months. It is written for the country implementation team --- program managers, technical leads, registration supervisors and field operators and it captures every ingredient, every step and every common mistake that the MOSIP team has seen across previous pilots.

The objective of the pilot is functional experience, not production scale. By the end of it, the country team will have deployed a complete MOSIP environment, registered up to 3,000 residents (a representative sample including children, adults, senior citizens and persons with disabilities), issued unique IDs, and exercised authentication using both OTP and biometrics through eSignet, with credentials downloaded into the INJI Wallet.

{% hint style="info" %}
**Before you start**

This cook book is intentionally country-agnostic. Wherever you see a placeholder such as "the Country Program", "the Country IT Team" or "the Pilot Authority", replace it with your local equivalent.
{% endhint %}

## Pilot Objectives

The pilot is a hands-on, end-to-end functional run-through of MOSIP. It is deliberately scoped to be small enough to complete in 3 to 4 months and large enough to surface the operational, technical and policy questions the country will face at national rollout.

## Primary objectives

* Experience the full MOSIP lifecycle --- pre-registration, registration, ID processing, ID issuance and authentication for up to 3,000 residents.
* Deploy MOSIP either on a public cloud or on the country's on-prem environment, following the hardware and software specifications in this cook book.
* Build country-team capacity through structured functional training, with operators and supervisors performing real registrations and resolving real-life edge cases.
* Exercise eSignet authentication using both OTP and biometric flows.
* Issue verifiable credentials and demonstrate them in INJI Wallet (mobile and web).
* Finalize the country-specific ID schema and master data which is the backbone of any future national rollout.
* Identify customization needs, integration touchpoints and policy decisions that must be addressed before scale.

## Out of scope for the pilot

* Production-grade sizing, performance benchmarking or load testing.
* Final commercial / costing decisions for national rollout.
* Integration with all downstream relying parties --- only a mock health portal is used.
* Multi-language UI rollout --- pilot runs in the country's official languages
* Permanent data retention --- pilot data is treated as test data and is not migrated into production systems

{% hint style="info" %}
**Success Criteria** "Up to 3,000 residents --- a representative cross-section of the population --- were registered, issued an ID and successfully authenticated using eSignet and INJI Wallet, and the country team is confident it can run MOSIP independently.
{% endhint %}

## Scope and Assumptions

### In scope

* Registration of up to 3,000 residents (representative sample of the population).
* Country-specific ID schema and master data.
* Online pre-registration and on-site registration.
* Both online and offline registration modes at the field Centers.
* Demographic and biometric deduplication via ABIS.
* Administration console and basic helpdesk operations.
* ID issuance in physical (paper format) or digital form.
* Authentication using biometric and OTP via eSignet.
* ID Credential download to INJI Wallet (mobile) and INJI Web.
* Minimal UI customisation of the registration and pre-registration screens.
* Functional training for the country team during the pilot.

### Key assumptions

* Biometric devices, ABIS and the biometric SDKs are provided by MOSIP through its biometric partner ecosystem.
* MOSIP's latest LTS version is deployed for the pilot.
* The registration rate at each kit is roughly 45 registrations per day, used for capacity planning of operators and Centers.
* High-speed internet is available at every registration Center during online registration windows; offline mode is exercised when connectivity is unavailable.
* A mock relying-party portal (health) is used to demonstrate authentication and service delivery.
* The country provides the on-prem or cloud infrastructure, network access and operational personnel; SMS and email gateway access is also provided by the country.
* The pilot cost model does not reflect national-rollout costing.
* All training, documentation and UIs run in official language of the country.

{% hint style="info" %}
\| **Decision needed early** | | | | Choose whether to host the pilot on a public cloud (faster to | | provision) or on a country on-prem environment (closer to the | | production footprint). MOSIP supplies the same hardware and | | configuration specifications for either option --- see Section 5. |
{% endhint %}

## Pilot Lifecycle at a Glance

The pilot moves through eight overlapping stages. The lifecycle is engineered so that the long-lead items biometric device shipment, infrastructure stand-up and ID schema sign-off --- start on day one and run in parallel with the build phase.

**Stage** **What happens** **Primary owner**

1. Objective alignment Confirm the why, the Country + MOSIP success criteria and\
   the participant mix.
2. End-to-end MOSIP runs a full MOSIP demonstration functional demo so the\
   country team has a\
   shared mental model.
3. Infrastructure Availability of on-prem Country readiness or cloud servers;\
   confirm sizing and\
   access.
4. Registration kit Biometric devices MOSIP + Country readiness shipped to the country\
   by MOSIP; non-biometric components (laptops,\
   printers, photo booths, cameras) procured\
   locally.
5. Minimal Country-specific ID MOSIP with Country customisation schema, master data and inputs light UI tweaks to\
   registration and\
   pre-registration\
   screens.
6. Functional training Hands-on training for MOSIP + Country technical staff,\
   operators and\
   supervisors using\
   real-world scenarios in the train-the-trainer\
   model.
7. Field registration Up to 3,000 residents Country registered across\
   Centers in online and\
   offline modes; IDs\
   issued; authentication\
   and INJI Wallet\
   exercised for a sample\
   set of residents
8. Closure and Lessons learned, Country + MOSIP reporting metrics,\
   recommendations for\
   scale; pilot sign-off.

{% hint style="info" %}
\| **Total elapsed time** | | | | 3 to 4 months from kick-off to sign-off, assuming biometric device | | shipment and country infrastructure both come online before UAT and | | operator/supervisor training. |
{% endhint %}


---

# 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.mosip.io/1.2.0/setup/cookbook.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.
