MSME Udyam Number Verification API

API v1 Flow v1

API FOR VERIFICATION OF UDYAM REGISTERED MSME BUSINESSES IN INDIA

Description

The Indian ministry of micro, small and medium enterprises (MoMSME) introduced a new simplified procedure for MSME registration called as Udyam registration. Every MSME receives a unique 16 character identifier known as Udyam Number. This replaces the old Udyog Aadhaar number which stands expired as of June 30, 2022. Every MSME are now required to register under the new Udyam scheme.

This API can be used to verify if the provided Udyam number is valid and active. It returns the basic MSME details including name, type of registration, major activity, registered locations, NIC codes, date of commencement etc.

API Details

Request

Type	URL
POST	`https://api.attestr.com`/api/`{version}`/public/corpx/udyam

Request Body Parameters

Type	Name	Description	Optional (default)	Min Version	Max Version
String	reg	UDYAM number to be verified. The allowed format is UDYAM-XX-XX-XXXXXXX	Required	v1

Request Header Parameters

Type	Name	Value / Description	Optional	Min Version	Max Version
String	Content-Type	application/json	Required	v1
String	Authorization	Basic `{authToken}`	Required	v1

If you do not have the authentication token, please refer to Register App to generate one.

Sample Request Payload

JSON
    
 
{  "reg": "UDYAM-TS-01-0000001"}
Copy

Response

HTTP status code 200

Please note that the valid key decides the availability of rest of the keys in the response. If the provided Udyam number does not exist, all keys except valid and message are omitted. If true, remaining keys will have appropriate data.

Key	Description	Type	Min Version
valid	True \| false indicating if the provided UDYAM number exists and is valid	Boolean	v1
reg	Udyam registration number	String	v1
entity	MSME name as registered	String	v1
type	Type of the entity. Proprietary, Partnership, Public Limited, Private Limited etc.	String	v1
majorActivity	Major activity of the unit. Manufacturing or Services	String	v1
gender	Gender of the owner as registered. Male, Female or Others.	String	v1
socialCategory	Social category of the owner as registered. General, SC, ST, OBC.	String	v1
incorporated	Date of incorporation of MSME	Date	v1
commenced	Date of commencement of operations if commenced	Date	v1
registered	Date of MSME registration	Date	v1
classifications	List of MSME classifications such as Micro, Small or Medium and corresponding effective dates. See MSME Classification Object below for the details.	Array[MSME Classification Object]	v1
locations	Plant/unit locations as registered. See MSME Location Object below for details.	Array[MSME Location Object]	v1
officialAddress	The official registered address of the enterprise. See MSME Address Object below for the details.	MSME Address Object	v1
nicCodes	List of National industrial classification (NIC) codes for the activities performed by this enterprise. See MSME NIC Code Object	Array[MSME NIC Code Object]	v1
dic	Name of the district industry centre (DIC) where registered	String	v1
dfo	Development and Facilitation office (DFO) location	String	v1

MSME Classification Object

Key	Description	Type	Min Version
date	Date since effective	Date	v1
year	Financial year for which the classification is effective	String	v1
type	Category Micro, Medium or Small	String	v1

MSME Location Object

Key	Description	Type	Min Version
unitName	Name of the plant / unit	String	v1
unitNumber	House, plot or unit number	String	v1
building	Building name of the plan location	String	v1
villageOrTown	Village or town name of the plant location	String	v1
block	Block / area name of the plant location	String	v1
road	Name of the road	String	v1
city	City name of the plant location	String	v1
zip	Pin code of the plant location	String	v1
state	State where plant is located	String	v1
district	District name where plant is located	String	v1

MSME NIC Code Object

Key	Description	Type	Min Version
digit2	2 Digit NIC code and description	String	v1
digit4	4 Digit NIC code and description	String	v1
digit5	5 Digit NIC code and description	String	v1
activity	Type of activity	String	v1
date	Effective date	Date	v1

MSME Address Object

Key	Description	Type	Min Version
unitNumber	House, plot or unit number	String	v1
building	Name of the building	String	v1
villageOrTown	Name of the village or town	String	v1
block	Block or area name	String	v1
road	Name of the road	String	v1
city	Registered official address city	String	v1
state	State name	String	v1
district	Name of the district	String	v1
zip	Pin code of the location	String	v1
maskedEmail	Masked registered email of the enterprise owner	String	v1
maskedMobile	Masked registered mobile of the enterprise owner	String	v1

Sample Response

Sample response for valid UDYAM number

JSON
    
Copy

Sample response for invalid Udyam number

JSON
    
Copy

Error Response

Parameter	Type	Description
code	Number	Unique error codes for different errors. Always available.
message	String	Error message describing the error. Always Available.
details	String	Detail error message. Available only for certain types of errors.

Error Codes

HTTP Status	Error Code	Error Message
400	4001	Malformed data or missing required parameter values
400	4005	Operation could not be performed due to low credits balance
401	4016	Invalid client authorization
403	4031	Unauthorized access
403	4035	Requested service is not provisioned for your account
403	4039	Client's IP address is not whitelisted
403	4035	Requested service is not provisioned for your account
429	4291	Maximum account rate limit exceeded
429	4292	Maximum API rate limit exceeded
429	4293	Maximum account daily limit exceeded
429	4294	Maximum API daily limit exceeded
500	5001	Request could not be processed

Sample Error Response

JSON
    
Copy

Last updated on