Real-time Events — About

Reference docs

• Concept Note
• PRD
• Tech PRD
• Tech Spec

SDK support matrix

SDK	SDK Version	WebCore Version
Web HyperKYC	9.7.0	NA
Android HyperKYC	0.46.0	9.7.0
iOS HyperKYC	0.46.0	9.7.0
Flutter HyperKYC	0.46.0	9.7.0
React Native HyperKYC	0.46.1	9.7.0
Link KYC	Not supported (no established requirement)	NA

The HyperVerge SDK drives users through a multi-step onboarding process, ultimately returning a result to the parent app. Since this journey is fully managed inside the SDK, client apps previously had no visibility into the real-time progress of the user.

To enable clients to track user progress and integrate with their internal systems (CRM, analytics), the SDK now emits real-time milestone events.

These events allow:

• Capturing stage completions (e.g., digilocker done, e-sign completed).
• Logging user progression into CRMs.
• And more.

Phase 1 scope

While the overall PRD defines a broader roadmap, Phase 1 is focused on meeting a targeted ask from wealth-tech clients with end-to-end (E2E) integrations.

Phase 1 delivers:

• Real-time stage completion events.
• Event propagation to registered listeners in the client app.

Developer integration

• Clients can register a listener using the SDK-provided API.
• The SDK triggers these listeners on relevant milestones.
• A cleanup method is provided and should be called post-journey to avoid memory leaks or dangling references.
• See Real-time Events — Integration for SDK-specific snippets.

Flow diagram

sequenceDiagram
    participant Client
    participant SDK
    participant Apollo as Apollo (Analytics)

    Client->>Client: Add event listeners [via addEventListener()]
    Client->>SDK: launch()
    activate SDK
    loop Workflow Execution
        SDK->>SDK: Module completed
        SDK-->>Apollo: Send analytics event ("Module Ended")
        SDK->>SDK: [NEW] Step completed
        SDK-->>Client: [NEW] Trigger "step-ended" event to all attached event listeners
        SDK-->>Apollo: [NEW] Send analytics event ("Step Ended Event Triggered")
        SDK->>SDK: Evaluate next modules
    end
    SDK->>SDK: Workflow ends
    SDK->>Client: Send SDK response
    deactivate SDK
    Client->>Client: Remove event listeners [via removeAllEventListeners()]

Analytics

The HyperKYC SDKs emit a Step Ended event, named Step Ended Event Triggered, that is recorded in both the Mobile SDK Analytics and Web SDK Analytics tables.

These analytics events serve two key purposes:

1. Monitoring & Dashboards: You can use these events to build dashboards that track the success rate of real-time milestone notifications (e.g., step completions), which depend on the workflow configuration.
2. Debugging & Issue Resolution: These logs provide visibility into whether the SDK triggered event listeners correctly at expected milestones. If clients report missing events or inconsistencies, these records become a valuable debugging aid.

Sample records

Below are examples of how these events are logged in the analytics tables: