Registration client setup for partners - Synergy

Owned by suraj s
Last updated: Dec 20, 2023 by Rakshith B
8 min read

General Pre-requisites

Hardware

  1. Workstation:

    1. Windows 10/11 laptop or desktop

    2. Minimum 16 GB RAM

    3. 50 GB of free space on the hard disk

  2. The workstation should be TPM 2.0 enabled. This URL (click here) will guide you with the sequence of steps to check if your workstation is TPM enabled.

It is important that your workstation is TPM 2.0 enabled and not with any older version of TPM. If your workstation has an older version of TPM, like TPM 1.2, then you may have to upgrade your BIOS firmware to upgrade to TPM 2.0. You should contact your vendor in this respect if you are not aware on how to do this.

Software

 

 

  • JAVA - JAVA 11 is installed and JAVA_HOME is in the PATH

Provide the workstation details.

  1. Download and extract the TPM utility as explained in README.txt from the command prompt

  2. Run the following command from the folder where the tpm jar is located

    java -jar tpmutility-0.0.2.jar  > tpmdetails.txt

  3. Email “tpmdetails.txt” to your MOSIP contact.

  4. Your MOSIP contact will register your workstation on the designated MOSIP server and communicate the credentials for logging into the registration client back to you.

WireGuard Configuration

Note :  The WireGuard configuration is unique to a machine.  After installing WireGuard, get your unique WireGuard configuration for the machine(s) from your MOSIP Contact.

  1. Download and install WireGuard client from https://www.WireGuard.com/install/

  2. From the WireGuard UI, press ctrl-N which will display a window to create a new tunnel.

  3. Provide the name and public key that has been shared with you by your MOSIP contact.

  4. Activate WireGuard, which should give you the following screen.

Running Mock MDS

  1. Download and extract the Mock MDS zip provided

  2. Certificates need to be placed in
    Biometric Devices > Face > keys
    Biometric Devices > Finger > keys
    Biometric Devices > Iris > keys
    The certificates need to be placed in the certificate paths as highlighted in the mock MDS

  3. Update the application.property file as below after placing the certificates Need to change your details in the highlighted part

  4. Build the Mock MDS in the command prompt in the same directory where the pom file exists
    (run mvn clean install )

  5. After building Mock Mds Target Folder will be created in the same directory

  6. Open the target folder and execute run.bat (double click)

  7. By default, the Purpose will be set for Registration and the Biometric Type will be set to Biometric Device also the device discovery port by default will be 4501. To change the Purpose or Biometric Type edit the run.bat file in a notepad.

    You can set the Purpose as “Registration” or “Auth” (For reg-client purpose will be Registration)

    If you set Biometric Type to Biometric Device, All the devices will be displayed during device discovery if you want to set it to a specific device type you can set it from the following options.

    1. Biometric Device

    2. Finger

    3. Face

    4. Iris

  8. Mock MDS will start running and start listening on a port between 4501 and 4600.

  9. If run successfully, you would see the following output

Ensure that Mock MDS is always running whenever you are running the registration client

Adding Your Own Biometrics

  1. If need to add your own biometrics,
    open the profile folder > add a new folder with your own biometrics

  2. While running mock MDS use API to change the biometrics folder Post method URI: http://127.0.0.1:4501/admin/profile Request:

    { "type": "Biometric Device", //Possible Values: Biometric device, Face, Iris or Finger "profileId": "Name" //Name given to Biometric folder }

Setting up the Registration Client  

  1. Download the registration client from  https://regclient.synergy.mosip.net/registration-client/1.2.0.1-B1/reg-client.zip

  2. Extract the registration client zip file and click on run.bat. Make sure that you have JAVA in your path.

  3. Login with the credentials provided to you

Registration Client: Registration Process

After your registration client is completely set up, please follow the below steps:

  1. Login using your user credentials

  2. Click on “Synchronize Data”

  3. Click on “New Registration”

  4. Choose the preferred language and proceed entering the Demographics details

  5. Click on “Continue”

  6. Upload documents - Address Proof and Identify Proof mandatory then scan, capture and save

  7. Click on “Continue”

  8. Add Biometric details by scanning

  9. Click on “Continue”

  10. Click on “Agree” and “Continue”

  11. Provide the password and “Continue”

  12. Navigate to Home

  13. Click on “Pending Packet Approval” > “Approve” and then > “Authenticate” by providing the correct credentials

  14. In home screen - click on “Registration Data Upload”

  15. Select packet and Click Upload

  16. After upload check for the RID in the drives where the registration client is installed . The packet folder will be created and inside the folder packet will be there with a Name same as RID.

     

    To get UIN follow step 17 and 18

17 .Authenticate POST https://api-internal.synergy.mosip.net/v1/authmanager/authenticate/clientidsecretkey

//Request Body { "id": "string", "metadata": {}, "request": { "appId": "regproc", "clientId": "mosip-regproc-client", "secretKey": "IwKVNHehKvzjhxHB" }, "requesttime": "2018-12-10T06:12:52.994Z", "version": "string" }

18

  1. Add RID in URI
    GET https://api-internal.synergy.mosip.net/idrepository/v1/identity/idvid/{{RID}}
    You can find the UIN in response