Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
This guide provides steps to create a new ODK form for a program.
ODK Central should be deployed and available.
The user should have an Administrator role in ODK Central. See Create User and Assign Role guide.
Login to ODK Central.
Click on the +New button to create a new project
Provide the project name same as the program name for which creating the form.
Once the project is created and listed on the ODK home page, click on the project name.
Click on the +New button on the project overview page to create a new form.
Choose a file which has form values and upload it.
Once the form file is uploaded it will be in draft status. Click on Publish Draft to publish the form.
Once the draft is published it will be listed under the project overview.
The guide here provides steps to create a new program. A program is typically created by a Program Manager who can create and administer programs.
The user must have a Program Manager role. See Create User and Assign Role guide.
Navigate to Programs using the menu bar.
Click on the Create Program to reach the Program creation page. Provide Program name, target type and currency. There are tabs for the configuration of various managers.
Eligibility criteria:
Use+Add filter to set eligibility criteria using Domain Filters. You may set multiple eligibility criteria.
Cycle Manager: Set parameters of disbursement cycles.
Auto-approve Entitlements: To set entitlements via rules, without any manual approvals.
Approver Group: The group name of the user who has permission to approve cycles. See Create User and Assign Role.
Recurrence: The time period for the repetition of a cycle.
Entitlement Manager: Set parameters for entitlements.
Amount Per Cycle: The amount disbursement of a group or individual per cycle.
Amount Per Individual In Group: Amount of disbursement per individual in a group when the program target type is "group".
Maximum number of individuals in a group: Maximum number of individuals who get disbursements per group (optional).
Transfer Fee(%): Fee incurred for disbursement as a percentage of disbursement (optional).
Transfer Fee Amount: Fee incurred for disbursement as an absolute amount (optional).
Entitlement Validation Group: The group name of the user who has permission to approve entitlements. See Create User and Assign Role.
Map Portal form: Map a portal form to this program. Create a portal form before this mapping.
Click the Next button to import the matching registrants to the creating program. In the pop-up window select Yes.
Once the program is created it will be listed under the program list view page.
The guide here provides steps to create a new user and assign a role. This process is typically done by the Administrator.
The user should have an Administrator role.
Navigate to Settings using the menu bar.
Click on Users & Companies and then select Users to reach user's list view page.
Click on the Create button to reach user creation page.
Email: Provide a valid email Id. The invitation email will be sent to this Id.
Select the role for a user from the OpenG2P module access section.
Once the user is saved it will be listed under the user list view page and the invitation mail will be triggered.
This guide provides steps to create a new portal form for a program. This form will show up on the Self-Service Portal when the user selects a program to apply.
The user must have a Program Manager role. See guide.
Navigate to the Website using the menu bar.
Click on Go to Website to navigate to the website home page.
Click on the + New button to create new form.
Click on Page to create a form.
Enter the page title and click on Create button under New Page pop-up window.
Drag and drop the Form in the Dynamic Content from the BLOCKS section.
Edit the form fields from the STYLE section.
Add more form fields using +Field from the STYLE section.
Save the form using the Save button.
The guide provides steps to enable and configure the proxy mean test.
The user must have a Program Manager role.
Navigate to Programs using the menu bar.
Click on the program name for which configuration to be done.
Navigate to the PMT Configuration section on Program detailed view page.
Enable PMT and click on Add a line in the PMT Parameters field.
Select the field and provide its weightage.
The above-mentioned selection fields are computed fields and can be added in the settings.
Click on the Save & New button to select a new field and provide its weightage or Save & Close button which will save the fields and their weightage to that program under configuration.
Click on the Save button.
Enable developer mode.
Settings --> Developer Tools --> 'Activate the developer mode'
Navigate to Settings using the menu bar.
Click on Technical in the setting menu.
Navigate to Models under Database Structure heading.
Search Program Registrant Info model in the search bar.
Click on g2p.program.registrant_info model.
Click on add a line in Fields section.
Add field name, type, label, dependencies field and compute logic.
Click on the Save & New button to select a new computed field or Save & Close button which will save the computed field in the model.
Click on the Save button.
So, these computed fields will display in the selection field of PMT Configuration.
This guide will help to provide the form access to the field agent. which helps the agent to download the program form.
The access provider should have the Administrator role in ODK Central.
Login to ODK central with a user having an Administrator role.
Click on the program name in Projects on which the agent access is to be provided.
Navigate to App Users below the program name.
Click on the +Create App User button to add a field agent to the program.
Provide the name of the field agent on the popup window and click on Create button. Agent name will be listed under the App user list.
Navigate to Form Access and select the forms for which access is to be given. Click on the Save button.
This guide provides the steps to create MTS Connectors.
There are two types of MTS Connectors differentiated based on input types
The user must have a Program Manager role. See Create User and Assign Role guide.
This guide will provide the steps to register beneficiaries through an offline process. offline registration is done by the Field Agent.
The agent should have ODK collect and Smart Scanner Application Installed
Agents should have form access.
Agents should have downloaded the program form on his/her device.
Beneficiaries should have their National ID card with them.
ODK MTS Connector which is mapped to the form should be in Running status.
Open the program form from the ODK Collect application.
Click on Fill Blank Form to fill in all form fields with beneficiary data.
At some point, the form will have the Launch button. Click on the Launch button to scan the QR code on the National ID of the Beneficiary.
Once the scanning is done beneficiary data will be auto-populated as per the form fields configuration.
After filling in all the mandatory fields click on the Save and Submit button.
If the Field Agent is online, the submitted entries will be sent to ODK Central and will be listed under View Sent Form or else they will be saved in the Field Agents device in Send Finalized Form Section.
This guide will help to download the program form on ODK Collect Application running on an Android tablet or phone.
The field agent should have ODK Collect Application installed.
The field agent should have form access.
The Administrator logs into ODK Central and navigates to the App Users under the program name.
Click on See Code to get the Client Configuration QR code.
Open the ODK Collect application in the field agent device.
Click on Add Project to scan the configuration QR code.
After scanning the Client Configuration QR code all the given access program forms will be downloaded to the field agent's device.
This guide helps beneficiaries to self-register through the beneficiary portal.
Beneficiaries should have the MOSIP-issued national ID with them.
Go to the beneficiaries portal login page.
Click on Sign IN with MOSIP to continue with a MOSIP-issued national ID.
Navigate to Login with OTP using LOG IN HERE and provide the VID/UIN.
After clicking Get OTP, OTP will be sent to the registered email and phone number.
Provide the OTP and click on Verify to proceed further.
Provide consent and click on Allow which navigates to the beneficiary portal home page.
Click on View All Programs to check out the available programs to apply for.
Click on Apply to fill in the beneficiary details in the program form.
Once the form fields are filled click on Submit button for application submission.
Once the program form is submitted, the program will be added to the My Programs section with the Submitted status and the beneficiary will be registered to the program. also will be listed in the OpenG2P Registry Individual as well.
This Guide will help to create the OpenG2P registry MTS Connector.
The user must have a Program Manager role.
Navigate to the MTS Connectors using the menu bar.
Navigate to the MTS Connector creation page by clicking the Create button.
Set MTS Input Type as OpenG2P Registry and for other fields configuration please go through Registry MTS Connector.
Click on the Start button under the MTS Connectors list view page to start the created connector.
Click the Save button and the connector will be listed under the MTS Connectors list view page.
This Guide will help to create the ODK MTS Connector.
The user must have a Program Manager role.
ODK form should be available.
Navigate to the MTS Connectors using the menu bar.
Navigate to the MTS Connector creation page by clicking the Create button on the MTS Connector list view page.
Set MTS Input Type as ODK and for other fields configuration please go through ODK MTS Connector Configuration.
Click the Save button and the connector will be listed under the MTS Connectors list view page.
Click on Start in the MTS Collectors list view page to start the created connector.
This guide will provide the steps to create and approve the disbursement cycle under a program.
The user should have a role which is configured in the Approver Group under Configure the Cycle Manager while creating program.
Navigate to Programs using the menu bar.
Click on the program name for which cycle needs to be created.
After Clicking on Create New Cycle, the new cycle will be added in the cycle section with Draft status.
Navigate inside the cycle using the arrow icon button beside the cycle name.
After clicking on Copy Beneficiaries from Program button program beneficiaries will be copied into the cycle.
Click on Prepare Entitlement to create entitlements to beneficiaries as per the Entitlement Manager configuration
Once the entitlement is ready click on Approve button where cycle status will be moved from Draft to To Approve.
Once more click on Approve button to approve the cycle and the cycle status will be moved from To Approve to Approved.
This guide provides the steps to prepare payment after approving the cycle of a program.
The program cycle should be created for a program.
Navigate to the program for which cycle creation and approval are done.
Click on the Prepare Payment button to create a batch for the approved cycle entitlements.
Once the payment batch is created, navigate to Accounting.
Click on Payment Batches to proceed further with payment.
Click on the payment batch to which payment needs to be done.
On the payment batch, detailed view page click on Send Payment button to make the payment.
Check the payment status in the payments section of the payment batches detailed view page.
This guide provides steps to create and configure the payment manager.
The user must have the Program Manager role.
Navigate to Programs using the menu bar.
Click on the program name for which configuration to be done.
Navigate to the Configuration section on Program detailed view page.
Click on Add a line in the Payment Manager section.
Click on the Create button on the Add: Payment Managers pop-up window.
Select the payment manager type.
If a payment manager is already created (Create Payment Manager), search and select the same or else once the name is provided to the program manager, Create and Edit buttons will appear. Click on Create and Edit to create a payment manager.
Provide the details in the payment manager creation manager.
Click on the Save button and then click on the Save & Close button which will save the payment manager to that program under configuration.
This guide provides the steps to create Payment Hub EE Payment Manager.
The user should have a Program Manager role.
Navigate to Programs using the menu bar.
Click on Configuration and then on Payment Hub EE Payment Manager.
Click on Create button which will navigate to the Payment Hub EE Payment Manager creation page.
In the payment manager creation page provide a name for the payment manager, select the program name, select Automatically Create batch if needed, and all the other configurations will auto-populate and can be changed accordingly.
Once the payment manager is saved it will be listed under the payment manager list view page which further can be used under the program configuration for which it was created.
This guide will help enrol registrants into a program, who are registered through offline registration and online self-registration process.
The user must have a Program Manager role. See Create User and Assign Role guide.
There should be registrants with respect to the program
Navigate to Programs using the menu bar.
Click on the program name on which enrolment needs to be done.
After landing on Program detailed view page, check the beneficiaries section for the registrants who are in draft status.
Navigate back to the program list view page and click on Enrol Eligible Registrants to enrol the registrants who are in draft status.
Enrolment of registrants will be based on the Eligibility criteria set as per the program.
The registrants who pass the eligibility criteria will be enrolled on the program with Enrolled status and those who fail the eligibility criteria will be given Not Eligible status.
This guide provides the steps to create a Payment Interoperability Layer Payment Manager.
The user should have a Program Manager role.
Navigate to Programs using the menu bar.
Click on Configuration and then on Payment Interoperability Layer Payment Manager.
Click on Create button which will navigate to the Payment Interoperability Layar Payment Manager creation page.
In the payment manager creation page provide a name for the payment manager, select the program name, select Automatically Create batch if required, provide the Payment End Point URL and Select the Payee DFSP ID Type.
Once the payment manager is saved it will be listed under the payment manager list view page which further can be used under the program configuration for which it is mapped.
This guide provides steps to create and configure the eligibility manager inside the program.
The user must have the Program Manager role.
Navigate to Programs using the menu bar.
Click on the program name for which configuration to be done.
Navigate to the Configuration section on Program detailed view page.
Click on Add a line in the Eligibility Manager section.
Click on the Create button on the Add: Eligibility Managers pop-up window.
Select the eligibility manager type.
Once the name is provided to the eligibility manager, Create and Edit buttons will appear. Click on Create and Edit button to create an eligibility manager.
Set the eligibility criteria's using Add Filter button on the creation page.
Click on the Save button and then click on the Save & Close button which will save the eligibility manager to that program under configuration.
This guide provides the steps to create a Default Payment Manager.
The user should have a Program Manager role.
Navigate to Programs using the menu bar.
Click on Configuration and then on Payment Interoperability Layer Payment Manager.
Click on Create button which will navigate to the Default Payment Manager creation page.
In the payment manager creation page provide a name for the payment manager, select the program name, select Automatically Create batch if required and select the Currency.
Once the payment manager is saved it will be listed under the payment manager list view page which further can be used under the program configuration for which it was created.
This guide provides the steps to create a default eligibility manager
user should have a Program Manager role.
Navigate to Programs using the menu bar.
Click on Configuration and then on Default Eligibility Manager.
Click Create a button on the default eligibility manager list view page.
Provide the name for the eligibility manager and select the program name from the drop-down for which the eligibility manager is created.
Use +Add filter to set eligibility criteria using Domain Filters. You may specify multiple eligibility criteria.
Click the Save button to save the eligibility manager and it will be listed under the eligibility manager list view page.
This guide provides the steps to create an ID document eligibility manager
user should have a Program Manager role.
Navigate to Programs using the menu bar.
Click on Configuration and then on ID document Eligibility Manager.
Click Create a button on the ID document eligibility manager list view page.
Provide the name for the eligibility manager and select the program name from the drop-down for which the eligibility manager is created.
Click the Save button to save the eligibility manager and it will be listed under the eligibility manager list view page.
This guide provides the steps to create an phone number eligibility manager
user should have a Program Manager role.
Navigate to Programs using the menu bar.
Click on Configuration and then on ID document Eligibility Manager.
Click Create a button on the phone number eligibility manager list view page.
Provide the name for the eligibility manager and select the program name from the drop-down for which the eligibility manager is created.
Click the Save button to save the eligibility manager and it will be listed under the eligibility manager list view page.
This guide provides steps to create and configure the deduplication manager inside the program.
The user must have the Program Manager role.
Navigate to Programs using the menu bar.
Click on the program name for which configuration to be done.
Navigate to the Configuration section on Program detailed view page.
Click on Add a line in the Deduplication Manager section.
Click on the Create button on the Add: Deduplication Managers pop-up window.
Select the deduplication manager type.
Once the name is provided to the deduplication manager, Create and Edit buttons will appear to click on Create and Edit button to create a deduplication manager.
Select the ID type from the Supported ID Document Types drop-down.
Click on the Save button and then click on the Save & Close button which will save the deduplication manager to that program under configuration.
There are 2 types of deduplication managers available that can be created and then can be configured to the program accordingly.
This guide provides steps to create an ID Deduplication manager.
The user should be assigned to the Program Manager role.
Navigate to Programs using the menu bar.
Click on Configuration and then on ID Deduplication Manager.
Click the Create button to navigate to the ID deduplication manager creation page.
In the ID deduplication manager creation page provide a name for the ID deduplication manager, and select the program name and the ID type from the Supported ID Document Types drop-down.
Once the ID deduplication manager is saved it will be listed under the ID deduplication manager list view page which can further be used under the program configuration for which it is mapped.
This guide provides steps to create and configure the notification manager.
The user must have the Program Manager role.
Navigate to Programs using the menu bar.
Click on the program name for which configuration to be done.
Navigate to the Configuration section on Program detailed view page.
Click on Add a line in the Notification Manager section.
Click on the Create button on the Add: Notification Managers pop-up window.
Select the notification manager type.
Once the name is provided to the deduplication manager, Create and Edit buttons will appear. Click on Create and Edit to create a deduplication manager.
Click on the Save & Close button which will save the notification manager to that program under configuration.
There are 3 types of eligibility managers available that can be created and then can be configured to the program accordingly.
This guide will provide the steps to create an Email notification manager.
The user should have a Program Manager role assigned.
Navigate to Programs using the menu bar.
Click on Configuration and then on Email Notification Manager.
Click the Create button to navigate to the email notification manager creation page.
Email notification manager creation page
Name: Provide a name for the manager
Program: Select the program from the drop-down for which the manager is created
On Enrolled In Program Template: Select the template from the drop-down for program enrolment notification.
On Cycle Started Template: Select the template from the drop-down for the program cycle started notification.
On Cycle Ended Template: Select the template from the drop-down for the program cycle-ended notification.
Select Send Immediately to send the email notification to beneficiaries after the program enrollment, at the start of the cycle and at the end of a cycle.
After clicking on the Save button notification will be saved under the email notification manager list view page.
This guide will provide the steps to create an SMS notification manager.
The user should have a Program Manager role assigned.
Navigate to Programs using the menu bar
Click on Configuration and then on SMS Notification Manager.
Click the Create button to navigate to the SMS notification manager creation page.
This guide will provide the steps to create a Fast2SMS notification manager.
Navigate to Programs using the menu bar.
Click on Configuration and then on Fast2SMS Notification Manager.
Click the Create button to navigate to the Fast2SMS notification manager creation page.
Fast2SMS notification manager creation page
Name: Provide a name for the manager
Program: Select the program from the drop-down for which the manager is created
On Enrolled In Program Template: Select the template from the drop-down for program enrolment notification.
On Cycle Started Template: Select the template from the drop-down for the program cycle started notification.
On Cycle Ended Template: Select the template from the drop-down for the program cycle-ended notification.
Send API Endpoint: Provide the service provider API endpoint.
Access Token: Provide the access token of the service provider.
After clicking on the Save button notification will be saved under the Fast2SMS notification manager list view page.
TBD
TBD
This guide provides steps to integrate OpenG2P with e-Signet with MOSIP as the authentication provider.
MOSIP IDA is installed
The e-Signet server is installed and configured to connect to MOSIP IDA
MOSIP IDA APIs are accessible from the machine running the e-Signet server
Both Yes/No and KYC APIs are enabled on MOSIP IDA
e-Signet APIs are accessible from machines running OpenG2P
Biometric auth devices (already onboarded on MOSIP) are available for authentication
Email and SMS are enabled on MOSIP IDA for OTP authentication
MOSIP Partner Management Services (PMS) Portal or APIs must be accessible to both MOSIP Partner Admin and OpenG2P Admin
MOSIP Partner Specific User Token (PSUT) ID type is configured. See Configure ID Types.
Create an Auth Partner for OpenG2P on MOSIP.
Guide for MOSIP 1.2.0
Guide for MOSIP 1.1.5 (TBD)
Create a MISP Partner for OpenG2P on MOSIP.
Note down the following from the above steps:
Auth Partner ID
Auth Policy ID
Auth API Key
MISP License Key
Auth partner signed certificate
IDA Partner certificate (App id: IDA, Ref Id: PARTNER)
This method is applicable if MOSIP Partner Management APIs are available. These steps are executed by MOSIP Partner Admin
Create an e-Signet OIDC client using PMS OIDC API:
authParnterId: Partner ID in this step.
policyId : Policy ID in this step.
publicKey: Generate JWK.
logoUri: URL of your logo accessible publicly.
grantTypes = ["authorization_code"]
clientAuthMethods= ["private_key_jwt"]
redirectUris: URLs of the form https://<your web portal>/auth_oauth/signin
Note down the Client ID as an output of the above step.
This method is applicable if MOSIP Partner Management APIs are not available.
Create an e-Signet OIDC client using the following API:
clientId: Arbitrary string.
clientName: Arbitrary string.
relyingParnterId: Partner ID in this step.
publicKey: Generated JWK.
authContextRefs:
userClaims:
logoUri: URL of your logo accessible publicly.
grantTypes = ["authorization_code"]
clientAuthMethods= ["private_key_jwt"]
redirectUris: URLs of the form https://<your web portal>/auth_oauth/signin
These steps are executed by OpenG2P Admin on the OpenG2P Admin interface.
Go to Settings -> General Settings (Menu) -> General Settings (Panel) -> Integrations (Section) -> Oauth Providers
Create a new OIDC Provider with the following details:
| Parameter | Value | |
|---|---|---|
Client ID
The output of the previous section.
Auth Flow
OpenID Connect (authorization code flow)
Token map
sub:user_id
Client Authentication Method
Private Key JWT
Private Key Method
Private key used for JWK creation in the previous section.
Assertion Type
JWT Bearer
Authorization URL
e-Signet's authorize endpoint.
Userinfo URL
e-Signet's userinfo API
Token URL
e-Signet's token API
JWKS URL
e-Signet's JWKS API
Use G2P Reg ID
True
G2P Registrant ID Type
MOSIP PSUT ID Type
As configured in step 9 of Prerequisites.
Partner Creation Call Validate URL
True
Specifies whether to call the MOSIP e-KYC API to fetch data into OpenG2P
Partner Creation Validate Response
name:name email:email phone:phone_number birthdate:birthdate gender:gender address:address
Default Group User Creation
User types / Portal
Specifies all users signing up through this OIDC Provider (e-Signet) are only going to be portal users
Login Attribute Mapping On User Creation
email
To allow users to sign in with their email and password after initial signup with e-Signet.
The guide here provides steps to install WireGuard App and activate the tunnel. This app allows users to create an encrypted VPN for secure communication.
The user must possess an Android Phone. The user should reach out to the system administrator to generate the Wireguard conf file before proceeding with the installation.
Search for "wireguard" in the Android Play Store.
Install the WireGuard app, open it, and click on the + icon to add the tunnel.
A list of options will appear from the bottom of the app. Click the Import from file or archive option.
Select the WireGuard conf file provided by the system administrator. On successful tunnel creation, the tunnel name will appear at the top of the app.
Activate the tunnel in WireGuard.
The guide here provides steps to install the SmartScanner app. This app allows users to scan the QR code in the entitlement voucher.
The user must possess an Android Phone with WireGuard tunnel activated.
Download the SmartScanner APK file named idpass-smart-scanner-untagged-<version>.apk on your Android mobile from here.
Go to the Downloads folder in Android Mobile and click on the .apk file that you downloaded in the first step. A user prompt will appear with the options CANCEL and INSTALL. Click on INSTALL.
For first-time installation, a user prompt may appear to allow unknown apps. Click on Settings. If no prompt appears and the application installs, then go to step#5.
Enable the option Allow apps from this source, click on the downloaded file, and install the application as described in step#2.
If the SmartScanner app is successfully installed, then this icon will appear on the mobile screen.
Open the SmartScanner app. It should show the option Voucher Code.
Click on the Voucher Code and scan the QR code shown here.
If the SmartScanner app is successfully installed, then the scan will show these details.
This guide provides steps to create a Phone Number Deduplication manager.
The user should be assigned to the Program Manager role.
Navigate to Programs using the menu bar.
Click on Configuration and then on ID Deduplication Manager.
Click the Create button to navigate to the Phone Number Deduplication manager creation page.
In the Phone Number Deduplication manager creation page provide a name for the Phone Number Deduplication manager, and select the program name.
Once the Phone Number Deduplication manager is saved it will be listed under the Phone Number Deduplication manager list view page which can further be used under the program configuration for which it is mapped.
The guide here provides steps to submit reimbursement using Service Provider Portal.
The Service Provider Portal user has login access to the portal using MOSIP ID/National ID. The user should be able to scan the QR code from the entitlement voucher using .
Login into the Service Provider Portal using MOSIP ID/National ID. In the example below, the National ID of the Philippines (PhilSys ID) is shown.
Upon successful login, you will see the Reimbursements dashboard.
Select the desired beneficiary and click on Apply. Applying for the reimbursement takes you to the Submission Form page.
Enter the details from the scan into the Submission Form and click Submit. This will show a user prompt to confirm the details. Click Submit.
Successful submission will show a confirmation page with details such as the application Id and submission date.
You can optionally click Go to Home to view the submitted reimbursements. You should see that the status of reimbursement has changed to Applied.
The beneficiary details are available by scanning the QR code on the entitlement voucher (also called Guarantee Letter) using the . The scan should show details similar to the format in the image below.
OK
OK