Submit OTP

16 min

Introduction

This API from Signzy is used to submit the OTP which was generated by the generate OTP api and fetch the details of the Udyam Number and certificate.

How to call the API

You will contact support to create an authorization token. You will be using this authorization token in the headers of the request.

API Input Guidelines

Need to pass the following information

requestId
otp

Sample cURL

Production

Pre Production

curl --location --request POST 'https://api.signzy.app/api/v3/udyamcertificate/submitotp' \
--header 'Authorization: <auth-token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "requestId": "udyam_otp_abcbLlXkpabETYBetxAb",
    "otp": "123456"
}'

curl --location --request POST 'https://api-preproduction.signzy.app/api/v3/udyamcertificate/submitotp' \
--header 'Authorization: <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "requestId": "udyam_otp_abcvUsvWlRduWQvEpFrd",
    "otp": "123456"
}'

Input Parameters

PARAMETER NAME	REQUIRED/OPTIONAL	DESCRIPTION
Content-Type	Required	application/json
Authorization	Required	Authorization token
requestId	Required	requestId which was generated in the generate OTP api
otp	Required	OTP received on mobile when generate OTP was executed

Sample Response

{
    "result": {
        "typeOfEnterprise": "SMALL",
        "majorActivity": "Services",
        "typeOfOrganisation": "Private Limited Company",
        "nameOfEnterprise": "Sample Company",
        "ownerName": "Joe Sample",
        "pan": "ABCD1234E",
        "isGstinAvailable": "Yes",
        "email": "[email protected]",
        "socialCategory": "General",
        "gender": "Male",
        "isSpeciallyAbled": "No",
        "dateOfIncorporation": "2018-01-01",
        "dateOfCommencementOfBusiness": "2018-01-01",
        "bankDetails": [
            {
                "bankName": "ABC bank",
                "ifscCode": "ABCD123456",
                "bankAccountNumber": "123456789012345"
            }
        ],
        "employmentDetails": [
            "male": "10",
            "female": "20",
            "other": "18",
            "total": "48"
        ],
        "investmentInPlantAndMachinery": [
            {
                "slNo": "1",
                "financialYear": "2020-21",
                "enterpriseType": "Small",
                "writtenDownValue": "123456.00",
                "exclusionCost": "0.00",
                "netInvestment": "123456.00",
                "totalTurnover": "123456.00",
                "exportTurnover": "123456.70",
                "netTurnover": "123456.30",
                "isItrFiled": "Yes",
                "ItrType": "ITR - 3, 5, 6"
            },
            {
                "slNo": "2",
                "financialYear": "2019-20",
                "enterpriseType": "Small",
                "writtenDownValue": "654321.00",
                "exclusionCost": "0.00",
                "netInvestment": "654321.00",
                "totalTurnover": "654321.00",
                "exportTurnover": "654321.61",
                "netTurnover": "654321.39",
                "isItrFiled": "Yes",
                "ItrType": "ITR - 3, 5, 6"
            }
        ],
        "unitDetails": [
            {
                "slNo": "1",
                "unitName": "Sample Company",
                "flat": "Apt 12",
                "building": "ABC Business Park",
                "villageTown": "Mumbai",
                "block": "Tower A",
                "road": "ABC road",
                "city": "Mumbai",
                "state": "MAHARASHTRA",
                "district": "MUMBAI",
                "pinCode": "400013"
            },
            {
                "slNo": "2",
                "unitName": "Sample Company",
                "flat": "Qwerty 5th floor",
                "building": "Tower 1",
                "villageTown": "Mumbai",
                "block": "Apple block",
                "road": "Baseball road",
                "city": "Mumbai",
                "state": "MAHARASHTRA",
                "district": "MUMBAI",
                "pinCode": "400013"
            }
        ],
        "officialAddress": {
            "flatDoorBlockNumber": "Qwerty 5th floor",
            "building": "Tower 1",
            "villageTown": "Mumbai",
            "block": "Apple block",
            "roadStreetLane": "Baseball road",
            "city": "Mumbai",
            "state": "MAHARASHTRA",
            "district": "MUMBAI ",
            "pinCode": "400013",
            "mobile": "1234567890",
            "email": "[email protected]"
        },
        "nicCode": [
            {
                "slNo": "1",
                "nic2digit": "62 - Computer programming, consultancy and related activities",
                "nic4digit": "6209 - Other information technology and computer service activities",
                "nic5digit": "62099 - Other information technology and computer service activities n.e.c",
                "activity": "Services"
            }
        ],
        "gemPortal": "No",
        "tredsPortal": "No",
        "ncsPortal": "No",
        "nsicPortal": "No",
        "dateOfUdyamRegistration": "2021-01-01",
        "udyamCertificate": "...udyam certificate url..."
    }
}

Response Parameter

