Hello Partner! Ready to delve deeper into the world of MOSIP? This expanded guide sheds light on the functionalities and benefits of each service and module available in the Collab environment. Explore, test, and build with confidence!

Let us dive deeper into MOSIP Collab: Services and Modules in detail.

Introduction

The Collab environment in MOSIP offers a collaborative platform for partners and stakeholders to thoroughly test, collaborate and validate their integrations, modules and services. This environment is exclusively designed for partners and contributors involved in developing solutions on the MOSIP platform enabling them to perform comprehensive testing and seamless integration of their solutions with the latest platform code. To gain access to this environment, kindly click here.

Purpose

This guide has been created to offer a step-by-step overview of the fundamental procedures that as a partner, you must adhere to, in order to begin working with the Collab environment. By carefully following the setup and configuration process, which is outlined module by module within this guide, you will be able to effortlessly access the Collab environment, establish the necessary modules or services, and effectively demonstrate the application features as relevant.

Pre-requisites

Before starting with the Collab environment, please ensure you have the following prerequisites in place:

• UIN Credential (Unique Identification Number) - Issuance of UIN as a demo credential will allow you to explore MOSIP's capabilities and experience seamless identity management firsthand. Provide your details in this UIN generation form, and we'll generate demo credentials that will enable you to navigate through different modules.

• MOCK SMTP - A mock SMTP server is a simulated email server used for testing and development purposes. In MOSIP, it is installed as part of the default installation and is utilized to mimic the behavior of a real SMTP server, allowing developers to test email functionality and interactions without sending actual emails. To setup a mock SMTP server for the message gateway during V3 installation, click here.

Let’s Get Started!

Step 1: Access the Collab Environment

• Open your web browser and navigate to the Collab environment URL: MOSIP Collab.

• In the Collab environment, click on the specific module/service that you want to access as a contributor.

Step 2: Follow the module-specific guide to integrate with/ test the preferred application

• In MOSIP's Collab environment, the following components and services are available.

• Navigate to the specific module you are looking to test and follow the corresponding guide for a step-by-step overview of the setup process involved.

Modules

Pre-registration - Optimize the Journey

Why wait to register at the centers?

• Pre-registration is a MOSIP module that allows residents to pre-register themselves by providing demographic data, upload documents, and book appointments, before official registration at the registration center, thereby optimizing the enrollment process. To learn more about pre-registration click here.

• For the end-to-end process on how to set up the Pre-registration in the Collab environment, click on Pre-registration Setup Guide.

• For details on how to use the application, refer to our end user guide.

Registration Client - Efficient Enrollments

• Registering residents quickly and accurately is crucial.

• The Registration Client application in MOSIP enables agents to efficiently register residents by capturing their demographic and biometric data, in addition to managing tasks like onboarding, data synchronization, software upgrades, and packet management. To know more about the installation and pre-requisites for the same, click here.

• For the end-to-end process on how to set up the Registration client in the Collab environment, click here.

• For details on how to use the application, refer to our user guide.

Resident Services - Empowering Users

• Imagine residents managing their identities with ease and convenience!

• Residents take center stage with the Resident Services module. This reference self-service portal empowers them to manage their Unique Identification Number (UIN), check their registration status, download documents, and access other essential services.

• This web-based UI application provides residents of a country the services related to managing their Unique Identification Number (UIN).To learn more about Resident Services, click here.

• For the end-to-end process of how to run Resident Services in our Collab env, click here.

Admin Portal - Master Data Management

• Behind the scenes, the Admin Portal empowers administrative personnel. This web-based platform helps manage master data, configure system settings, track user activity, and perform crucial operational tasks. Maintaining data accuracy and optimizing platform efficiency necessitates a robust administrative infrastructure, and the Admin Portal fulfills this role effectively.

• To learn more about the Admin Portal, click here. Admin portal access in Collab is limited, contact the community forum for specific module needs.

• For details on how to use the application, refer to our end user guide.

Partner Management - Trust Made Easy

• MOSIP thrives on collaboration, and the Partner Management System facilitates it. This module handles partner onboarding and manages policy configurations, between partners and the platform. Building solutions together has never been easier! To learn more, click here.

• MOSIP's Partner management services (PMS) module streamlines partner onboarding, policy management, and data sharing. It comprises of Partner Management and Policy Management Services, providing essential support for effective collaboration within MOSIP.

• For the end-to-end process of how to run Partner Management in our collab environment, click here.

• For details on how to use the application, refer to our end user guide.

Inji - Your Mobile Identity Wallet

• Imagine carrying all your IDs and credentials on your phone – securely and conveniently! Inji makes it a reality. This mobile wallet and authenticator stores various government-issued IDs, certificates, and even private credentials. Offline identity verification through selfies adds another layer of convenience and security. To learn more about Inji, click here.

