# Collab Guide

The Resident Portal Guide for Collab Environment provides a comprehensive introduction to the services available on Resident Portal, as well as a guide on how to navigate its features.

Resident Portal is a user-friendly web-based platform designed to assist residents in accessing services related to their Unique Identification Number (UIN). This portal allows residents with a UIN to conveniently manage their UIN, protect their identity, track requests, and obtain personalized cards. For a more detailed overview of the features offered, please visit [here](https://docs.mosip.io/1.2.0/modules/resident-services).

This Resident Portal 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 Resident Portal.

Please note that for developers setting up Resident Portal locally, refer to the [Developers Guide](https://docs.mosip.io/1.2.0/modules/resident-services/resident-services-developer-guide).

## Pre-requisites

* Accessing Resident Portal in Collab environment does not require any complex setup.
* All you need is a UIN or a VID and you are good to go!
* 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 Resident Portal's capabilities and explore its various features.
  * Now you can self generate your own UIN Credential using the [Collab environment](https://collab.mosip.net/).
    * Click on the **Get UIN** button located at the top-right corner of the page. This will open the [Self Registration Form](https://self-register.collab.mosip.net/), Alternatively, you can simply click on this [link](https://self-register.collab.mosip.net/) to self register. You need to duly fill the self registration form.
    * On successful registration the UIN is sent to you over the email you used for registration, For more details you follow the [Generating Demo Credentials Guide](https://docs.mosip.io/1.2.0/general/collab-getting-started-guide/generating-demo-credentials).

**Note**: Please use 111111 as the OTP, for any OTP-based feature in the Collab environment.

## Step-by-Step Process

**Step 1: Access Resident Portal**

Visit the following URL to access Resident Portal in Collab environment: [Resident Portal](https://resident.collab.mosip.net/#/dashboard)

**Step 2: Login**

The recommended method for accessing the Resident Portal in the Collab environment is to use a valid UIN (Unique Identification Number), which can be obtained by completing the form provided. This is one of the options available for logging in and accessing UIN-related services on the Resident Portal.

There are multiple methods for logging in to access UIN services on the Resident Portal:

1. **Login with Inji**: To download and use the Inji application, click [here](https://docs.google.com/forms/d/e/1FAIpQLSc2I0CQqlYRIrEmcJ3J3tKlYOVNcYNj88YZe4MMwU2RZTrjOA/viewform).
2. **Login with Biometrics**: To set up a biometrics device on your system, click [here](https://docs.mosip.io/1.2.0/biometrics).
3. **Login with OTP (One-Time Password)**: Enter UIN/VID received from our end and use 111111 as OTP, for login to Resident Portal in Collab environment.

**Step 3: Explore the features of Resident Portal**

* To access registration related information, click [here](/1.2.0/id-lifecycle-management/identity-management/resident-services/test/collab-resident-portal-guide.md).
* Go to `Get Information` section.
  * Click `Registration Centers` to get the list of Registration Centers near you or to look for Registration Centers based on location hierarchy.
  * Click `Supporting Documents` to get the list of documents that Resident Portal supports.
* To download the UIN card or to know the status of your AID, click [here](https://resident.collab.mosip.net/#/getuin).
  * Next, go to `Get My UIN` section.
* To book an appointment for a new enrolment, click [here](https://prereg.collab.mosip.net/pre-registration-ui/#/eng).
  * Go to `Book an Appointment` section.
  * Explore the steps of Pre-registration Portal to book an appointment.
* To verify your email ID or phone number, click [here](https://resident.collab.mosip.net/#/verify).
  * For **Email verification**- Use the OTP received on your email, as provided at the time of UIN creation.
  * For **Phone number verification** - Since our mobile services are temporarily unavailable, please use the email services.
* To access all the features of Resident portal in MOSIP, click [here](https://resident.collab.mosip.net/#/dashboard) to login.
* For more information, refer to our [end user guide](https://docs.mosip.io/1.2.0/modules/resident-services/resident-portal-user-guide).

### Additional Resources

To get more information about Resident Portal, click [here](https://docs.mosip.io/1.2.0/modules/resident-services).

You will be able to explore and get a better understanding of Resident Portal configurations, UI, deployment, and OIDC client configuration to mention a few.

> By adhering to these instructions, you will acquire the necessary knowledge to effortlessly configure the Resident Portal and proficiently utilize all of its functionalities.

### 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](https://community.mosip.io/).
* 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!*


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.mosip.io/1.2.0/id-lifecycle-management/identity-management/resident-services/test/collab-resident-portal-guide.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
