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

FieldTypeRequiredDescription
request_idstringYesThe request_id from /v1/business/udyam/otp, 6 to 80 letters, digits, hyphens or underscores.
otpstringYesThe 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

FieldTypeDescription
name_of_enterprisestringName of the enterprise.
owner_namestringName of the owner.
type_of_enterprisestringMicro, small or medium.
type_of_organisationstringLegal form of the enterprise.
major_activitystringManufacturing, services or trading.
panstringPAN of the enterprise.
is_gstin_availablestringWhether a GSTIN is linked.
emailstringEmail on the registration.
social_categorystringSocial category of the owner.
genderstringGender of the owner.
is_specially_abledstringWhether the owner is specially abled.
date_of_incorporationstringDate the enterprise was incorporated.
date_of_commencement_of_businessstringDate the business began.
date_of_udyam_registrationstringDate of Udyam registration.
bank_detailsarrayBank accounts on the registration.
employment_detailsarrayEmployment figures by year.
investment_in_plant_and_machineryarrayInvestment figures by year.
unit_detailsarrayThe enterprise's units.
official_addressobjectOfficial address of the enterprise.
official_address.flat_door_block_numberstringFlat, door or block number.
official_address.buildingstringBuilding name.
official_address.village_townstringVillage or town.
official_address.blockstringBlock.
official_address.road_street_lanestringRoad, street or lane.
official_address.citystringCity.
official_address.districtstringDistrict.
official_address.statestringState.
official_address.pin_codestringPincode.
official_address.mobilestringMobile number.
official_address.emailstringEmail.
nic_codearrayNIC activity codes of the enterprise.
udyam_certificatestringThe 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.