• For the end-to-end process of how to run Inji in our Collab environment, click here.

• For details on how to use the application, refer to our end user guide.

eSignet - Simple and Secure Online Authentication:

• Signing-in online shouldn't be a hassle now. eSignet simplifies online authentication by allowing users to identify themselves and share profile information with just a few clicks. Secure and user-friendly, eSignet streamlines online interactions and protects user privacy. To learn more about eSignet, click here.

• For the end-to-end process of how to run eSignet in our Collab environment, click here.

• For details on how to use the application, refer to our end user guide.

Services

ActiveMQ - Smooth Communication Flow:

Imagine components talking seamlessly– that's ActiveMQ! This messaging broker facilitates asynchronous data exchange between different modules, ensuring smooth data transfers and efficient communication within the platform. Whether it's data updates, event notifications, or message relays, ActiveMQ keeps information flowing. To learn more, click here.

• For details on how to use the service, refer here.

Keycloak - Secure Access always!

• Identity management gets top priority with Keycloak. It acts as the gatekeeper, authenticating users and managing access control. Only authorized users with the right permissions can access specific modules and functionalities, upholding the platform's security and integrity. It plays a crucial role in maintaining the security and integrity of the platform by managing user identities, access controls, and user sessions. To learn more, click here.

• On how to use the key manager services with key stores like Hardware Security Module (HSM) and mosip_keymgr DB.

• Keycloak access in Collab is limited, contact the community forum for specific module needs or alternative auth methods.

Kibana - Visualize Your Insights

• Data without understanding is just numbers. Enter Kibana – your key to insightful visualization! This powerful tool transforms system metrics and logs into interactive dashboards and charts, revealing trends, patterns, and valuable information about platform performance and data flow. Monitor system health, identify potential issues, and make informed decisions with data clarity. In MOSIP, Kibana dashboards are utilized to monitor and analyze system metrics, logs, and performance data. To learn more, click here.

• The dashboards give a visual display of metrics and important data to track the status of various pre and post-enrollment processes. To get all the necessary information to effectively navigate and set up Kibana click here.

• For step-by-step instructions on how to access and configure the Kibana dashboard in your V3 installation, please click the following link: Accessing and Configuring Kibana Dashboard - V3 Installation Guide.

Object Store - Store It Securely and Scalably

• Think of Object Store as your secure and reliable storage vault. It handles diverse data types like documents, images, and files, guaranteeing their safekeeping and easy access. Object Store scales effortlessly to accommodate your growing data needs, ensuring a robust and flexible storage solution. In MOSIP, Object Store is used to store various types of data, such as documents, images, and files, providing a reliable and efficient storage solution. To learn more, click here.

• For installation for the object store, click here.

Kafka - Decoupled Data Exchange:

• In MOSIP, Kafka acts as the information highway of the platform. It enables real-time data exchange between modules in a decoupled manner, meaning they don't need to be directly connected. This ensures efficient communication, fault tolerance, and scalability, even with a multitude of modules interacting.

• It's purpose is to provide a scalable, reliable, and fault-tolerant way to transmit data and events in a decoupled manner, ensuring efficient communication and data synchronization across various parts of the system. To know more, click here.

• To check the details on how to set up Kafka for V3 installation click here.

Mock MDS/SBI Services - Testing Made Real:

• Need a testing ground for real-world scenarios? Mock MDS and SBI services come to the rescue! These simulated versions of the Master Data Store and Secure Biometric Interface replicate their functionalities without affecting actual data. Develop, test, and integrate your solutions with confidence, knowing you're working with realistic simulations.

• Mock MDS (Mock Master Data Store) is a simulated version of the Master Data Store used for testing and development purposes. It replicates the behavior of the actual Master Data Store but doesn't store data persistently. Mock MDS is used to mimic the interactions with the Master Data Store during testing and development, allowing developers to verify the functionality of different modules without affecting the real data. To learn more, click here.

• SBI (Secure Biometric Interface) in MOSIP ensures secure and reliable integration of biometric data for identity verification and authentication. SBI ensures secure storage and retrieval of biometric data, enhancing the accuracy and reliability of identity-related operations. To learn more, click here.

• To run Mock MDS/SBI in registration mode in the Collab environment, click here.

Step 3: Testing and Validation

Once the setup and configuration is completed, you should proceed with testing and validation activities to ensure the smooth functioning of the modules or services. The testing process may include:

• Performing end-to-end tests for the integrated modules or services.

• Validating data exchange and interoperability between different components.

• Verifying the compliance of the modules or services with the specified requirements and standards.

Step 4: Get-in-touch : Report issues and seek support

If you need any help or come across any problems during the testing and integration process, please feel free to contact us using the support system provided below.

• Navigate to Community.

Continuous communication and collaboration between the MOSIP team and the community will aid successful integrations and also help resolve issues if any, within the Collab environment.

