Udyam Fetch HyperStream

The Udyam Fetch Hyperstream takes the minimum possible input from the user, i.e., the phone number to fetch all linked Udyam numbers, PAN numbers, and Udyam details from the MSME framework.

Overview

The Udyam Fetch HyperStream is part of the Udyam Suite of APIs. This API combines all Udyam Retrieval and Validation APIs, such as the Mobile to Udyam API and the Validate Udyam API, into a single optimized workflow.

If you are interested in something more granular, such as just validating a Udyam number or just searching for a Udyam Number via Mobile, please look at our other companion offerings:

Mobile to Udyam API: Part of the Mobile to X Suite of APIs in the Bytes Module, this API helps you fetch all Udyam numbers linked to the mobile number along with the PAN number associated with each Udyam.
Validate Udyam API: Part of the Business Verification Suite of APIs in the KYC & Onboarding Module, this API helps you validate a given Udyam number and download the Udyam certificate for auditing or record-keeping purposes.

Sample Request & Response

{
    "reference_id": "XXXXXXXXXXX",
    "consent": true,
    "consent_purpose": "A Valid Consent purpose",
    "hyperstream": "UDYAM_FETCH",
    "initial_input": {
        "mobile_number": "0123456789"
    }
}

{
    "hyperstream_txn_id": "XXXXXXXXX",
    "status": "SUCCESS",
    "http_status_code": 200,
    "response_key": "success_hyperstream",
    "data": {
        "MOBILE_TO_UDYAM": {
            "results": [
                {
                    "udyamNumber": "UDYAM-KR-03-XXXXXXX",
                    "udyamName": "Fabric",
                    "panLinkedToUdyam": "XXXXXXXXXX"
                }
            ]
        },
        "BULK_UDYAM_VALIDATE": {
            "results": [
                {
                    "udyamNumber": "UDYAM-KR-03-XXXXXX",
                    "enterpriseName": "Fabric",
                    "organisationType": "Proprietary",
                    "majorActivity": "Services",
                    "gender": "Male",
                    "socialCategory": "General",
                    "incorporationDate": "01/09/2024",
                    "commencementDate": "",
                    "dic": "BANGALORE (URBAN)",
                    "msmeDfo": "BANGALORE",
                    "udyamRegistrationDate": "15/09/2024",
                    "enterpriseType": [
                        {
                            "serialNumber": "1",
                            "dataYear": "2022-23",
                            "classificationYear": "2024-25",
                            "enterpriseType": "Micro",
                            "classificationDate": "15/09/2024"
                        }
                    ],
                    "unitLocationDetails": [
                        {
                            "serialNumber": "1",
                            "unitName": "Fabric",
                            "flat": "Bangalore",
                            "building": "Bangalore",
                            "village": "Bangalore",
                            "block": "Bangalore",
                            "road": "Bangalore",
                            "city": "Bangalore",
                            "pin": "560036",
                            "state": "KARNATAKA",
                            "district": "BENGALURU (URBAN)"
                        }
                    ],
                    "enterpriseOfficialAddress": {
                        "flat": "Bangalore",
                        "building": "Bangalore",
                        "village": "Bangalore",
                        "block": "Bangalore",
                        "street": "Bangalore",
                        "city": "Bangalore",
                        "state": "KARNATAKA",
                        "district": "BENGALURU (URBAN)",
                        "mobile": "98*****700",
                        "email": "[email protected]",
                        "pin": "560036"
                    },
                    "nationalIndustryClassificationCode": [
                        {
                            "serialNumber": "1",
                            "nic2Digit": "62 - Computer programming, consultancy and related activities",
                            "nic4Digit": "6201 - Computer programming activities",
                            "nic5Digit": "62011 - Writing , modifying, testing of computer program to meet the needs of a particular client excluding web-page designing",
                            "activity": "Services",
                            "date": "15/09/2024"
                        }
                    ],
                    "pdf": "https://in.staging.decentro.tech/v2/common/download/XXXXXXXX.pdf"
                }
            ]
        }
    },
    "message": "Successfully Completed Hyperstream",
    "reference_id": "76052895-1c95-4b88-97b8-98e33c5ddca3"
}

All Response Keys:

Response Key	Scenario
error_decentro_error	Something wrong happened at Decentro level
error_missing_configuration	Plan not configured for the company
error_empty_module_secret	Empty module secret was passed
error_no_subscription_found	Company not subscribed to this module
error_unauthorized_module	Authentication failed for this module
error_module_access_expired	Module subscription has expired
error_module_credits_exhausted	Module credits exhausted for the company
error_malformed_request	Malformed JSON request was passed
error_duplicate_reference_id	Duplicate reference id was passed in the request
error_ip_not_configured	IP not configured to access API
error_insufficient_account_balance	Insufficient account balance to access API
error_invalid_endpoint	Invalid API endpoint was passed
error_empty_reference_id	Empty reference_id was passed
error_invalid_consent_type	Invalid consent type was passed
error_invalid_purpose	Invalid consent purpose was passed
error_empty_purpose	Empty purpose was passed
error_consent_false	False consent was passed
error_short_purpose_length	Short purpose length was passed
error_long_purpose_length	Long purpose length was passed
error_provider_error	Provider responded with a failure
error_unexpected_response	Unexpected response received from the provider
error_invalid_reference_id	Invalid reference_id was passed

Please Note: The response JSON will ALWAYS have the following shape (the data key will be null in cases of errors):

{
    "hyperstream_txn_id": "XXXXXXXXX",
    "status": "SUCCESS",
    "http_status_code": 200,
    "response_key": "success_hyperstream",
    "data": {
           /* Response Data Here */
    },
    "message": "Successfully Completed Hyperstream",
    "reference_id": "76052895-1c95-4b88-97b8-98e33c5ddca3"
}