PARAMETER NAME	DESCRIPTION
result	This parameter contains the actual output.
result.typeOfEnterprise	Type of enterprise
result.majorActivity	Major activity of the enterprise
result.typeOfOrganisation	Type of organization
result.nameOfEnterprise	Name of the enterprise
result.ownerName	Name of the owner of the enterprise
result.pan	Permanent Account Number (PAN) of the enterprise
result.isGstinAvailable	Whether Goods and Services Tax Identification Number (GSTIN) is available or not
result.email	Email address of the enterprise
result.socialCategory	Social category of the owner
result.gender	Gender of the owner
result.isSpeciallyAbled	Whether the owner is specially abled or not (Yes/No)
result.dateOfIncorporation	Date of incorporation of the enterprise
result.dateOfCommencementOfBusiness	Date of commencement of business
result.bankDetails	An array of objects that contain details of the bank account(s) of the enterprise
result.bankDetails.bankName	The name of the bank where the account is held.
result.bankDetails.ifscCode	The Indian Financial System Code (IFSC) for the bank.
result.bankDetails.bankAccountNumber	The account number for the bank account.
result.employmentDetails	employment details
result.investmentInPlantAndMachinery	Details of investment in plant and machinery
result.unitDetails	Details of the manufacturing units of the enterprise
result.officialAddress	Official address of the enterprise
result.nicCode	National Industrial Classification (NIC) code(s) of the enterprise
result.gemPortal	Whether the enterprise is registered on Government e-Marketplace (GEM) portal
result.tredsPortal	Whether the enterprise is registered on Trade Receivables Discounting System (TReDS) portal
result.ncsPortal	Whether the enterprise is registered on National Career Service (NCS) portal
result.nsicPortal	Whether the enterprise is registered on National Small Industries Corporation (NSIC) portal
esult.dateOfUdyamRegistration	Date of registration under the Udyam Registration portal
result.udyamCertificate	URL of the Udyam Registration certificate of the enterprise

employmentDetails

PARAMETER NAME	DESCRIPTION
male	The number of male employees.
female	The number of female employees
other	The number of employees who do not identify as male or female.
total	The total number of employees

bankDetails

Key	Description
bankName	The name of the bank where the account is held.
ifscCode	The Indian Financial System Code (IFSC) for the bank.
bankAccountNumber	The account number for the bank account.

investmentInPlantAndMachinery

Key	Description
slNo	Serial number or index of the record
financialYear	The financial year in which the enterprise is operating
enterpriseType	The type of enterprise, such as Small, Medium, or Large
writtenDownValue	The written down value of the enterprise's assets
exclusionCost	The amount of exclusion cost, if any, for the enterprise
netInvestment	The net investment made by the enterprise
totalTurnover	The total turnover of the enterprise
exportTurnover	The turnover generated from exports by the enterprise
netTurnover	The net turnover of the enterprise
isItrFiled	Whether the Income Tax Return (ITR) has been filed or not, with a value of "Yes" or "No"
ItrType	The type of ITR filed, such as ITR-3, ITR-5, or ITR-6

unitDetails

Key	Description
flatDoorBlockNumber	The flat, door, or block number where the address is located
building	The name of the building where the address is located
villageTown	The name of the village or town where the address is located
block	The name of the block or area where the address is located
roadStreetLane	The name of the road, street, or lane where the address is located, such as "Baseball road"
city	The name of the city where the address is located
state	The name of the state where the address is located
district	The name of the district where the address is located
pinCode	The pin code or postal code of the area where the address is located
mobile	The mobile phone number associated with the address
email	The email address associated with the address

officialAddress

Key	Description
slNo	Serial number or index of the record
unitName	The name of the unit or company
flat	The flat number or office number of the uni
building	The name of the building where the unit is located
villageTown	The name of the village or town where the unit is located
block	The block or tower number of the building where the unit is located
road	The name of the road where the unit is located
city	The name of the city where the unit is located
state	The name of the state where the unit is located
district	The name of the district where the unit is located
pinCode	The pin code or postal code of the area where the unit is located

nicCode

Key	Description
slNo	Serial number or index of the record
nic2digit	The 2-digit code for the industry classification of the activity
nic4digit	The 4-digit code for the industry classification of the activity
nic5digit	The 5-digit code for the industry classification of the activity
activity	The type of economic activity associated with the industry classification

Sample Error

{
    "error": {
        "name": "error",
        "message": "Internal Server Error",
        "status": 500,
        "reason": "ERROR",
        "type": "Error",
        "statusCode": 500
    }
}

Error Parameter

PARAMETER NAME	DESCRIPTION
error	This parameter contains the error.
error.name	the name of the error
error.message	the error message
error.status	status of the api
error.reason	Reason for error
error.type	Type of the error
error.statusCode	Request Status code from Signzy

Error codes

CODE	DESCRIPTION	Interpretation
400	Bad Request	Input Parameter has a missing required parameter or the requestId sent was invalid.
401	Authorization failed.	Invalid authentication credentials. Authorization token is invalid.
404	Data not found	OTP is expired or not matching with the requestId
409	Upstream Error	Upstream is down, please contact support
500	Internal Server Error	Internal error at Signzy, please contact support.
408	Request Timed Out. Please try again.	Request took too long to process and timed out.

Getting help

Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.

You can reach out to us at [email protected].