Resident Services
Overview
Resident services are the self-services which are used by the residents themselves via a portal. Resident Portal is a web-based UI application that provides residents of a country the services related to their Unique Identification Number (UIN). The residents can perform various operations related to their UIN/ VID and can also raise concerns if any through the portal.
The key features provided on Resident portal are:
Get information
About Registration Centers
List of supporting documents
Get My UIN using UIN/ VID/ AID
Verify email ID and/ or phone number
Avail UIN services using UIN/ AID/ VID and OTP/ biometrics/ QR code to:
View My History
Manage My VID
Secure My ID
Track My Requests
Get Personalised Card
Share My Data
Update My Data
Get Notifications (email and bell notifications)
View profile details of the logged in user (name, photo, and last login details)
Logout
Responsive UI support
Book an appointment for new enrolment (via the pre-registration portal)
Below is an image summarizing the features provided in Resident portal.
The relationship of Resident services with other services is listed below.
Note: The numbers do not signify sequence of operations or the control flow.
Audit Manager: Resident services sends all the audit logs to the Audit Manager.
Digital card service: Resident services uses this service to download the PDF of the UIN card or VID card.
Credential Request Generator Service: This service is used to share the credential with various partners like print partners, authentication partners, and digital card partners.
ID Repository Identity Service: Resident services uses this service to retrieve the identity information of a credential and to lock/unlock authentication types.
ID Repository VID service: This service is used to generate/revoke various types of VIDs.
ID Authentication: This service is used by Resident services to authenticate users.
MOSIP e-Signet: This is used to authenticate and authorize the users in an event of logging in using UIN/ VID.
Resident UI: This is the interface through which users can interact with the Resident services.
WebSub: This is used to get asynchronous notification from IDA for acknowledgment purposes.
Registration Processor: This is used to sync and upload packets for features pertaining to changes in identity data.
Packet Manager: Resident services uses this service to create packets.
Partner Management Service: Resident services uses this service to get information about various partners and policies.
Keycloak: Resident services uses this to authenticate in order to access the MOSIP internal APIs.
Master data service: Resident services invokes the Master Data services to get various templates and machine details.
Notification service: Resident services uses this service to send various notifications through email or SMS.
Key Manager: Resident services uses this manager to encrypt or decrypt the data used across features.
Design principles
The design of the Resident portal embodies the following principles:
One-stop solution: The Resident portal is designed to have components that aims to solve all the queries, issues, or discrepancies of the residents and acts as a one-stop solution for all the requirements.
Self-Sovereign: Once the ID is issued by an authority the user/resident/citizen chooses to control this in their choice of devices with no central authority.
Inclusive: The Resident portal aims to be available in all browsers while also catering to the needs of visually impaired, dyslexic and colour-blind folks.
Presence assurance: The Resident portal would put in all its efforts to assure presence.
Works Remote: The Resident portal should be able to share credentials when data needs to be shared through remote mode.
Trusted: The identity verification process on the device should be trusted so that it can be used in service delivery without any concerns.
Grievance redressal: The Resident portal ensures that in case of any concerns or grievance, the issue is raised and resolved through the portal itself.
Services
For detailed description of Resident services, the code and design, refer to resident services repo.
Resident portal
MOSIP provides a reference implementation of the Resident portal that can be customized as per the country’s needs. The sample implementation is available at insert reference implementation repository link.
For getting started with the resident portal, refer to the Resident services user guide link
Build and deploy
To access the build and read through the deployment instructions, refer to insert resident services repo link
Configurations
For details related to resident portal configurations, refer to insert Resident services configuration link
Developers Guide
For a detailed description of Resident Services, code, and design, refer to insert resident services developer’s guide link
API
Refer API Documentation.
Source code
Last updated
