/
Copy of Collab User Guide

This space is created to document Collab user Guide for Android Registration Client.

The Android Registration Client is a tablet application that serves as a portable version of the existing desktop Registration Client. It has been developed to support accessibility on all Android devices. The existence of Android Registration Client came about in order to meet the mobility requirements of countries adopting MOSIP.

The primary objective of the tablet version is to facilitate the registration process for residents, specifically those who are unable to physically visit registration centres and also serve remote locations where setting up Registration centres is not feasible. To address this challenge, the Android Registration Client was created, enabling Operators/ Supervisors to easily reach the remote areas and maximise resident registrations across the country.

This Android Registration Client 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 Android Registration Client.

Please note that for developers setting up Android Registration Client locally, refer to the Developers Guide.

Pre-requisites

  • Reliable and consistent Internet connectivity.

  • Tablets running Android version 10 to 13.

  • Tablets with a minimum of 4 GB RAM.

  • The tablets need to 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.

  • Accessing Android Registration Client in Collab environment requires the following setup

    • You need a UIN or a VID

    • Once you have installed ARC APK from Collab environment, you need to long press on the MOSIP logo to get the machine details.

  • 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 Android Registration Client'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. We will also register you as an Operator on Keycloak and we will map your device to the center to which your credential is mapped.

Step-by-Step Process

Step 1: Download and install the APK on Android tablet.

Visit the following URL to access Android Registration Client in Collab environment: Android Registration Client

Step 2: Once ARC is installed, launch ARC and long press on the logo to copy the machine details.

Step 3: Fill this form and wait for us to reach out to you with your credentials to login as an Operator.

Step 4: Once you receive the Operator credentials (Username and password) from us, launch Android Registration Client, enter your credentials to login and wait for sync to complete.

Step 5: You can refer to our comprehensive User Guide document to know how to register and sail through Android Registration Client.

Additional Resources

To get more information about Android Registration Client, click here.

You will be able to explore and get a better understanding of Android Registration Client configurations, UI, deployment, and setup to mention a few.

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 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!

Operator’s Credential Generation: Collab Environment

Please provide the requested information, to help us initiate the process of generating a demo Unique Identification Number (UIN) and subsequently the Operator’s Credential for you, in our sandbox Collab environment.

You can find details about our sandbox environments here.

Instructions:

  1. Fill out the required fields marked with an asterisk (*).

  2. Provide accurate and up-to-date information to avoid any discrepancies.

  3. For any queries, reach out to us on MOSIP Community

Information required:

  1. Full name*

  2. DOB*

  3. Email Id*

  4. Upload your face photograph, which will be used to generate demo credentials for you, i.e UIN(PNG/JPEG)*

  5. Preferred Username

  6. Preferred Password

  7. Machine details:*

    1. signPublicKey

      1. Sample signPublicKey:

        1MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAydZPy8M-prpqZWhDsT3hbvdBgwdSAGaELPrd0k4QlqlSdR-BHBxdZ4RxABDWY54q-saQQfFZFlxSY7hin7u5PGcbVRzCtAL24YRptIaj-XXm7I_ia_unQHJpLrrmJTj1MzoNTqVGOtiU68fV0VkJGEtvbiUnxvjWIuMJbDT88GN-s0KLm48QPUKKLKC2E-XJKYg5qzYLYwvo_FgccmUmy8NWbo-O7S98iKQXrMuXm58qS7SZsnu_jfSZub0azw84VnhQTKzjYjdJFPupW5UoPBb3QE34opcxmrW2Tlo2cqaMq7UmByk0QcboPj0EvWw-2-FQI0R4fvB3FWF5pBeDhwIDAQAB

    2. name

      1. Sample name:

        169EMbYHObOwI

    3. publicKey

      1. Sample publicKey

        1MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAyZMTh_VYFpVm-D7xCMFa-Jg6o35i-k_soZCqeBSupEi-Dr6IlqNslUhvkGuErH3YXzRA-Cyzoh3NV7TKc6DqHNJvYB4rBf5x7FupnIQrG5fsLT1dY8QtMmTYTx_xPexdwRJz_5AL15Ly6vkdHjX9YttHhLOK0qtYvwXPMsi6rjVi5k0TbiH-odSIked5qW8rU_guHBMjtdH7DCp2TPvLdlDbMO_fG7gL5yjZO7kuwTWuakfurdGMB4_ew64PrBbKdjoaFsB9cy7om9LSZkGZPWVin32w1zKpyP-yAvzZ2rAyaynUdqq8kEKctcCZG0zLx2DeRS2Pu531aTa5D4jqmQIDAQAB

    4. version

      1. Sample version

        1Alpha

  8. Declaration*

THE END

Step-by-Step Process

The Mock MDS tool can be utilized to simulate the functionalities of biometric devices. The Mock MDS application is compliant with CTK standards and can serve as a substitute for Android SBI modules during testing and validation.

  1. Install the Android Registration Client APK from Collab environment.

  2. Long press on the MOSIP logo

  3. Access the Settings menu.

  4. Under Device Configuration, choose Registration from the dropdown menu.

  5. In P12 Configuration:

    • Enter the necessary credentials for the Device Key and upload the Device P12 file.

    • Enter the required credentials for the FTM Key and upload the FTM P12 file.

    • Complete all fields in MOSIP IDA Configuration.

  6. In Modality Configuration, specify the quality score for Face, Finger, and Iris scans(these values can also be adjusted during testing)

  7. Click on the Save button.

  8. Go back to the Home Page and select LOAD AND VALIDATE CERTIFICATES.

A toast message will be displayed indicating the success of the validation process.

Note: To view the released version of the Mock SBI APK, click here.