We thank you for your ongoing support and look forward to building MOSIP together!

Support is a critical aspect of adopting any software. MOSIP too offers support to adopting countries and their solutions providers on the platform. This enables MOSIP users to get fixes and updates on the platform. This document lays down the MOSIP support policy, while also specifying how these apply to the various versions of MOSIP that have been released and the ones to come in the future.

Versions in MOSIP and their meaning

The MOSIP platform has versions. The first version of MOSIP is v1 and it has a planned set of features defined in its backlog/roadmap. Versions of MOSIP evolve and start with a base release version - e.g. v1.0.0

The release version tag has the format “vVersion(x.y).Version.Evolution.Patch”

• v1.2.1 means Version 1.2, evolution 1, no patch

• v1.2.0 means Version 1.2, base evolution, no patch

• v1.1.0.1 means Version 1.1, base evolution, patch 1

• v1.1.2 means Version 1.1, evolution 2, no patch

• v1.2.3.2 means Version 1.2, evolution 3, patch 2

• v2.0.0 means Version 2.0, base evolution, no patch

Version - A vision of MOSIP

MOSIP is an open source, and open standards project created so adoption of digital governance across the globe becomes easier, friendlier, safer, and transparent. As part of its evolutionary journey, MOSIP has clear visions and missions. The project and its roadmaps are then structured to achieve the vision and missions.

Versions of MOSIP indicate the phases of implementation of the MOSIP roadmap. v1 of MOSIP aims to provide a base platform for countries with features for issuance, lifecycle management of ID, and identity verification services keeping in mind first-time users and identity programs as the end user. The next phase of the roadmap will expand on this and bring more power to the platform catering to steady-state operations, migration from other systems and advanced use cases.

Evolutions are part of the working structure in MOSIP. Every version introduces changes to the platform. The changes introduced get finetuned over multiple evolutions. In true agile fashion and to bring interim usability and testability, features and capabilities are built incrementally and the version evolves both in capability and maturity. A new evolution release of the version that will retain the “Version” number, increment the “Evolution” number and reset the “Patch” number to zero.

A new patch release on the evolution (Patch Release) will retain the “Version” and “Evolution” numbers, and increment the “Patch” number.

Patch releases are done on an evolution of a version of MOSIP. They are not explicitly supported. The user is expected to migrate to the latest patch in order to get fixes. Patches will not introduce new features. New evolutions typically include the fixes in patches issued on the current evolution.

For e.g. v1.2.1 includes the fixes in patches v1.1.1, v1.1.2, v1.1.3.

Hotfixes are special point releases that are issued out of turn and are typically included in the next patch. A sample hotfix tagging will look like this v1.1.2.1 (format is vVersion.Evolution.Patch.Hotfix). Hotfixes are not always applied to all patches and evolutions even if they are relevant. They are issued only for production systems on a discretionary basis.

MOSIP follows a “Release Train” versioning. The core team continuously works towards improving and building new features. Every release is a rollover. So there is no breaking vs non-breaking release concept in MOSIP. As a part of this MOSIP would deprecate each and every work it does as part of its new rollover so that systems built over MOSIP can adopt these versions easily.

We highly recommend the adopters to keep their systems in sync with our releases so they gain full control over the digital governance vision.

Support status of a release

MOSIP uses a Support Rollover concept where MOSIP actively supports current evolutions, and provides essential support for the previous evolution and older evolutions move out of support. As newer evolutions are introduced the support is phased out for older evolutions.

An evolution typically goes through the support lifecycle of “Active Support” when it is current, “Essential Support” when it is superseded by a new evolution, and later moves into “Not Supported” and “End of Life” as more evolutions are introduced.

Long Term Support

While all evolutions typically go through the support lifecycle churn rapidly, specific stable versions are designated as Long Term Support versions. These versions are supported for many years and their rollover happens on the basis of the introduction of the next LTS evolution. Minimum support duration is assured for LTS versions. Countries are encouraged to base their systems on LTS versions to benefit from the long term support they get.

All support for MOSIP is provided under the MPL 2.0 license terms with no express warranties or guarantees.

Release versions will have an associated support type/status, and this will be mentioned on the release page in the documentation.

Option Packs

Once a version has moved to its LTS Evolution, no additional work is done on it other than fixes via patches. New features are not added. In some rare cases where compliance to some open standards is needed or new versions of specifications need to be supported for integration and interoperability, an option pack might be released to add these capabilities to the LTS version. Option packs will mirror the LTS version support policy where possible. In exceptional cases, they might come with their own support terms. Over-the-top tooling, additional adapters, and software infrastructure options will continue to evolve and grow in numbers.

Breaking Changes and Upgrade Path

Breaking Change

Breaking changes typically indicate a change in the Software infrastructure changes, Java interfaces, Webservice API, DB structure, Schemas, and Configuration properties. Such changes might affect integration, existing data, configuration, or customization.

