Udyog Aadhaar Verification API

Objective

The Udyog Aadhaar Verification API confirms the existence and validity of an Udyog Aadhaar Number of an organisation.
It returns the following details as a part of its verification process:

Enterprise exists/does not exist
Document ID (Udyog Aadhaar number)
Major Activity of the organisation
Enterprise Type (Small, Medium, Large)
UAM Category (Udyog Aadhaar Memorandum)
Name of the Organisation
Mobile Number
Email ID
Date of Commencement
Applied Date
District Industrial Centre (DIC)
State
Social Category
National Industrial Classification Code (NIC)
Name and address of all Enterprise Units

info

Udyog Aadhaar is a twelve digit Unique Identification Number provided by the Indian Ministry of Micro, Small and Medium Enterprises. It is also known as Aadhaar for business.

Input	Output
The twelve-digit Udyog Aadhaar number of the organisation.	The details of the registered organization. The complete list of output fields is provided under the objective section.

API URL

https://ind-engine.thomas.hyperverge.co/v1/verifyUdyogAadhaar

Overview

The API is RESTful and uses standard HTTP verbs and status codes. The responses are in JSON format, and you should upload all images and files as form-data through a POST request.

Authentication

You need a unique pair of application ID (appId) and application key (appKey) from HyperVerge to verify your identity for accessing the API.

API Request Details

Method - `POST`

Headers

Parameter	Mandatory or Optional	Description	Valid Values
Content-type	Mandatory	This parameter defines the media type for the request payload.	application/json
appId	Mandatory	Application ID shared by HyperVerge	Not Applicable - this is a unique value.
appKey	Mandatory	Application Key shared by HyperVerge	Not Applicable - this is a unique value.
transactionId	Mandatory	Unique ID for the customer journey.	N/A. Any defined unique value mapped to a transaction in your business ecosystem.

Inputs

The following table provides the details of the fields required for the API's request body.

Parameter	Mandatory or Optional	Description	Valid Values
udyogReferenceNumber	Mandatory	Enter the 12-digit Udyog Number of the organisation. For example: "KR1234567890"	Not Applicable
consent	Mandatory	The consent of the user to verify the Udyog number.	"Y" for yes, or "N" for no.

Sample Request

The following code shows a standard curl request for the API.

curl --location --request POST 'https://ind-engine.thomas.hyperverge.co/v1/verifyUdyogAadhaar' \
--header 'Content-Type: application/json' \
--header 'appId: <Enter_the_HyperVerge_appId>' \
--header 'appKey: <Enter_the_HyperVerge_appKey>' \
--header 'transactionId: <Enter_the_HyperVerge_transactionID>' \
--data '{
    "udyogReferenceNumber": "<Enter_Udyog_Reference_Number>",
    "consent": "Y"
}'

Success Response Sample

The following code is a sample of success response from the API.

{
  "status": "success",
  "statusCode": 200,
  "result": {
    "message": "Enterprise exists",
    "documentId": "KR1234567890",
    "majorActivity": "Services",
    "enterpriseType": "Small",
    "uamCategory": "E",
    "name": "XYZ TECHNOLOGIES PRIVATE LIMITED",
    "mobile": "90*****089",
    "email": "abc@example.com",
    "dateOfCommencement": "2000-12-30",
    "appliedDate": "2000-12-09",
    "districtIndustrialCentre": "BANGALORE (URBAN)",
    "state": "KARNATAKA",
    "socialCategory": "General",
    "nicData": {
      "nic_2_digit": "62-Computer programming, consultancy and related activities",
      "nic_4_digit": "6201-Computer programming activities",
      "nic_5_digit": "62013-Providing software support and maintenance to the clients"
    },
    "enterpriseUnits": [
      {
        "address": {
          "door_no": "",
          "building": "ABC Building",
          "area": "Indiranagar",
          "street": "18th Cross",
          "city": "Bangalore",
          "state": "KARNATAKA",
          "district": "BENGALURU (URBAN)",
          "pincode": "5600000"
        }
      }
    ]
  },
  "metaData": {
    "requestId": "1693299729629-539a946a-5674-4c36-aad2-2c7ddc282f0d"
  }
}

Success Response Details

The following table provides the details of the fields in a success response:

Parameter	Description
message	Displays whether the organization exists in the Udyog Aadhaar Database or not.
documentId	The 12-digit Udyog registration number entered by the user.
majorActivity	The major activity of the organization, such as "Services," "Manufacturing," etc.
enterpriseType	The enterprise type of the organization, e.g., Small, Medium, Large.
uamCategory	The Udyog Aadhaar Memorandum (UAM) category for the organization, e.g., "E" for services.
name	The name of the organization.
mobile	The mobile number of the organization.
email	The Email-ID of the organization.
dateOfCommencement	The date of commencement of the organization.
appliedDate	The date when the application was submitted (if applicable).
districtIndustrialCentre	The District Industrial Centre (DIC) of the organization.
state	The state where the organization is based.
socialCategory	The social category of the organization, e.g., "General."
nicData	The National Industrial Classification (NIC) codes of the organization.
enterpriseUnits	The name and address of all enterprise units of the organization.

Failure Response Sample

The following is a sample response for an invalid Udyog Aadhaar Number:

{
  "statusCode": 400,
  "status": "failure",
  "error": "Udyog Aadhaar Number does not exist",
  "metaData": {
    "requestId": "123456789",
    "transactionId": "abcd"
  }
}

Error Response Sample

The following are the sample error responses for the API:

{
  "message": "Input Validation Error: does not meet minimum length of 12",
  "statusCode": 400,
  "status": "failure",
  "metaData": {
    "requestId": "123456789",
    "transactionId": "abcd"
  }
}

{
  "message": "Input Validation Error: does not meet minimum length of 1",
  "statusCode": 400,
  "status": "failure",
  "metaData": {
    "requestId": "123456789",
    "transactionId": "abcd"
  }
}

{
  "statusCode": 400,
  "status": "failure",
  "error": "Bad Request",
  "metaData": {
    "requestId": "123456789",
    "transactionId": "abcd"
  }
}

{
  "statusCode": 400,
  "status": "failure",
  "error": "Consent should be provided",
  "metaData": {
    "requestId": "123456789",
    "transactionId": "abcd"
  }
}

{
  "message": "Missing/Invalid credentials",
  "statusCode": 401,
  "status": "failure",
  "metaData": {
      "requestId": "123456789",
      "transactionId": "abcd"
  }
}

{
  "statusCode": 500,
  "status": "failure",
  "error": "Internal Server Error",
  "metaData": {
    "requestId": "123456789",
    "transactionId": "abcd"
  }
}

Failure and Error Response Details

Status Code	Error Message	Error Description
400	Missing required request parameters.	Some mandatory request parameters are missing in the API request made. Check if "udyogReferenceNumber" and "consent" are given in the request body.
401	Missing/Invalid credentials	The `appId` / `appKey` is missing or incorrect in the request headers.
500	Internal Server Error	Check API request headers and/or contact HV for investigation.
403	Access Denied	Please contact Hyperverge

Objective​

API URL​

Overview​

Authentication​

API Request Details​

Method - POST​

Headers​

Inputs​

Sample Request​

Success Response Sample​

Success Response Details​

Failure Response Sample​

Error Response Sample​

Failure and Error Response Details​