Skip to content

FRS ID Repository

Rahuul Chettri edited this page Jul 25, 2019 · 54 revisions

Table Of Contents

1. ID Repository Overview [↑]

ID Repository contains the record of identity for an individual, and provides API based mechanism to store, retrieve and update identity details by other MOSIP modules.

2. ID Services Which Access the Repository [↑]

2.1 Target Users [↑]

  • Registration Processor can use Identity Repository services to create and update identity information associated with a UIN
  • ID Authentication can use Identity Repository services to validate an input UIN and read identity details associated with a UIN
  • Resident Services can use Update ID API when an individual requests for updating ID details like address

2.2 Key Features [↑]

  • Store identity information for a given UIN
  • Update identity information partially or status of UIN
  • Read identity Information associated with a valid UIN
  • Read identity Information for a given RID
  • Check status of UIN for validating a UIN

Please refer to section related to ID Repository services.

The identity data stored inside the ID repository is encrypted. The Identity Repository is the most critical storage repository and is configured keeping the following non-functional aspects in mind:

  • Scalability
  • Performance
  • High Availability

Please refer wiki for more details on the key non-Functional requirements of ID Repository.

3. ID Repository services [↑]

3.1 Store Identity Data and Documents in Repository [↑]

Upon receiving the request to store identity details of individual in ID Repository, the system validates input ID attributes in the request against MOSIP ID defined for the country

  1. Stores ID JSON of an individual generated during registration
  2. Receives and stores individual biometric documents generated during registration
  3. Receives and stores documents of proofs provided by individual at the time of registration
  4. On successful storage of identity for an individual, status of UIN of the individual is marked as 'ACTIVATED'
  5. Please refer Git for more details on the type of error messages.

3.2 Retrieve the Stored Identity Details by UIN [↑]

Upon receiving a request to retrieve identity details of an individual based on input UIN and type as an optional parameter, the system performs the following steps to retrieve the stored identity details and related documents:

  1. Validates if input UIN is 'ACTIVATED'
  2. Retrieves latest ID of individual
  3. The system retrieves and sends a response based on the type of request as follows:
    • If demographic details are requested, system retrieves demographic documents in the response
    • If biometric details are requested, system retrieves biometric documents in the response
    • If both biometric and demographic details are requested, system retrieves both biometric and demographic documents in the response
  4. Please refer Git for more details on the type of error messages.

3.3 Retrieve the Stored Identity Details by RID [↑]

Upon receiving a request to retrieve identity details of an individual based on input RID and type as an optional parameter, the system performs the following steps to retrieve the stored identity details and related documents:

  1. Retrieves UIN mapped to input RID
  2. Validates if mapped UIN is 'ACTIVATED'
  3. Retrieves latest ID of individual
  4. The system retrieves and sends a response based on the type of request as follows:
    • If demographic details are requested, system retrieves demographic documents in the response
    • If biometric details are requested, system retrieves biometric documents in the response
    • If both biometric and demographic details are requested, system retrieves both biometric and demographic documents in the response
  5. Please refer Git for more details on the type of error messages.

3.4 Update Identity Data and Documents in Repository [↑]

Upon receiving a request to update identity details of an individual, the system performs the following steps:

  1. Validate if input UIN is 'ACTIVATED'
  2. Updates input ID attributes of individual
  3. If request contains demographic documents, the system updates with the latest documents received
  4. If request contains biometric document of individual, the system updates with the latest documents received
  5. If request updates status of UIN as 'DEACTIVATED' or 'BLOCKED', the system updates the same
  6. Sends the response with updated ID details of individual
  7. Please refer Git for more details on the type of error messages.

Link to design

3.4.1 De-activate UIN and its Associated VIDs [↑]

This feature is used to de-activate UIN and its associated VIDs. When an individual’s UIN and its associated VIDs is deactivated, then he/she will not be able to authenticate himself/herself by using UIN or VID.

If an individual wants to deactivate his/her UIN and its associated VIDs due to any specific reason, the system deactivates the UIN and its associated VIDs after certain validations are performed in ID Authentication.

3.4.2 Re-activate UIN and its Associated VIDs [↑]

This feature is used to re-activate UIN and its associated VIDs. When an individual’s UIN and its associated VIDs is reactivated, then he/she will be able to authenticate himself/herself by using UIN or VID.

If an individual wants to reactivate his/her UIN and its associated VIDs due to any specific reason, the system reactivates the UIN and its associated VIDs after certain validations are performed in ID Authentication.

List of Configurable Parameters and Processes [↑]

  1. Configurable Parameters

    Link to Configurable Parameters of ID Repository

  2. Configurable Processes

  • (Work in Progress)

ID Repository API [↑]

Refer to Wiki for more details on ID Repository API.

Process View [↑]

Link to Process View of ID Repository

Clone this wiki locally
You can’t perform that action at this time.