Submit OTP for Udyam Verification

Endpoint Overview

POST /api/v1/udyam-otp/submit-otp

Description

This API endpoint allows you to submit the OTP received on a registered mobile number to verify and retrieve comprehensive Udyam (MSME) registration details. After successful OTP verification, the API returns detailed enterprise information including business classification, owner details, financial information, address details, and more.

Key Benefits

Retrieve complete Udyam registration details with a single API call

Access official MSME certification information for verification purposes

Obtain detailed enterprise classification, financial, and operational data

Verify business legitimacy through government-registered information

Use Cases

Financial Services

B2B Platforms

Government Services

Verify MSME status for priority sector lending

Validate enterprise details for loan processing

Confirm business classification for specialized MSME credit products

Technical Implementation

Authentication

All API requests require authentication using a JWT Bearer token. Authentication follows these steps:

Obtain API Credentials: Register with Surepass to receive your API key.

Generate JWT Token: Use your API key to generate a JWT token.

Include in Requests: Add the token to the Authorization header as Bearer TOKEN.

Different authentication tokens are used for sandbox and production environments:

Sandbox: https://sandbox.surepass.io

Production: https://kyc-api.surepass.io

Request Parameters

Request Headers

Header	Required	Description
Authorization	Yes	Bearer token for authentication (JWT format)
Content-Type	Yes	application/json

Request Body

Parameter	Type	Required	Description
client_id	String	Yes	Unique Client ID received from the OTP generation step
otp	String	Yes	OTP received on the registered mobile number

Example Request

{
    "client_id": "udyam_otp_pDompboGAwibgt",
    "otp": "000000"
}

Process Response

Response Parameters

Parameter	Type	Description
data	Object	Contains all enterprise details
data.client_id	String	Unique Client ID
data.type_of_enterprise	String	Classification of enterprise (Micro/Small/Medium)
data.major_activity	String	Primary business activity
data.type_of_organisation	String	Legal structure of the organization
data.enterprise_name	String	Registered name of the enterprise
data.owner_name	String	Name of the enterprise owner
data.pan_number	String	PAN number of the enterprise
data.do_you_have_gstin	String	GST registration status (Yes/No)
data.user_email_id	String	Email ID of the enterprise owner
data.social_category	String	Social category of the owner
data.gender	String	Gender of the enterprise owner
data.specially_abled	String	Disability status of the owner (Yes/No)
data.date_of_incorporation	String	Date of business incorporation (YYYY-MM-DD)
data.date_commencement_of_production_business	String	Date when business operations began (YYYY-MM-DD)
data.bank_details	Array	Banking information of the enterprise
data.employment_details	Array	Details about enterprise employees
data.investment_details	Array	Financial investment information
data.official_address	Object	Registered address of the enterprise
data.national_industry_classification_code	Array	NIC code details
data.registration_date	String	Udyam registration date (YYYY-MM-DD)
data.unit_details	Array	Information about business units
data.certificate_link	String	URL to download the Udyam certificate
status_code	Integer	HTTP status code
success	Boolean	Indicates if the request was successful
message	String	Response message
message_code	String	Code indicating the response status

Example Successful Response

