Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Welcome to the eSignet Setup Guide tailored specifically for our Collab Environment!
To fully explore eSignet and its features in the Collab environment, we kindly request you to refer to the eSignet Try it out section provided within the eSignet documentation.
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!
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.
The Collab environment in MOSIP offers a collaborative platform for partners and stakeholders to thoroughly test 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.
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.
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 SMPT - 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!
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.
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.
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.
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.
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.
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.
MOSIP thrives on collaboration, and the Partner Management Portal 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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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!
Welcome to the Registration Client Setup Guide tailored specifically for our Collab Environment!
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.
Workstation
Windows 10/11 laptop or desktop
Minimum 16 GB RAM
50 GB of free space on the hard disk
The workstation should be TPM 2.0 enabled. To access the guidelines on how to verify the TPM compatibility of your workstation, click here.
Note: It is important that your workstation is TPM 2.0 enabled and does not operate on any older version of TPM. In the event that your workstation currently utilizes an older iteration such as TPM 1.2, it may be necessary to upgrade your BIOS firmware to enable TPM 2.0. Should you require assistance in carrying out this upgrade, please reach out to your vendor for guidance.
JAVA - Ensure JAVA 11 is installed and JAVA_HOME is in the PATH. To download JAVA 11 in your system, click here.
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 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.
To access and set up the utility, click here.
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
Once the TPM utility is extracted and run in your system, fill out the details in this form here to get your machine registered with MOSIP.
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.
Credentials: Once the TPM request is received via the form, and your machine is registered with us, we will provide you with the necessary credentials to access the Registration Client and share the details with you via your email ID provided in the form.
Mock MDS: Click here to download the Mock MDS in your system folder, which will enable you to simulate biometric capture (without real biometric devices).
Steps to run Mock MDS
Download the Mock MDS zip provided here.
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.
To effectively experience the Registration Client features in the Collab environment, follow the steps given below:
Step 1: Access the Registration Client Portal
Visit the following URL to access the Registration Client portal in the Collab environment: Registration Client Portal
Click on Registration Client- Windows 10 and download it to your local system.
Step 2: Login
Login to the portal with the username and password that you should have received, on completion of the above pre-requisites.
Step 3: Explore the features on the Registration Client Portal
To start running the Registration Client, refer to our Registration Client Installation Guide.
To access all the features of the Registration Client portal and explore the registration process in MOSIP, refer Registration Client User Guide.
Note: For Supervisor Authentication and Packet Approval Authentication, please provide the same username and password that was provided during login.
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!
The Resident Portal Setup Guide for Collab Environment provides a comprehensive introduction to the services available on Resident Portal, as well as a guide on how to navigate its features.
Resident Portal is a user-friendly web-based platform designed to assist residents in accessing services related to their Unique Identification Number (UIN). This portal allows residents with a UIN to conveniently manage their UIN, protect their identity, track requests, and obtain personalized cards. For a more detailed overview of the features offered, please visit here.
This Resident Portal Demo Setup guide serves as a tool to demonstrate the impressive capabilities of MOSIP's system. Let's embark on this journey together to explore the potential of Resident Portal.
Please note that for developers setting up Resident Portal locally, refer to the Developers Guide.
Accessing Resident Portal in Collab environment does not require any complex setup.
All you need is a UIN or a VID and you are good to go!
To get your UIN credentials for Collab environment follow the below steps:
The provision of a UIN (Unique Identification Number) as a demo credential will enable you to have a firsthand experience of the Resident Portal's capabilities and explore its various features.
Please complete the form provided and submit it. Once received, we will generate a demo credential for you to use in order to login to the Resident Portal.
Note: Please use 111111 as the OTP, for any OTP-based feature in the Collab environment.
Step 1: Access Resident Portal
Visit the following URL to access Resident Portal in Collab environment: Resident Portal
Step 2: Login
The recommended method for accessing the Resident Portal in the Collab environment is to use a valid UIN (Unique Identification Number), which can be obtained by completing the form provided. This is one of the options available for logging in and accessing UIN-related services on the Resident Portal.
There are multiple methods for logging in to access UIN services on the Resident Portal:
Login with Inji: To download and use the Inji application, click here.
Login with Biometrics: To set up a biometrics device on your system, click here.
Login with OTP (One-Time Password): Enter UIN/VID received from our end and use 111111 as OTP, for login to Resident Portal in Collab environment.
Step 3: Explore the features of Resident Portal
To access registration related information, click here.
Go to Get Information section.
Click Registration Centers to get the list of Registration Centers near you or to look for Registration Centers based on location hierarchy.
Click Supporting Documents to get the list of documents that Resident Portal supports.
To download the UIN card or to know the status of your AID, click here.
Next, go to Get My UIN section.
To book an appointment for a new enrolment, click here.
Go to Book an Appointment section.
Explore the steps of Pre-registration Portal to book an appointment.
To verify your email ID or phone number, click here.
For Email verification- Use the OTP received on your email, as provided at the time of UIN creation.
For Phone number verification - Since our mobile services are temporarily unavailable, please use the email services.
To access all the features of Resident portal in MOSIP, click here to login.
For more information, refer to our end user guide.
To get more information about Resident Portal, click here.
You will be able to explore and get a better understanding of Resident Portal configurations, UI, deployment, and OIDC client configuration to mention a few.
By adhering to these instructions, you will acquire the necessary knowledge to effortlessly configure the Resident Portal and proficiently utilize all of its functionalities.
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 about 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!
Android Registration Client (ARC) is a tablet application that serves as portable version of the existing desktop Registration Client. It can be accessed through Android devices and also meets mobility requirements of countries adopting MOSIP Identity.
The primary objective of the tablet version is to facilitate the registration process for residents who are not able to physically visit Registration centers and also serve remote locations where setting up Registration center is not feasible. To address this challenge, the ARC was developed enabling Operators / Supervisors to easily access the remote areas and maximize resident registrations across the country.
This guide serves as a tool to demonstrate the impressive capabilities of MOSIP's system. Additionally, the primary user of this guide will be the Operator / Supervisor trying to register individuals for generating UIN.
Let's embark on this journey together to explore the potential of ARC.
For developers setting up ARC locally, refer Developers Guide.
Reliable and consistent Internet connectivity
Tablets running Android version 10 to 13
Tablets with a minimum of 4 GB RAM
The tablets should be capable of capturing fingerprints, IRIS, and face (photo) biometrics. Additionally, they should also have the ability to scan documents. However, if the tablets do not support these capabilities, MOCK SBI can be used as an alternative.
Note: For Mock MDS, click here to download the Mock MDS in your system folder, which will enable you to simulate biometric capture (without real biometric devices).
The following details are required to access ARC in Collab environment:
UIN or a VID
Machine details
To obtain your UIN credentials for Collab environment follow the below steps:
The provision of a Unique Identification Number (UIN) as a demonstration credential will enable you to have a firsthand experience of the ARC's capabilities and explore its various features.
Please fill the form with correct details and submit the form. Upon receiving the form, we will generate a demo credential for you. We will also register you as an Operator on Keycloak and map your device to the center to which your credential is required to be mapped.
Mentioned below are the steps to download, install, and use ARC.
Step 1: Download and install the APK on Android tablet. Visit Android Registration Client to access ARC in Collab environment.
Step 2: Install ARC and launch it.
Step 3: Login as an Operator with the credentials received and wait for synchronization to complete.
Step 4: Refer to our comprehensive User Guide document to learn how to register and use ARC.
Note: Please be advised that if the Android Registration Client is uninstalled and then re-installed, the aforementioned steps will need to be repeated from the start.
To know more about features of the Android Registration Client, click here.
To learn more about the ARC configurations, click here.
If you require any assistance or encounter any issues during the testing and integration process, kindly reach out to us through the support provided below.
Navigate to Community.
Provide a detailed description about the support you require or provide complete information about the issue you have encountered, including steps to reproduce, error messages, logs and any other required details.
Thank you. Wishing you a pleasant experience!
Welcome to the Pre-registration Client Setup Guide, tailored exclusively for our Collab environment! This guide will equip you to seamlessly access the Pre-registration demo application and effectively demonstrate its capabilities.
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!
Note : For developer's setup of pre-registration locally into your system, refer here.
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 1 - Access the Pre-registration Portal:
Visit the following URL to access the Pre-registration portal in the Collab environment: 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:
To access all the features of the Pre-registration portal and explore the pre-registration process in MOSIP, refer to our end user guide.
Note: Please use 111111 as the OTP, for any OTP-based feature in the Collab environment.
Watch this informative video here for a visual walkthrough of the features.
For more information about Pre-registration, click here.
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.
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. We wish you a pleasant experience!
Welcome to the Inji Credentialing Stack Setup Guide tailored specifically for our Collab Environment!
To fully explore the Inji Credentialing Stack and its features in the Collab environment, we kindly request you to refer provided within the Inji documentation.
This guide is designed to assist you in setting up and configuring all modules of the in our sandbox Collab environment. By following the steps outlined in each guide for different modules of Inji Stack, you will be able to smoothly utilize the individual features and functionalities of each module of Inji Stack. Whether you're a Developer, System Integrator, or an enthusiast eager to dive into the world of digital identity and verifiable credentials, these guides will provide you with the necessary information to get started with Inji Stack in our environment.
To fully explore the and its features in the Collab environment, we kindly request you to refer to the Inji Wallet "" section provided within the Inji documentation.
To fully explore the and its features in the Collab environment, we kindly request you to refer to the Inji Web "" section provided within the Inji documentation.
To fully explore the and its features in the Collab environment, we kindly request you to refer to the Inji Verify "" section provided within the Inji documentation.
Thank you. Wishing you a pleasant experience!
Welcome to the Setup Guide, designed specifically for our ! This guide will assist you in easily accessing the Partner Management Portal and effectively demonstrating its features.
The Partner Management Portal (PMP) 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 Portal Demo Setup, you're close to showcasing the impressive capabilities of MOSIP's Partner Management Portal. Let's get started!
Note: Please fill out the to request a password modification for your account, which was initially configured following your registration on this platform.
Accessing the Partner Management Portal 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 1: Access the Partner Management Portal:
Visit the following URL to access the Partner Management portal in the Collab environment: .
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 .
Step 3: Explore the features on the Partner Management Portal
To access all the features of the Partner Management portal and explore the partner onboarding process in MOSIP, refer to our .
Note: We kindly request you to fill out the attached in order to request a password modification for your account. This is necessary as the current Partner Management Portal (PMP) 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.
By following these instructions, you will be equipped to seamlessly set up the partner management portal, and effectively use all the features, and book an appointment.
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!
Watch this for a visual walkthrough of the features.
Click on , , , and to get in-depth knowledge of PMP.
For more information about Partner Management Portal Developer Setup, click .
Navigate to .