Patch Upgrade

A patch upgrade or a hotfix typically does not include any breaking changes. These changes can be applied as component upgrades, optional scripts for data upgrades if any, and manual updates to configuration. Patches are typically not systemwide and focus on specific components.

Evolution Upgrade

Evolution releases include new features and potentially breaking changes, along with all the patches on the previous evolution. Major breaking changes are announced beforehand. All changes are documented as part of the release notes. Upgrade scripts will migrate configuration and data as needed and upgrade requisite MOSIP components. Configuration updates to software infrastructure will be provided as instructions where applicable. The process might also include steps to be undertaken outside of running the scripts. Customizations and integrations might need to be refactored.

Version Upgrade

Moving from one version of MOSIP to a newer version is expected to be a non-trivial exercise. Backward compatibility and migration scripts might provide only part of the migration. In order to take advantage of the newer features, workflow configuration, customization, integration, and infrastructural changes might be needed. Such an exercise must be undertaken as a project with complete testing and upgrade.

MOSIP Versions

Overview

Welcome to the Admin Portal Collab Guide. The Admin Portal is a web-based application that allows administrative personnel to manage various master data sets. It provides functionalities to oversee resources such as registration centers, devices, machines, users, and security management. Admin users can also generate master keys, track registration status, retrieve lost RIDs, and resume paused packets.

For a detailed breakdown of the Admin Portal features, please refer to the Administration Page.

Pre-requisites

• Accessing the Admin portal in the Collab environment requires no complex setup.

• All you need is a username and password to login to the Admin Portal.

• If you do not have credentials, you can request them here.

Step-by-Step Guide

Step 1: Access the Admin Portal

Visit the Admin Portal in the Collab environment by navigating to the Admin Portal.

Step 2: Log in to the Portal

1. Enter your username and password.

2. Click Login to proceed.

Step 3: Explore Admin Portal Features

Once logged in, you can access the available features based on your role. Refer to the Admin Portal User Guide for more details on specific functionalities.

Additional Resources

Please watch this video to learn more about the features in the Admin Portal.

Get in Touch

If you require any assistance or encounter any issues during the testing and integration process, kindly reach out to us through the support mechanism provided below:

1. Navigate to Community.

2. Provide a detailed description of your issue, including: a. Steps to reproduce the problem. b. Error messages, logs, or screenshots (if applicable) c. Any other relevant details to help diagnose the issue

We wish you a smooth experience with the Admin Portal collab guide!

Welcome to the Partner Management System Guide, designed specifically for our Collab Environment! This guide will assist you in easily accessing the Partner Management System and effectively demonstrating its features.

The Partner Management System (PMS) is an essential component of MOSIP's ecosystem, designed to facilitate seamless collaboration and interaction between MOSIP and its trusted partners. It offers a user-friendly interface for partners to register themselves and engage with MOSIP's services effectively.

With this Partner Management System Demo Setup, you're close to showcasing the impressive capabilities of MOSIP's Partner Management System. Let's get started!

Pre-requisites

• Accessing the Partner Management System in the Collab environment is a simple process that does not require extensive setup.

• All that is needed is a username and password. If you are a new user, you can click on the Register option to create your credentials and register as one of our partners.

Step-by-Step Process

Step 1: Access the Partner Management System:

Visit the following URL to access the Partner Management System in the Collab environment: Partner Management System.

Step 2: Login:

• Login to the portal with a username and password.

• Get your credentials by simply registering yourself by clicking on New user on PMS.

Step 3: Explore the features on the Partner Management System

To access all the features of the Partner Management System and explore the partner onboarding process in MOSIP, refer to our end user guide.

Note: We kindly request you to fill out the attached form in order to request a password modification for your account. This is necessary as the current Partner Management System (PMS) in the Collab environment does not allow users to change their passwords independently. To cater to your specific requirements and security protocols, we encourage you to submit a formal request to MOSIP using this form. Our team will promptly assist you with your password customization.

Additional Resources

• Watch this video for a visual walkthrough of the features.

• Click on Partner Policies, Auth Partner, Device Partner, and Foundation Trust Partner to get in-depth knowledge of PMS.

For more information about Partner Management System Developer Setup, click here.

By following these instructions, you will be equipped to seamlessly set up the Partner Management System, and effectively use all the features, and book an appointment.

Get in Touch

If you require any assistance or encounter any issues during the testing and integration process, kindly reach out to us through the support mechanism provided below.

• Navigate to Community.

• Provide a detailed description of the support you require or provide detailed information about the issue you have encountered, including steps to reproduce, error messages, logs, and any other relevant details.

Thank you. Wishing you a pleasant experience!

Welcome to the MOSIP Resources Hub! Explore the wide range of resources available to help you get started with and deepen your understanding of MOSIP. This section provides everything you need to explore, build, and collaborate with MOSIP.

