End User Guide
Beneficiary Role - User Guide
Splash screen
Contains language selection (by default English) and two buttons for Seekers registration and Login
Registration
New users can create an account by clicking the Register button on the splash screen.
Fill out the required details to complete the registration process.
On success: The system displays a username and redirects to the login page.
Login
Use your registered username and password to log in.
Upon successful login, you will be redirected to the Home screen.
The Login screen includes a "Register" button for users who do not have an account. On clicking "Register", the user will be redirected to the Registration page.
Home
If the user is newly registered and logs into the system, they will be prompted with a Terms and Conditions consent dialog containing all the Terms and Conditions along with "Accept" and "Deny" buttons. If the user selects "Deny", they will be logged out of the system. If they select "Accept", their consent will be securely recorded in the system, and they will be redirected to the Home page.
The Home section allows beneficiaries to manage their personal information and required documents for applying for benefits.
How It Works
After login, the user is redirected to the Home screen.
Use the Scan and Upload Documents button to scan documents.
Steps to Complete Your Profile (Blue dot)
Scan and upload Documents
Navigate to the Home section from the bottom navigation menu.
Click Scan & upload Documents to fetch missing documents
On clicking the "Scan & Upload Document" button, the Document Scanner page will open. This page displays a list of all required documents, each with its own "Upload" button.
When the user clicks the "Upload" button for a specific document, a dialog will appear prompting them to scan that particular document.
Within the dialog, there is an option to start a camera scan.
Upon clicking Start camera scan button, the camera will open and allow the user to scan the document.
While the camera is open, there is also an option to stop the camera scan in case the user wants to cancel or pause the scanning process. If the camera scan is stopped, the option to start the camera scan will remain available to resume the scanning when needed.
The scanned VC is verified using the integrated Verification SDK before it is uploaded to ensure authenticity and data integrity.
If the scan is successful, a message will be displayed confirming that the document was imported successfully.
Once a document is uploaded, a "Re-upload" button will be available next to it, allowing the user to scan and upload the document again if needed.
If the scan fails, an appropriate error message will be shown.
Upload Document from wallet
Navigate to the Home section from the bottom navigation menu.
Click on Upload Document from wallet
System validates wallet connectivity and authentication
Application opens embedded iframe with wallet service, User sees their wallet's document selection interface
User browses available documents in their wallet
User selects one or more documents to import
Selected documents are imported in the beneficiary application
The system will automatically update your profile with the details from the uploaded document. On the Home screen, users can view documents marked with a green icon and perform three actions: preview the verified credential (VC), preview the original document image, and delete the document.
Documents marked with a yellow icon indicate missing or incomplete documents.
Documents marked with a green icon indicate that the document is uploaded.
Documents marked with a red icon indicate that the document is expired.
A list of required documents is displayed. Each document item shows:
The document name
The expiry date, if applicable (If the document is expired, the expiry date is highlighted in red to indicate its invalidity)
Each document item includes three actions:
Preview VC
A View Document icon , which opens a preview of the document in JSON format when clicked.
Preview Original Documents used during VC creation
Image Icon, Opens the original Verifiable Credential (VC) image for the document in a viewer.
Delete VC
A Delete icon on the right side of the document.When the Delete icon is clicked, a confirmation dialog appears with a warning message: "Are you sure you want to delete this document?” If the user selects "Okay", the document will be deleted from the profile
Explore Benefits
Benefit listing:
The benefits are displayed under two separate tabs:
My Benefits:
Shows only the benefits the user is eligible for, based on Eligibility SDK integration.
Includes a search bar for quick lookup.
Supports pagination to navigate through long lists.
All Benefits:
Displays all available benefits from the network.Also Includes filters such as gender , Income range and caste and Includes a search bar for quick lookup.Displays all available benefits from the network.
Includes filters: Gender, Income Range, caste
Includes a search bar for quick lookup.
Supports pagination to navigate through long lists.
On clicking "View Detail", the user is navigated to the Benefit Details page of the selected benefit.
View Benefit Details:
Clicking "View Detail" opens the Benefit Detail page.
The Benefit Detail page shows:
Description of the benefit
Benefits to the beneficiary
Eligibility criteria
Required documents which includes Options to preview JSON format and Original document image
A "Proceed to Apply" button
A "Proceed to Apply" button
Apply for Benefits:
When the user clicks "Proceed to Apply" system checks for expired documents
If any required documents are expired, an alert is shown. Example: “Your OTR Certificate and Income Certificate have expired. Please upload valid documents to proceed further.”
The user cannot proceed until valid documents are uploaded.
If all required documents are valid, the system checks eligibility using the Eligibility SDK.
If the user is eligible:Redirect to the pre-filled application form.
If the user is not eligible:Show alert: "You are not eligible for this benefit." Restrict user from submitting application
Steps to Apply
Go to the Explore Benefits section.
Click View Details for the selected benefit.
Click "Proceed to Apply".
User who is not eligible will be restricted from accessing the form
Review the prepopulated form, fill in any missing fields, and submit the application.
After successful submission, you’ll be redirected to My Application.
My Applications
The My Applications section allows beneficiaries to track their application progress and view application history.
Track Application Status: Monitor the progress of your submitted applications.
View Submitted Details: Click on an application to see all the details you provided during submission.
Steps to Track Application Progress
Navigate to My Application from the bottom navigation menu.
Select an application to review.
View its details, including status and submission data.
Profile (Navbar Menu)
The Profile section is accessible from the navbar menu and allows you to view and update your personal information.
Features
View basic details such as Name, Date of Birth, Caste, Income, etc.
A list of documents is displayed:
Documents with a yellow mark indicate missing or incomplete documents.
Use the Import Documents button to fetch documents from your e-wallet.
Imported documents will appear in the list with a green tick once successfully fetched.
Logout
How to Logout
Open the navbar menu.
Click the Logout option to log out of the application.
You will be redirected to the login screen.
Navigation Options
Bottom Navigation Menu:
Home
Explore Benefits
My Application
Navbar Menu:
Profile: View and update personal details.
Logout: Log out of the application.
Troubleshooting
1. Login Issues
Problem: Incorrect Email or Password
Solution:
Verify that your username and password are correct.
Ensure that the Caps Lock key is off.
If you are a new user, click the Register button on the splash screen and complete the registration process.
Problem: Unable to Access the Login Page
Solution:
Check your internet connection.
Ensure the URL is correct.
Clear your browser cache and cookies, then try again.
2. Registration Issues
Problem: Registration Form Validation Errors
Solution:
Ensure all fields are filled out as per the specified format (e.g., first name, last name , phone number ).
Check for any error messages next to the fields and correct them.
Problem: Unable to Complete Registration
Solution:
Verify the network connection and retry.
Check for server errors or maintenance announcements.
3. Home Section Issues
Problem: Documents Not Displayed
Solution:
Refresh the page or restart the application.
Ensure that the backend API for fetching documents is functioning properly.
Problem: The Scan Documents Not Working
Solution:
Verify your internet connection.
Check the browser console (F12 > Console) for any error messages.
Ensure scanner is clear
4. Explore Benefits Issues
Problem: Benefits List Not Displayed
Solution:
Clear the browser cache and refresh the page.
Use the browser network tab (F12 > Network) to verify the API call status.
Ensure the backend API is running and responding correctly.
Problem: Filters Not Working
Solution:
Refresh the page and try applying filters again.
Check if the backend API supports filtering options and if the filter logic is implemented correctly.
Problem: Application Form Fields Are Not Prepopulated
Solution:
Ensure that your profile is fully updated with the necessary details.
Check the backend API for fetching user profile data.
Problem: Unable to Submit Application
Solution:
Verify that all mandatory fields (e.g., Bank Details) are filled.
Check for any validation errors and correct them.
Inspect network activity (F12 > Network) to ensure the form submission API succeeded.
5. My Application Issues
Problem: Application Status Not Updating
Solution:
Clear the browser cache and refresh the page.
Ensure that the backend API for tracking applications is functioning correctly.
Problem: Unable to View Application Details
Solution:
Check for errors in the browser console or network tab.
Verify that the backend API endpoint for fetching application details is accessible.
6. Profile Section Issues
Problem: Profile Data Not Updating
Solution:
Ensure that all required fields are filled before updating.
Refresh the page and retry the update process.
Verify that the backend API for updating the profile is operational.
Problem: Unable to Import Documents
Solution:
Check your internet connection and retry.
Ensure that the e-wallet API is accessible and configured correctly.
7. Logout Issues
Problem: The logout Button Not Working
Solution:
Refresh the page and try again.
Verify that the session or token handling logic is implemented correctly on the backend.
8. General Navigation Issues
Problem: Bottom Navigation Menu Options Not Responding
Solution:
Ensure that your browser or app is up-to-date.
Verify that the routes or navigation logic in the app is correctly implemented.
Problem: Navbar Menu Options Not Accessible
Solution:
Refresh the page or restart the application.
Check for errors in the browser console or app logs.
Admin Panel- User guide
Overview
The Admin Panel provides comprehensive field configuration and document mapping capabilities for a beneficiary app. The system enables Admins to define custom form fields, configure document types, and establish mappings between form fields and document verification credentials (VCs).
Use Cases
1: Manage Form Fields
Actor: Beneficiary Admin Goal: Create, edit, and delete custom form fields for user registration
Preconditions:
Admin has access to admin panel
System is connected to backend API
Main Flow:
Admin navigates to Add Fields page
System displays current list of fields in table format
Admin clicks "Add Field" button System opens field creation modal Field creation modal opened with empty form
Admin fills required field information:
Label (display name)
Name (internal identifier)
Type (text, numeric, date, boolean, dropdown)
Ordering (display sequence)
Required flag
Editable flag
Options (for dropdown type)
Modal with all field information filled out
Admin clicks Add field button
System validates field data
System calls API to persist field
System refreshes field list Updated fields table showing newly added field
System displays success confirmation
Alternative Flows:
AF-001a: Edit existing field
AF-001b: Delete field
Business Rules:
Field names must be unique
Ordering must be numeric and positive
Dropdown fields must have at least one option
Fields in use cannot be deleted
2: Configure Document Types
Actor: Beneficiary Admin Goal: Define document types and their VC field schemas for verification
Preconditions:
Admin has access to admin panel
VC schemas are defined on issuance platform
Main Flow:
Admin navigates to Document Config page
System displays current document configurations Document Configuration page with existing configurations
Admin reviews/adds document configuration:
Document Name (display name)
Document Label (user-friendly label)
Document Type (category)
Document Sub Type (specific identifier)
VC Fields (JSON schema defining available fields)
Document configuration form with all required fields
Admin enters all fields Step 4: VC Fields textarea with JSON schema input
System validates JSON structure Real-time JSON validation
Admin saves all configurations Save All Configurations button highlighted
System persists configurations via API
System displays success confirmation  Step 8:Success toast showing number of configurations saved
Alternative Flows:
AF-002a: Add new document configuration
AF-002b: Remove document configuration
Admin clicks delete icon AF-002b: Delete icon on configuration block
System removes configuration from list
AF-002c: Invalid JSON format
Business Rules:
All document fields are required
VC fields must be valid JSON object
Each field in VC schema must have a "type" property
Document sub types should be unique
3: Map Fields to Documents
Actor: Beneficiary Admin Goal: Create mappings between form fields and document VC fields
Preconditions:
Form fields are configured in system
Documents are configured with VC schemas
Main Flow:
Admin navigates to Field Mapping Config page
System loads available form fields and document types Field Mapping Configuration page with loaded data
Admin creates field mapping:
Admin can add multiple document mappings per field Multiple document mappings for single field
System validates all mappings
Admin saves all mappings Save All Mappings button highlighted
System persists mapping configuration via API Success toast with mapping statistics
Alternative Flows:
Business Rules:
Each field mapping must have at least one document mapping
Document and VC field selections are required
Transformation JSON must be valid format
Form fields can map to multiple documents/field
Data Flow
Field Management Flow
Load: Fetch existing fields from API
Display: Render fields in table format
Interact: User initiates add/edit/delete
Validate: Client-side validation of input
Submit: API call with validated data
Refresh: Update local state and UI
Feedback: Success/error notification
Document Configuration Flow
Initialize: Load existing configurations
Configure: User enters document details
Validate: JSON schema validation for VC fields
Bulk Save: Submit all configurations together
Persist: Backend storage of configurations
Confirm: Success notification
Field Mapping Flow
Prepare: Load fields and documents
Parse: Extract VC fields from document schemas
Map: User creates field-to-document relationships
Transform: Optional JSON transformation rules
Validate: Ensure all required mappings
Save: Persist mapping configuration
Apply: Mappings available for form processing
Last updated
Was this helpful?