{
    "data": {
        "client_id": "udyam_otp_pDompreBkELboGAwibgt",
        "type_of_enterprise": "SMALL",
        "major_activity": "Services",
        "type_of_organisation": "Private Limited Company",
        "enterprise_name": "TECHNOLOGIES PRIVATE LIMITED",
        "owner_name": "TECHNOLOGIES PRIVATE LIMITED",
        "pan_number": "XXXXX1234X",
        "do_you_have_gstin": "Yes",
        "user_email_id": "AAAAA@GMAIL.io",
        "social_category": "General",
        "gender": "Male",
        "specially_abled": "No",
        "date_of_incorporation": "2019-05-10",
        "date_commencement_of_production_business": "2019-05-10",
        "bank_details": [
            {
                "bank_name": " Bank ltd",
                "ifs_code": "ICIC0000000",
                "bank_account_number": "123456789"
            }
        ],
        "employment_details": [],
        "investment_details": [
            {
                "s_no": "1",
                "financial_year": "2021-22",
                "enterprise_type": "Small",
                "wdv": "000000.00",
                "cost_of_research_development_industrial_safety_devices": "0.00",
                "investment_plant_machinery_equipment": "00000.00",
                "total_turnover": "000000.00",
                "export_turnover": "00000.06",
                "net_turnover": "0000000.94",
                "is_itr_filled": "Yes",
                "itr_type": "ITR - 3, 5, 6"
            },
            {
                "s_no": "2",
                "financial_year": "2020-21",
                "enterprise_type": "Micro",
                "wdv": "000000.00",
                "cost_of_research_development_industrial_safety_devices": "0.00",
                "investment_plant_machinery_equipment": "00000.00",
                "total_turnover": "0000000.00",
                "export_turnover": "0.00",
                "net_turnover": "00000000.00",
                "is_itr_filled": "Yes",
                "itr_type": "ITR - 3, 5, 6"
            }
        ],
        "official_address": {
            "flat_or_door_or_block": "Shop No. 38",
            "name_of_premises_or_building": "  Market",
            "village_or_town": " Ganj",
            "block": "North Delhi",
            "road_or_street_or_lane": "Delhi",
            "city": "New Delhi",
            "state": "DELHI",
            "district": "NORTH",
            "pin_code": "000000",
            "mobile_number": "XXXXX",
            "email_id": "ABCD@GMAIL.io"
        },
        "national_industry_classification_code": [
            {
                "s_no": "1",
                "nic_2_digit": "consultancy and related activities",
                "nic_4_digit": "Other information technology and computer service activities",
                "nic_5_digit": "installation",
                "activity": "Services"
            },
            {
                "s_no": "2",
                "nic_2_digit": "consultancy and related activities",
                "nic_4_digit": "Other information technology and computer service activities",
                "nic_5_digit": "installation",
                "activity": "Services"
            }
        ],
        "are_you_interested_to_get_registered_on_government_e_market_gem_portal": "Yes",
        "are_you_interested_to_get_registered_on_treds_portals_one_or_more": "No",
        "are_you_interested_to_get_registered_on_national_career_Service_ncs_portal": "Yes",
        "are_you_interested_to_get_registered_on_nsic_b2b_portal": "Yes",
        "registration_date": "2023-02-08",
        "unit_details": [],
        "certificate_link": "https://aadhaar-kyc-docs.s3.amazonaws.com"
    },
    "status_code": 200,
    "success": true,
    "message": "Success",
    "message_code": "success"
}

Possible Error Responses

Invalid OTP

Invalid Client ID

Authentication Error

{
    "status_code": 400,
    "success": false,
    "message": "Invalid OTP",
    "message_code": "invalid_otp"
}

The OTP provided is incorrect or has expired. Please request a new OTP.

Integration Best Practices

Security Recommendations

Store the JWT token securely and never expose it in client-side code

Implement proper error handling to avoid exposing sensitive information

Use HTTPS for all API communications to ensure data encryption

Implement rate limiting on your end to prevent abuse of the API

User Experience Guidelines

Clearly communicate to users that an OTP will be sent to their registered mobile number

Provide clear instructions on where to find the client_id for OTP submission

Implement a resend OTP option in case the user doesn't receive the initial OTP

Display a countdown timer for OTP expiration to set proper expectations

Code Samples

cURL

Python

Node.js

Related APIs

Generate Udyam OTP - Initiates the OTP verification process for Udyam details

Verify Udyam Certificate - Validates the authenticity of an Udyam certificate

Business Verification - Comprehensive business verification including Udyam status

Compliance and Legal Considerations