🌍 Introduction to MOSIP and Its Use Cases.

In this section, we will explore the importance of digital identification, the challenges nations face without robust ID solutions, and the key differences between functional and foundational IDs.

MOSIP offers a scalable, secure, and inclusive identification system that helps governments establish efficient and flexible national ID frameworks. You'll discover MOSIP’s core offerings, innovative modules, and how it seamlessly integrates into real-world applications.

Please watch the video below to get started 🚀

Additional Resources

🛠️ Development Resources

• Source Code: Access MOSIP's open-source codebase on GitHub Repositories.

• Containers: Find prebuilt MOSIP containers in the Docker Repository

• Maven Repository: Explore MOSIP artifacts on the Nexus Repository.

🎓 Learning and Training

• Training Programs: Learn through detailed courses available at the MOSIP Academy.

• Learning Videos: Watch tutorials, walkthroughs, and webinars on the YouTube Channel.

🤝 Community and Collaboration

• Community Forum: Engage with the MOSIP community, ask questions, and share insights on the MOSIP Community on Discourse.

• Website: Explore our official website for comprehensive information at mosip.io.

• LinkedIn: Connect with us on LinkedIn.

Welcome to the Self-Experience Demo Guide! ✨

Get ready to explore how your National ID as Verifiable Credentials (VCs) can be leveraged for secure and efficient access to essential services.

This step-by-step guide will take you through the complete loan application journey, demonstrating how a National ID can be used to seamlessly access financial services.

By following these simple steps, you will:

• Self-register and obtain your National ID.

• Download your National ID and Tax ID (TAN: Tax Account No.) VCs to your wallet.

• Apply for a loan using your Verifiable Credentials (VCs).

Throughout this process, you will interact with the MOSIP national ID platform, the Inji credentialing stack, and the eSignet OIDC login provider.

Read on and follow the steps below to begin your experience!

Let’s get started! 🚀

1.1 Access the Self-Registration Portal

1. Open your browser and visit the Self Registration Portal.

1.2 Complete the Registration Form

1. Fill in the required details and provide consent to proceed.

1.3 Upload Your Face Photo

1. Upload a saved photo or capture one live via the portal.

1.4 Preview & Confirm

1. Review your details, ensure accuracy, and click Submit.

1.5 Registration Confirmation

1. Upon submission, you'll receive a confirmation screen displaying your National ID. Congratulation! You're done with the registration process!

1.6 Receive UIN and TAN

Once successfully issued, you will receive:

1. UIN (Unique Identification Number)

2. TAN (Tax Account Number) - To enable you to experience the loan application use case (apply for loan)

1.7 Email Notifications

You’ll receive two emails:

1. UIN Issuance Email - Includes your UIN (Unique Identification Number) / National ID in PDF format.

2. TAN Email Notification - Includes instructions on downloading your National ID and TAN VC via the INJI Mobile Wallet.

2.1 Install INJI Mobile App

1. Download and install the INJI Mobile app using the link provided in the TAN notification email, or click here and select the relevant INJI Mobile option, based on your OS (Android or iOS).

2. Alternatively, You can also visit INJI Web to download the VCs as PDF.

Please refer below to know more.

To download the VCs in your INJI Mobile App follow the steps below:

2.2 Download Your National ID VC

1. Open the INJI Mobile app and tap + to view issuers.

2. Select National Identity Department → MOSIP National ID (browser redirects to eSignet).

3. Enter your National ID and the OTP sent to your email.

4. Upon validation, your National ID VC will be downloaded to your wallet.

2.3 Activate Your National ID VC

1. Open the National ID VC in the wallet.

2. Tap Activate and enter the OTP to enable online authentication.

2.4 Download Your TAN VC

1. Tap + in the INJI Mobile app.

2. Select Republic of Veridonia Tax Department → Tax Account Number (browser redirects to eSignet).

3. Enter your National ID and the OTP received via email.

4. Upon validation, your TAN VC will be downloaded.

2.5 Activate Your TAN VC

1. Open the TAN VC in the wallet.

2. Tap Activate and enter the OTP to enable online authentication.

To download the VCs using the INJI web follow the steps below:

2.6 Download your National ID VC:

1. Navigate to the INJI web portal and click on Get Started.

2. Select National Identity Department → MOSIP National ID.

3. Select the Consent Validity, and click on Proceed (browser redirects to eSignet).

4. Enter your National ID and the OTP sent to your email.

5. Upon validation, your National ID VC will be downloaded to you locally.

2.7 Download your TAN VC:

1. Navigate to the INJI web portal and click on Get Started.

2. Select Tax Department → Tax ID.

3. Select the Consent Validity, and click on Proceed (browser redirects to eSignet).

4. Enter your National ID and the OTP sent to your email.

