API reference / Business / KYB

Shop and establishment

Registration details from the state record. States: Rajasthan, Uttar Pradesh, West Bengal, Jharkhand, Maharashtra (category required), Karnataka, Delhi.

POST/v1/business/shop-establishment
Authentication
Bearer token
Scope
kyc:verify

Before you integrate

  • state must be one of the seven listed; any other state is rejected and the call is refunded.

Request body

FieldTypeRequiredDescription
registration_numberstringYesRegistration number on the certificate, 3 to 40 letters, digits, slashes, dots, underscores or hyphens.
statestringYesState of registration: RAJASTHAN, UTTAR PRADESH, WEST BENGAL, JHARKHAND, MAHARASHTRA, KARNATAKA or DELHI. Case is ignored.
categorystringNoCategory printed on the certificate, for example COMMERCIAL ESTABLISHMENT (3 to 60 letters, spaces, & / or -). Required when state is MAHARASHTRA.

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/shop-establishment' \
  -H "Authorization: Bearer $GRAPPI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "registration_number": "2023/123/456",
  "state": "KARNATAKA"
}'

Sample response

{
  "request_id": "req_01HZY3K8M2",
  "result": {
    "establishment_name": "EXAMPLE TRADERS",
    "registration_number": "2023/123/456",
    "category": "COMMERCIAL ESTABLISHMENT",
    "status": "Active",
    "date_of_commencement": "2023-04-01",
    "expiry_date": "2028-03-31",
    "address": "12 Example Lane, Bengaluru, Karnataka, 560001",
    "split_address": {
      "district": [
        "Bengaluru Urban"
      ],
      "state": [
        "Karnataka"
      ],
      "city": [
        "Bengaluru"
      ],
      "pincode": "560001",
      "country": [
        "India"
      ],
      "address_line": "12 Example Lane"
    }
  }
}

Response fields

FieldTypeDescription
establishment_namestringName of the establishment.
registration_numberstringRegistration number.
categorystringCategory of the establishment.
statusstringStatus of the registration.
application_typestringType of application, for example new or renewal.
act_namestringThe act the registration is under.
date_of_commencementstringDate the establishment began.
expiry_datestringDate the registration expires.
renewal_positionstringRenewal position.
acknowledgement_nostringAcknowledgement number.
addressstringAddress of the establishment.
split_addressobjectThe establishment's address broken into parts.
split_address.districtarrayDistrict name, as a list.
split_address.statearrayState name, as a list.
split_address.cityarrayCity name, as a list.
split_address.pincodestringSix-digit pincode.
split_address.countryarrayCountry name, as a list.
split_address.address_linestringStreet-level part of the address.
certificate_filestringLink to the certificate, when available.

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.