API reference / Business / KYB
Udyam by OTP: verify
Submits the OTP with the request_id from the send call and returns the registration.
POST
/v1/business/udyam/otp/verify- Authentication
- Bearer token
- Scope
kyc:verify
Before you integrate
- This is step 2 of 2 and needs the request_id from /v1/business/udyam/otp. If the OTP is wrong or has expired, the call fails and you can send a new OTP.
Request body
| Field | Type | Required | Description |
|---|---|---|---|
request_id | string | Yes | The request_id from /v1/business/udyam/otp, 6 to 80 letters, digits, hyphens or underscores. |
otp | string | Yes | The OTP received on the registered mobile, 4 to 8 digits. |
Sample code
Set your key in the GRAPPI_API_KEY environment variable. Sample values are placeholders.
curl -sS -X POST 'https://grappi.ai/v1/business/udyam/otp/verify' \
-H "Authorization: Bearer $GRAPPI_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"request_id": "udyam_otp_abc123",
"otp": "123456"
}'Sample response
{
"request_id": "req_01HZY3K8M2",
"result": {
"name_of_enterprise": "EXAMPLE TRADERS",
"owner_name": "ASHA RAO",
"type_of_enterprise": "Micro",
"type_of_organisation": "Proprietary",
"major_activity": "Trading",
"pan": "ABCDE1234F",
"is_gstin_available": "No",
"date_of_incorporation": "2019-06-01",
"date_of_udyam_registration": "2020-07-15",
"official_address": {
"city": "Pune",
"district": "Pune",
"state": "Maharashtra",
"pin_code": "411001"
},
"nic_code": [
{
"nic_code": "47190",
"activity": "Retail trade"
}
]
}
}Response fields
| Field | Type | Description |
|---|---|---|
name_of_enterprise | string | Name of the enterprise. |
owner_name | string | Name of the owner. |
type_of_enterprise | string | Micro, small or medium. |
type_of_organisation | string | Legal form of the enterprise. |
major_activity | string | Manufacturing, services or trading. |
pan | string | PAN of the enterprise. |
is_gstin_available | string | Whether a GSTIN is linked. |
email | string | Email on the registration. |
social_category | string | Social category of the owner. |
gender | string | Gender of the owner. |
is_specially_abled | string | Whether the owner is specially abled. |
date_of_incorporation | string | Date the enterprise was incorporated. |
date_of_commencement_of_business | string | Date the business began. |
date_of_udyam_registration | string | Date of Udyam registration. |
bank_details | array | Bank accounts on the registration. |
employment_details | array | Employment figures by year. |
investment_in_plant_and_machinery | array | Investment figures by year. |
unit_details | array | The enterprise's units. |
official_address | object | Official address of the enterprise. |
official_address.flat_door_block_number | string | Flat, door or block number. |
official_address.building | string | Building name. |
official_address.village_town | string | Village or town. |
official_address.block | string | Block. |
official_address.road_street_lane | string | Road, street or lane. |
official_address.city | string | City. |
official_address.district | string | District. |
official_address.state | string | State. |
official_address.pin_code | string | Pincode. |
official_address.mobile | string | Mobile number. |
official_address.email | string | Email. |
nic_code | array | NIC activity codes of the enterprise. |
udyam_certificate | string | The registration certificate, as returned. |
Errors
Every failure has the same shape. A call that fails on our side or at the data source is refunded to your wallet; a "no record found" answer is charged. See the error reference.