5. Upon validation, your National ID VC will be downloaded to your local device.

3.1 Access the Banking Portal

1. Open your browser and go to the Banking Portal.

3.2 Sign in with Your National ID

1. Click Sign in with National ID to be redirected to eSignet.

2. You will have two options to authenticate your National ID:

   1. Authenticate with OTP

   2. Authenticate with INJI Mobile

   For experiencing this use case we recommend using the OTP as the authentication factor.

3. Choose Login with OTP.

4. Enter your National ID and the OTP sent to your registered email.

5. Once verified, you'll return to the portal to begin your loan application.

3.3 Apply for a Loan

1. Click Apply for Loan on the home page, you will be redirected to the page to verify your TAN.

3.4 Verify Your TAN

You have two options to verify your TAN VC:

1. Scan QR Code: Use your device camera to scan the QR code from your TAN VC.

2. Upload TAN VC: Upload the TAN VC file from your device.

Option 1: Scan the QR Code

1. Click on the Scan QR Code option on the page to verify your TAN.

2. You will need two devices: One device will have the camera open (where you are accessing the banking portal), and the other will display the TAN VC QR code.

3. When prompted, allow camera access to enable the device to scan the QR code.

4. Focus the camera on the QR code of the TAN VC displayed on the other device.

5. Once scanned, the data will be processed for verification.

6. After successful verification, your TAN VC credentials will be displayed on the banking portal.

Option 2: Upload the TAN VC

1. Select Upload QR Code.

2. Click Upload and choose your TAN VC file with a QR code from your local device.

3. The data will be processed for verification.

4. Upon successful verification, your TAN VC credentials will be displayed on the banking portal.

3.5 Complete the Loan Application

1. Once your TAN VC is verified, you’ll see a congratulations message with your credit score and loan eligibility status.

2. Review your credit score and loan eligibility.

3. Click Proceed to complete the loan application form.

4. The form consists of two sections:

   1. Loan Details: Fill in all the mandatory fields related to your loan.

   2. Pre-filled Personal Information: Your details will be auto-filled based on your National ID and TAN VC.

3.6 Loan Approval

1. Submit your application.

2. Once processed, you'll receive confirmation of your approved loan amount.

You're all set! 🎉

Congratulations! You’ve successfully used your National ID and TAN VC to apply for a loan.

This experience showcases the power of secure foundational digital identity and verifiable credentials, in enabling hassle-free access to essential services. We hope this walkthrough gave you valuable insights into the potential of trusted digital identity ecosystems, powered by MOSIP, Inji, and eSignet.

Thank you for participating and stay connected for more exciting innovations ahead! 🚀

Overview

The Pre-registration module within MOSIP is designed keeping residents in mind, offering a user-friendly pre-registration process. This module boasts of a wide range of functionalities, starting with the collection of demographic data along with easy uploading of essential supporting documents, such as proof of address and birth certificates, besides facilitating appointment booking, modifications and notification alerts to mention a few.

With this Pre-registration Client Demo Setup, you're one step closer to showcasing the power of MOSIP's pre-registration capabilities. So let's get started!

Pre-requisites

• Accessing the Pre-registration portal in the Collab environment does not require any complex setup.

• All you need is a 10-digit Mobile Number or a valid email ID and you are good to go!

Step-by-Step Process

Step 1 - Access the Pre-registration Portal:

Step 2 - Login:

Login to the portal with a mobile number or valid email ID. Refer below for details.

Mobile Number:

• If you choose to login using your mobile number, you will be required to enter any 10-digit mobile number, as an example - “1234567890”.

• Click on the captcha tick box to proceed to the next step.

Email ID:

• Alternatively, you can choose to login with your email ID.

• For the Collab environment, real email ID OTP verification is performed.

• Enter a valid email ID and an OTP will be sent to your email address. You can then enter the OTP received on the provided email ID to verify yourself and login to the portal.

Step 3: Explore the features on the Pre-registration Portal:

Note: Please use 111111 as the OTP, for any OTP-based feature in the Collab environment.

Additional Resources

By following these instructions, you will be equipped to seamlessly set up the pre-registration portal and effectively use all the features and book an appointment.

Get in Touch

If you require any assistance or encounter any issues during the testing and integration process, kindly reach out to us through the support mechanism provided below.

• Provide a detailed description of the support you require or provide detailed information about the issue you have encountered, including steps to reproduce, error messages, logs, and any other relevant details.

Thank you. We wish you a pleasant experience!

Welcome to the Inji Guide tailored specifically for our Collab Environment!

Inji Wallet:

Inji Web:

Inji Verify:

Thank you. Wishing you a pleasant experience!

The Registration Client setup guide for the MOSIP Collab environment offers a detailed and user-friendly walk-through to assist you in configuring and accessing the Registration Client module. This module is specifically designed to provide Operators/Supervisors with a wide range of functionalities, including onboarding, data synchronization, packet management, and more.

