improved

Fabric Release Notes | Version 5.1

Summary: This release introduces the new Async Udyam Registration APIs designed to streamline the digital registration process for MSMEs. The suite comprises six asynchronous APIs covering the entire registration lifecycle from initiating the session to confirming registration and checking the status.

These enhancements provide robust error handling, asynchronous processing for OTP verification and details submission, and a clear status reporting mechanism to ensure seamless integration with downstream systems.

Release Highlights:

  1. Comprehensive Registration Flow:

    • The release includes six APIs covering all stages of the Udyam registration process:
      • Initiate Session API: Generates a URL for users to enter their Aadhaar details.
      • Verify Session API: Processes OTP verification for session validation.
      • Add Details API: Accepts and pushes user-entered details (PAN, addresses, employee counts, etc.) for MSME acknowledgment.
      • Confirm Registration API: Finalizes the registration by confirming the OTP.
      • Resend Final OTP API: Facilitates resending the OTP if the confirmation window is missed.
      • Registration Status API: Provides real-time status updates of the registration session.
  2. Asynchronous API Processing:

    • Designed to operate asynchronously, the APIs return immediate acknowledgment responses while the actual processing occurs in the background. This ensures a responsive user experience and allows for sequential progression through registration stages.
  3. Robust Error Handling and Status Mapping:

    • Each API response adheres to a standardized structure with clear success and error codes. Detailed error messages and HTTP status codes (e.g., 200 for success, 422 for validation errors, and 500 for server errors) help developers quickly diagnose issues.
    • The Registration Status API maps various stages (e.g., SESSION_INITIATED, SESSION_VERIFICATION_OTP_SUCCESSFUL, SESSION_CONFIRMATION_OTP_SUCCESSFUL) to user-friendly messages, guiding the integration flow.
  4. Enhanced Integration Experience:

    • With clearly defined endpoints, headers (client_id and client_secret), and request/response payloads, the new APIs simplify the integration process.
    • The asynchronous nature and status enumeration ensure that downstream systems can poll for updates and take appropriate actions based on the current stage of registration.
  5. Developer-Centric Documentation:

    • Detailed integration documentation is provided, outlining endpoint configurations, sample requests/responses, and the complete error/status mappings.
    • The release notes and documentation serve as a comprehensive guide for developers to implement and test the Udyam Registration flow efficiently.