Versions Compared

Old Version 3

changes.mady.by.user Aneta Pałczyńska (Deactivated)

Saved on

compared with

New Version 4

changes.mady.by.user Aneta Pałczyńska (Deactivated)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

USE CASE STEP 

USE CASE: Online Construction Permit

STEP: Registration

TYPE: Online registration
https://app.gitbook.com/o/pxmRWOPoaU8fUAbbcrus/s/YLLEfCKTnmzAMDSDzJJH/readme/inf-1-construction-permit

PRECONDITIONS 

(list of conditions that MUST be met in order to be able to successfully execute this process)

  • Data sharing agreement between Registration BB and respective registries where information is queried from has been signed (contract) and respective REST API services in Information Mediator has been opened to Registration BB.

  • Applicant has already been registered in a national identification system (ID BB).

  • Applicant has assigned National Identification Number (ID BB) used in the GovStack system to determine identity

  • Applicant has not yet been registered for OCP program

  • Applicant has the ability to accept payments as specified in the program (for example bank account)

  • Applicant has the ability to accept messages as specified in the program (for example email)

  • Applicant’s National Identification Number can be mapped to payment information coming from payments BB mapping.

  • Ministry's or the municipalities' websites have infrastructure ready for storing and processing data involved in registration process.

  • All necessary building blocks and workflows have been set up.

DATA INPUTS 

Info

Data inputs will/ might be country/ municipality specific and thus here are listed these

Note: Details on Data Inputs will most likely depend on Building Blocks that are not yet available. For now high level inputs are listed.

Citizens

  • First Name

  • Last Name

  • National ID

  • Occupation

  • Contact Information:

    • Email Address

    • Phone Number

Specialists (Architects / Engineers / Supervisors /Town Planners)

  • First Name

  • Last Name

  • National ID

  • Occupation

  • Corporate Name

  • Corporate Unique ID

  • Certificate from Council of Architecture/ Other authorities

  • Educational Qualification

  • Contact Information:

    • Email Address

    • Phone Number

Consent Policy

  • Organization Name

  • Policy Name

  • Url

  • Jurisdiction

  • Industry Sector

  • No of days for data retention

  • Storage policy

  • Geographic Restrictions

Consent Record

  • Individual ID

  • Signature

  • Policy ID

Confirmation Email

  • Sender Name

  • Title

  • Content

  • Confirmation link

Registration Entry

  • Individual ID

  • First Name

  • Last Name

  • National ID

  • Occupation

  • Contact Information:

    • Email Address

    • Phone Number

  • Authorization Token

ACTORS 

Human

  • Leading Organization (Ministry of Urban Development, housing and planning) or Government’s platform

  • Participators group(s) (citizens and professionals seeking the permit approval)

System 

  • Consent BB

  • Registration BB

  • Digital Registries BB

  • Identity BB

  • Information Mediator BB

  • Messaging BB

  • Workflow BB

NORMAL COURSE 

Description

Participator of the program will provide his personal details and submit them manually into the specialized platform for issuing construction permits.

Provided that

The registration form screen provides a list of initial details required to proceed with the registration (eligibility verification, required documents, required fees).

Step 1: Applicant session id is saved for registration process after providing data for successful registration

Description: User’s session id is saved in order to finish the registration process. No data is yet saved at this point in database, just in the session.

Step 1.1: Applicant provides data in registration form

Code Block
Feature: Registration form
Scenerio: Applicant provides data in registration form
  Given Applicant has not yet registered in the platform
    And Applicant's National ID was not used to register
    And the eligibility criteria are listed
    And the platform is connected to Registry BB
  When Applicant fills in data fields correctly
    And their National ID pulls in chosen public data
    And the the data was validated
  Then Applicant is marked as eligible
    And Applicant is shown Consent Agreement

Relevant Digital Registries BB endpoints:

  • /data/{registryname}/{versionnumber}/{uuid}/read-value/{field}.{ext} or /applications/{fileId} (Registration BB)

    • Searches for the possible previous registration for the same National ID

Relevant Registration BB endpoints:

  • /eForms/{eFormId}

    • Fetches the Registration form

Step 1.2: Applicant has to sign the Consent Agreement

Description: The platform fetches the prepared Consent Agreement with data processing details for the Registration process to be successful.

Step 1.2.1: Fetch relevant Consent Agreement for the platform

Code Block
Feature: Get Consent Agreement
Scenario: Registration App retrieves Consent Agreement for Applicant
  Given a Consent Agreement for Applicant registration exists in Consent BB
    And Registration App has Applicant's <ID> and auth token for the registration session
  When Registration App fetches a Consent Agreement for user registration
  Then Registration App gets a valid Draft Consent Agreement associated with Applicant's ID

Relevant Consent BB endpoints:

  • /service/agreement/{agreementId}/

    • Fetch agreement

  • /service/policy/{policyId}/

    • Get related policy 

  • /service/purpose/{purposeId}/

    • Get related purpose 

  • /service/agreement/{agreementId}/agreementdata/

    • Get related agreement data

Step 1.2.2 (optional): Create Applicant in Consent system

Description: Applicant is given a unique ID in the Consent BB

Code Block
Feature: Create Applicant entry in the Consent BB registry  
Scenario: Registration App create Individual in Consent BB on behalf of the Applicant
 Given Applicant is not recorded in Consent BB
 When Consent Agreement is send  
 Then Consent BB creates new Individual entity in Consent system