The primary goal of this guide is to ensure that you can efficiently set up the Registration Client in the MOSIP Collab environment with minimal effort. Whether you are new to the module and just starting to explore its features or an experienced operator seeking a streamlined setup process, this document will guide you through the essential steps to ensure that you have all the necessary tools available at your disposal.

With the implementation of this Registration Client Demo Setup, you are now on track to demonstrate the remarkable capabilities of MOSIP's Registration system. Let us proceed with the next steps to commence the process.

Pre-requisites

1. Hardware

• Workstation

• Windows 10/11 laptop or desktop

• Minimum 16 GB RAM

• 50 GB of free space on the hard disk

• Wireguard access

2. Software

• • Download the JDK installer

    • Access the Java SE Downloads page and click Accept License Agreement. Under the Download menu, click the download link that corresponds to .exe the version of Windows 10.

    • Download the file jdk-11.interim.update.patch_windows-x64_bin.exe.

  • Run the JDK installer

    • You must have administrator privilege to install the JDK on Microsoft Windows.

    • To run the JDK installer, start the JDK 11 installer by double-clicking the installer's icon or file name in the download location.

    • Follow the instructions provided by the installer.

    • After the installation is complete, delete the downloaded file to recover the disk space.

• Download and run the TPM Utility

  • This is used for registering the workstation on which the Registration Client would be executed.

  • Steps to download and extract the TPM utility

    • Open the README.txt file for supporting information.

    • Download and extract the TPM utility (using the command prompt).

    • Run the following command from the folder where the TPM jar is located (The location of the folder is necessary while running the command) - java -jar tpmutility-0.0.2.jar > tpmdetails.txt

    • Make note of the details within tpmdetails.txt for the next step.

• Share TPM Details

  • Make sure you share tpmdetails.txt with us according to the form fields.

  • Once the details are received, we at MOSIP, will register your machine for usage of Registration Client in the Collab environment.

Steps to run Mock MDS

• Click on the folder where the Mock MDS is downloaded and double-click on the folder name mock.

• You will be able to see the run.bat file in the mock folder.

• Double-click on run.bat and extract the file in your system where you can name the folder Collab-mock-mds-reg.

• Click on the Collab-mock-mds-reg folder where you will find the sub-folder called Target and then you can click on the Target folder to find the required files to run in the system to activate mock mds.

• You can click and explore collab-mock-mds-reg › target › Profile › Default › Registration to see the demo biometrics already updated for finger, iris, and face which will be used while testing the Registration Client, so you won’t be required to do any additional work here.

• Click on run_reg.bat to run the mock MDS for the Registration Client.

Step-by-Step Process

To effectively experience the Registration Client features in the Collab environment, follow the steps given below:

Step 1: Access the Registration Client Portal

step 2: Activitating Wireguard.

Launch the wireguard and connect to the provided configuration to enable a secure VPN connection.

Step 3: Login

After completing the above prerequisites, you should receive the username and password you need to log in to the portal.

Step 4: Explore the features on the Registration Client Portal

Get in Touch

If you require any assistance or encounter any issues during the testing and integration process, kindly reach out to us through the support mechanism provided below.

• Provide a detailed description of the support you require or provide detailed information about the issue you have encountered, including steps to reproduce, error messages, logs, and any other relevant details.

Thank you. Wishing you a pleasant experience!

Welcome to the eSignet Guide tailored specifically for our Collab Environment!

In this guide, we will walk you through the step-by-step process of authenticating yourself on a relying party’s demo health service portal that has integrated with eSignet and also helps you explore its various modes of authentication. This will enable you to get conversant with a secure & streamlined way of authenticating yourself and accessing online services while ensuring your identity & information remain protected.

Let's dive into the details and embark on this informative journey of seamless authentication and exploration!

Overview

This style guide includes the guidelines for writing clear and consistent MOSIP-related documentation. This document can be used as a reference if you are new to writing in MOSIP!

It is recommended to follow the guidelines mentioned below.

File naming conventions

1. Every directory/folder can have a README.md file to convey what is present in it or can have any information that will benefit the user.

2. Filenames to start with lowercase. For longer and meaningful names, start with lowercase and then add hyphens (-) instead of underscores (_). The are a few exceptions like README, LICENSE.

3. Use dots only for extensions in filenames and not for joining words.

