Skip to main content

Consumer Activation

1. Introduction

This document provides a detailed, step-by-step guide to the consumer activation process within the Smart360 platform. It covers the entire lifecycle, from the initial application submission to the final activation, including approval and connection stages. This guide is designed to be easily understood by new developers, providing context, technical details, and clear instructions.

2. Detailed Process

2.1. Stage 1: New Consumer Request (Application Submission)

  • Description:
    • This stage involves the consumer submitting a new service request via the "New Connection" form.
    • Data is captured and stored in the database.
  • Technical Details:
    • Endpoint: api/cx/consumer/
    • Data Model: Consumer
    • Status: Request is initially set to "DRAFT STATE".
  • Steps:
    1. Applicant Information:
      • UI: Navigate to Account Services > New Connection.
      • Fields:
        • Primary Consumer: FirstName, LastName, Email, PhoneNumber (+685 format), IDNumber, VIP (Boolean).
        • Secondary Consumer (Optional): Same fields as Primary.
        • Endpoint : cx/consumer/<int:id>/
      • Action: Click "Save & Proceed".
    2. Address Details:
      • UI: Display Service Address Details form.
      • Fields: Unit/HouseNo, AddressLine1 (required), Premise (dropdown), SubArea, Area, Division, Zone, City, State, ZipCode.
      • Endpoint : cx/consumer/<int:id>/
      • Action: Click "Save & Proceed".
    3. KYC Verification:
      • UI: Display KYC Details screen.
      • Action: Click "Add" (Primary/Secondary) to upload documents.
      • Validation: Document format/size validation.
      • Endpoint : cx/consumer/<int:id>/
      • Action: Click "Save & Proceed".
    4. Plan Selection:
      • UI: Display list of Service Plans.
      • Fields: CostStructure, ServiceLevels, TermLength.
      • Endpoint : cx/consumer/<int:id>/
      • Action: Select a plan and click "Save & Proceed".
    5. Offer Details:
      • UI: Display offer details based on the selected plan.
      • Fields: PromotionalDiscounts, SpecialTerms.
      • Endpoint : cx/consumer/<int:id>/
      • Action: Confirm offer and click "Save & Proceed".
    6. Payment Processing:
      • UI: Display payment form.
      • Fields: PaymentMode ,Transaction id,Transaction Date, Amount.
      • Endpoint : cx/consumer/<int:id>/
      • Action: Process payment and click "Save & Proceed".
    • State Transition:
      • If the consumer completes all steps fully, the request's status changes from "DRAFT STATE" to "CREATED STATE".
      • If the consumer does not complete all steps, the request remains in "DRAFT STATE".

2.2. Stage 2: Approval Process

  • Description:
    • An administrator reviews the request ("CREATED STATE" )
    • Checklist items are verified.
    • The request is either approved or rejected/hold/cancelled.
  • Technical Details:
    • Endpoint: cx/consumer/<int:id>/approve/
    • Data Model: Consumer
    • Status: Changes from "CREATED STATE" to "APPROVED" or "REJECTED/HOLD/CANCELLED".
  • Steps:
    1. Access and Review:
      • UI: Navigate to "Approve" tab.
      • Fields: ServiceAvailability, KYCDocument, ApplicantInformation, PaymentDeposits, ServiceOrderDetails (checklist).
      • Action: Upload documents if needed.
    2. Approval/Rejection:
      • Fields: OwnershipType, MethodType, Remarks.
      • Action: Select approval status and click "Approve/Reject/Hold/Cancel".
  • Important: Approval is only allowed for requests in "CREATED STATE." Requests in "DRAFT STATE" cannot be approved.

3. Request States

  • DRAFT STATE:
    • A consumer request is in "DRAFT STATE" when the application process is started but not fully completed.
    • This allows consumers to save their progress and return to complete the application later.
    • Requests in "DRAFT STATE" are visible in the "Approve" tab and can be accessed for review and editing.
  • CREATED STATE:
    • A consumer request transitions to "CREATED STATE" when the consumer has fully completed all required steps of the application process (Applicant Information, Address Details, KYC Verification, Plan Selection, Offer Details, and Payment Processing).
    • Requests in "CREATED STATE" are ready for approval and are visible in the "Approve" tab.