The data returned by this API contains official government records and should be handled in accordance with data privacy regulations. The information should only be used for legitimate business purposes such as verification, lending, or business onboarding. Ensure you have proper consent from the business owner before initiating the verification process.

curl --location --request POST 'https://kyc-api.surepass.app/api/v1/udyam-otp/submit-otp' \ --header 'Content-Type: application/json' \ --data-raw '{ "client_id": "udyam_otp_pDompboGAwibgt", "otp": "000000" }'

{ "data": { "client_id": "udyam_otp_pDompreBkELboGAwibgt", "type_of_enterprise": "SMALL", "major_activity": "Services", "type_of_organisation": "Private Limited Company", "enterprise_name": "TECHNOLOGIES PRIVATE LIMITED", "owner_name": "TECHNOLOGIES PRIVATE LIMITED", "pan_number": "XXXXX1234X", "do_you_have_gstin": "Yes", "user_email_id": "AAAAA@GMAIL.io", "social_category": "General", "gender": "Male", "specially_abled": "No", "date_of_incorporation": "2019-05-10", "date_commencement_of_production_business": "2019-05-10", "bank_details": [ { "bank_name": " Bank ltd", "ifs_code": "ICIC0000000", "bank_account_number": "123456789" } ], "employment_details": [], "investment_details": [ { "s_no": "1", "financial_year": "2021-22", "enterprise_type": "Small", "wdv": "000000.00", "cost_of_research_development_industrial_safety_devices": "0.00", "investment_plant_machinery_equipment": "00000.00", "total_turnover": "000000.00", "export_turnover": "00000.06", "net_turnover": "0000000.94", "is_itr_filled": "Yes", "itr_type": "ITR - 3, 5, 6" }, { "s_no": "2", "financial_year": "2020-21", "enterprise_type": "Micro", "wdv": "000000.00", "cost_of_research_development_industrial_safety_devices": "0.00", "investment_plant_machinery_equipment": "00000.00", "total_turnover": "0000000.00", "export_turnover": "0.00", "net_turnover": "00000000.00", "is_itr_filled": "Yes", "itr_type": "ITR - 3, 5, 6" } ], "official_address": { "flat_or_door_or_block": "Shop No. 38", "name_of_premises_or_building": " Market", "village_or_town": " Ganj", "block": "North Delhi", "road_or_street_or_lane": "Delhi", "city": "New Delhi", "state": "DELHI", "district": "NORTH", "pin_code": "000000", "mobile_number": "XXXXX", "email_id": "ABCD@GMAIL.io" }, "national_industry_classification_code": [ { "s_no": "1", "nic_2_digit": "consultancy and related activities", "nic_4_digit": "Other information technology and computer service activities", "nic_5_digit": "installation", "activity": "Services" }, { "s_no": "2", "nic_2_digit": "consultancy and related activities", "nic_4_digit": "Other information technology and computer service activities", "nic_5_digit": "installation", "activity": "Services" }, "nic_2_digit": "consultancy and related activities", "nic_4_digit": "Other information technology and computer service activities", "nic_5_digit": "installation", "activity": "Services" } ], "are_you_interested_to_get_registered_on_government_e_market_gem_portal": "Yes", "are_you_interested_to_get_registered_on_treds_portals_one_or_more": "No", "are_you_interested_to_get_registered_on_national_career_Service_ncs_portal": "Yes", "are_you_interested_to_get_registered_on_nsic_b2b_portal": "Yes", "registration_date": "2023-02-08", "unit_details": [], "certificate_link": "https://aadhaar-kyc-docs.s3.amazonaws.com" }, "status_code": 200, "success": true, "message": "Success", "message_code": "success" }

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Submit OTP

Submit OTP for Udyam Verification#

Description#

Use Cases#

Technical Implementation#

Request Headers#

Request Body#

Example Request#

Response Parameters#

Example Successful Response#

Possible Error Responses#

Integration Best Practices#

Code Samples#

Request

Responses