Relevant Consent BB endpoints: 

  • /service/individual/

    • Register Applicant in Consent system 

Step 1.2.3: Sign consent agreement for the Applicant

Description: When Applicant chooses to accept the Consent Agreement, the Consent Agreement is signed digitally and paired with the Applicant unique ID within Consent BB.

Code Block
Feature: Sign Consent Record Digitally 
Scenario: Applicant signs the Consent Agreement
  Given Applicant has capability to sign Consent Record digitally
    And Individual ID from Consent system is known to the Applicant
    And Applicant has active session id of the registration process
  When Applicant sends the Draft Consent Agreement to Consent BB
  Then Consent BB creates a paired Consent Record and Signature object
    And Consent BB digitally signes Consent Record
    And Consent BB confirms to Registration Application that Consent Record for Applicant has been successfully signed
    And Applicant is asked to confirm the Registration process in the email

Relevant Consent BB endpoints: 

  • /service/individual/record/agreement/{agreementId}/

    • Create new Consent Record in the Consent system 

Image Added

Step 2: Applicant is sent a confirmation email to access the platform

Description:

Code Block
Feature: Confirm registration process in the email 
Scenario: Applicant receives confirmation email
  Given Applicant has Registration session ID
    And Applicant is paired Individual ID from Consent BB
  When Applicant clicks a link to confirm the Registration process
  Then Registration form can be send to the Registration System
    And Registration form can be saved in Registration System
    And Applicant receives information about successful registration on the platform

Relevant Messaging BB endpoints:

  • /send/email/single

    • Send confirmation email to the Applicant

Relevant Digital Registry BB endpoints:

  • /data/{registryname}/{versionnumber}/read

    • Fetch data from Digital Registry

  • /data/{registryname}/{versionnumber}/create

    • Save data in Digital Registry

Image Added

Step 3: Applicant is authorized successfully, received a token and is logged into the app

Code Block
Feature: Get authentication token
Scenario: Applicant use credentials to get token
  Given: Applicant is registered in the platform 
    And Registration App is connected to Registry BB
    And Applicant has signed the Consent Agreement
  When: Applicant enters data required for authentication
    And data is verified successfully
  Then: The Identity BB returns Auth Token
    And Applicant is logged into the redirected to the platform

Relevant Identity BB endpoints:

  • /authorize

    • Used to redirect and authorize applicant

Relevant Digital Registry BB endpoints: 

  • /data/{registryname}/{versionnumber}/exists

    • Can be used just to confirm the identity of the applicant.

  • /data/{registryname}/{versionnumber}/read

    • Can be used if we want to automatically pull all relevant applicant information available in population registry 

Image Added

ALTERNATIVE COURSE 

  1. Participator enters a specialized platform for issuing construction permits and provides her/his national id, which pulls information about the user into construction permit platform automatically.

  2. Participator enters national digital registry system and can proceed with the online construction permit inside it.

DATA OUTPUT 

The successful completion of the registration process will result in validated Participator data stored in digital-registry relevant for USCT decision making, new consent record for USCT enrollment purposes, confirmation and issuance of a program-specific ID that can be used by the Participator future interactions with the program.

POST-CONDITIONS (SUCCESS CRITERIA)

  1. Participator is informed about successful registration process.

  2. Participator can submit and process her/his construction permit via the designated platform.

EXCEPTIONS 

  1. Participator is a foreigner and there is no option to verify or authenticate data/participator in the national registry. 

  2. Participator is from a local community but has not been registered in the Population Registry/national registry. 

  3. Participator has already been registered.

  4. Participator does not accept data processing in Terms and Conditions or Privacy Policy regulations.

RELATED BBs

  • Consent BB

  • Digital Registries BB

  • Registration BB

  • Identity BB

  • Information Mediator BB

  • Messaging BB

  • Workflow BB

SEQUENCE DIAGRAM

Code Block
sequenceDiagram
    participant A as Applicant
    participant B as Digital Registry BB
    participant C as Registration BB
    participant D as Consent BB
    participant E as Messaging BB
    participant F as Identity BB

    Note over A: Step 1: Applicant fills in the form
    A->>C: Fetch the Registration form
    A->>B: Request to check if applicant is not already registered

    Note over A: Step 1.2: Applicant agrees to Consent Policy
    Note over C: Step 1.2.1: Applicant has active session id in Registration BB
    C->>D: Fetch Consent Policy
    Note over D: Consent Agreement Draft is saved

    Note over C: Step 1.2.2: Individual ID is created
    C->>D: Create Individual in Consent BB
    Note over D: Individual is created

    Note over A: Step 1.2.3: Applicant signs Consent Policy
    D->>C: Notifies that the Consent Agreement was successfully signed
    C->>E: Request to send a confirmation email to the Applicant

    E->>A: Confirmation email with a link is send
    Note over A: Step 2: Applicant confirms registration in the email
    A->>B: Registration form is send and saved in Digital Registry BB
    Note over B: Applicant is registered in the system

    Note over A: Step 3: Applicant logs in the system
    A->>B: Applicant provides credentials
    Note over B: Credentials are validated
    B->>F: Fetch authorization token
    Note over F: Applicant receives authorization token
    F->>A: Applicant is logged into the system and redirected to the main page
Image Added