4. File names should be as descriptive and meaningful as possible. It is better to avoid using any special characters (& # * !) in the names.

5. In general, ensure that the filenames match the main heading on the page. Example, name of this file is mosip-documentation-sytle-guid.md.

How to write in a markdown file?

Markdown files are text files with .md extension.

Headers

• A file will have a heading followed by an Overview/Introduction/About section.

• There can be multiple other topics that can follow.

• For the main heading, use single # and it can have capitalization as required (use title case).

• For the "Overview" section, use double ## (use sentence case).

• For the other topics, use double hash or triple hashes, based on the importance of a topic or sub-topic.

Bold

To make content/words bold, use double asterisks.

Example: I will complete these lessons!

Italics

To make words italic, use underscore (_).

Example: Note

Lists

For bulleted lists, give * with space before each entry. For numbered lists, write the numbers followed by dots and a space.

Bulleted list

• Apple

• Banana

• Water melon

Numbered list

1. Apple

2. Banana

3. Water melon

Links

To link the content or provide references, write the content to be displayed on the screen in square bracket and the link in the parentheses (). It is also possible to provide references to specific topics.

To provide links to other pages, you may use:

1. Learn more.

2. See title of other document.

3. Refer title of other document for ….

Example: For more information on Packet Manager, see Packet Manager.

Images

Images may be inserted in documents as required but they need to be uploaded in the repository before referring to them.

Syntax:

![ alt text for screen readers](/path/to/image.png "Text to show on mouseover")

Example: ![](_images/image-settings.png)

Below is an example of an diagram created using draw.io which is a free diagramming browser app.

Recommended settings to generate a PNG file on draw.io:

1. Go to File -> Export as -> PNG -> Advanced

2. Set DPI: 200 dpi (from drop-down)

3. Uncheck Transparent option.

4. Click Export.

Another way to adjust the height and width of the image is by using the HTML tag:

<img src="_images/mindtree-logo.png" width="400" height="100">

Indentation and sub-bullets (list in list)

Indentation must be done using 4 space characters instead of tabs as editors interpret tabs differently.

Example: Bulleted List

• Item 1

• Item 2

• Item 3

  • Item 3a

  • Item 3b

  • Item 3c

Numbered List

1. Item 1

2. Item 2

3. Item 3

   1. Item 3a

   2. Item 3b

   3. Item 3c

See Markdown Guide.

Code

There are two ways to format code in Markdown. You can either use inline code, by putting backticks () around parts of a line, or you can use a code block putting backticks () around parts of a line.

E.g.: mosip_idrepo DB

For code blocks, you can use three backticks ( ``` ) or three tildes ( ~~~ ) on the lines before and after the code block.

To know more, refer here.

Writing style

1. Language and Grammar: In general, use second person in documents rather than first person — you instead of we. Also, avoid using our in documentation. Also, use active voice as much to make clear who's performing the action.

   Not recommended

   Recommended

   If we are deleting multiple entries at a time...

   If you are deleting multiple entries at a time...

   For details, read our documentation.
2. Clarity: Content needs to be concise and we need to write sentences that are short and crisp. Unordered bullet points can be used to simply content. If paragraphs are present, remember to make it short with close to 5-6 sentences (about 100-200 words).

3. Consistency: Maintain consistency in words and usage. For example, use "ID Repository" instead of "id repo", "WebSub" instead of "websub", "Registration Client" instead of reg client, "Pre-registration" as the concept and Pre-Registration if we are referring to the module.

4. Punctuations: The right use of commas and period/full stop is extremely important. Sentences should end with a period and connecting phrases to have commas.

   Example: For more information on punctuations, refer here.

5. Symbols: Don’t use symbols and shortcuts like ampersand “&” in headings, text, navigation, or tables of contents. Instead, we can use and unless it is necessary in the code.

6. Capitalization: Adhere to the standards for capitalization of words in the product name or abbreviations used. Examples:

   • While referring to out platform, use MOSIP instead of mosip.

   • While referring to IDs, use user ID instead of user id.

   • Write ABIS instead of abis.

7. Tables: Use tables to organize data that is too detailed or complicated to be described adequately in the text allowing the reader to quickly see the results.

   Example: Pre-registration UI specifications.

8. Spell check: Run a spell check using any online software or using MS-Word before saving changes. This is also called as proof-reading the document. Note: This is crucial as running a spell checker ensures that the number of typos in your document decreases significantly.

9. Hyperlinks: On completion, check if all the hyperlinks on the page are working fine. Any broken link can be distasteful to the reader.

10. Avoid repetition of words or content.

    Example:

    Initial draft

    Final draft
11. Spacing: Avoid leaving unnecessary empty spaces between words or sentences. You may leave one line space between each paragraph or as needed incase of multiple paragraphs.

12. Avoid using the terms like blacklist, black list, black-list, whitelist.

    Instead, it is recommended to use:

    • For the noun blacklist, consider using a replacement such as denylist, excludelist, or blocklist.

    • For the noun whitelist, consider using a replacement such as allowlist, trustlist, or safelist.

    • For the noun graylist (greylist), consider using a replacement such as provisional list.

Templates

Templates for some standard pages are available as below:

• README template: For READMEs in repositories. Make sure this file is called README.md.

• Module template: Template for landing page of a MOSIP module or service.