To download the Mock SBI APK, click on camera-mds.zip.

This user guide is designed to provide assistance to Operators and Supervisors in successfully installing, running, and registering applicants to obtain their Unique Identification Numbers (UIN) on tablet devices.

  1. On the Admin Portal, using admin credentials, login and perform the following to add the device:

    • Go to Resources/Machine and click on Create machine

    • Add a new machine and enter the machine details:

      • Add the specs as Mobile

      • Map it to a Zone and Center

      • Add the Machine spec ID as Mobile

      • Enter Device name

      • Enter Public Key

      • Enter Sign Public Key

    • Create the role Default in KeyCloak with all the other roles.

    • Create the Operator’s user account in KeyCloak and set the password and assign the role as Default, REGISTRATION_OFFICER, Registration Operator, REGISTRATION_SUPERVISOR

    • Login into Admin Portal to perform the following and add the user:

      • After login into Admin Portal, go to User Zone Mapping and add the zone for the user and activate the zone.

      • Go to User Center Mapping and add the center for the user and activate it.

Note: The user should be assigned to the same Zone and Center as the device.

  1. 4.

    The user should relaunch the ARC and log in using their valid credentials. Additionally, the operator has the option to select their preferred display language.

Upon successful login, the user will be directed to the Home page, which includes the following options:

  • New Registration

  • Operations Tasks (Future scope)

  • Dashboard (Future scope)

  • Settings (Future scope)

New Registration

To begin the Registration process, the Operator is required to follow the steps outlined below.

  1. 1.

    Click on New Registration card.

  2. 2.

    Select the language to be used for data entry, which will be used to collect the resident's information. There will be a default language for data entry.

  3. 3.

    Choose the language in which the notification will be sent to the resident. Click Submit to proceed.

  1. 4.

    The operator will be redirected to the Consent page, where the resident must agree to the terms and conditions in order to proceed.

  2. 5.

    After accepting consent, the Operator will need to fill out the demographic data of the resident, including their name, age, date of birth, and address. Once all mandatory fields are completed, the Continue button will be enabled.

  1. 6.

    Upon clicking the Continue button, the Operator will be navigated to the Document upload page where they will need to:

    • Select the type of document (e.g. proof of identity, proof of address) from the drop-down menu.

    • Enter the Reference Number of the document.

  1. 7.

    Upload the document by clicking on the Scan button to open the camera. The Operator can take a picture of the document and then choose from the following actions:

    • Cancel: Clicking on the "Cross" icon will remove the captured image and return the Operator to the previous screen.

    • Crop: The Operator can drag from the four corners of the captured image to crop it as needed.

    • Save: Clicking on the "Save" button will save the captured image and return the Operator to the previous Document Upload page.

    • Retake: Clicking on the "Retake" button will remove the captured image, reopen the camera, and allow the Operator to take a new photo.

  1. 8.

    After ensuring all required information has been accurately entered in the Document Upload screen, the Operator can proceed by clicking on the Continue button to access the Biometric Capture page. Here, the Operator can capture the biometric data of the Resident, including a face photo, fingerprint, and iris scan.

Face photo capture process

  • For capturing the face photo, the Operator should click on the Scan button to activate the camera and take a picture.

  • The image quality will be displayed on the screen and must meet a certain threshold to be considered acceptable.

  • The Operator has three attempts to capture the biometric image.

  • It is important to note that no exceptions can be made for the face photo biometric capture process.

Biometric Data capture process:

  • In order to capture biometric data, the Operator should click on the Scan button.

  • This will allow the Operator to capture the biometric information.

  • Once the data is captured, the image quality will be displayed on the screen and must meet the acceptable threshold limit.

Note: Three attempts are provided to capture the biometric data.

Fingerprint Capture Process:

In the event that a thumb is missing or experiencing difficulties that prevent its fingerprint from being captured, the Operator is authorized to indicate an exception. To mark an exception, the operator must select the affected thumb and specify the type of exception as either Temporary or Permanent. Additionally, the operator may include any relevant additional comments.

Iris Scanning Process:

  • To initiate the Iris scan, the Operator is required to click on the Scan button.

  • This action will allow the Operator to capture the Iris image.

  • Once the Iris has been successfully captured, the quality of the image will be displayed on the screen.

  • It is essential for the quality score to meet the established threshold limit.

  • The Operator has three opportunities to capture the biometric data.

If one or both of the Irises are not detected or encounter issues that prevent successful capture, the Operator has the option to mark an exception. To do so, the Operator must identify the specific Iris that is problematic and indicate the type of exception- either Temporary or Permanent. Additionally, the Operator may provide any relevant comments.

  1. 9.

    After all the biometric data has been properly captured or any exceptions have been noted, the Continue button will be activated. The Operator can then proceed by clicking on the Continue button, which will redirect them to the Preview page. The Preview page will display the following information:

  • Application ID

  • Timestamp of Registration

  • Demographic data collected

  • Documents submitted

  • Biometric data recorded

From the Preview page, the Operator has the ability to navigate back to previous screens in order to make any necessary adjustments to the entered or captured data. Once the Operator has verified the accuracy of the entered data, they can proceed by clicking on the Continue button, which will direct them to the Operator Authentication page.

  1. 10.

    On the Operator Authentication page, operators are required to input their credentials (username and password) that were used during the login process.

Upon successful verification of the credentials, the packet will be uploaded to the server and the operator will be redirected to the Acknowledgment screen. This screen includes the following information:

  • Application ID

  • Timestamp of Registration

  • Demographic data captured

  • Documents uploaded

  • Biometric data captured

  • Print option

  • QR code for the Application ID

  • Option to initiate a new registration process.