Detailed Search API

8 min

Introduction

The API described in this document allows you to create a new organization associated with a specific patron on the Signzy platform. The API supports the POST method and requires a valid Access Token for authorization. The organization's details should be provided in JSON format, which includes the company's identifier (CIN), the service required, and a callback URL for receiving responses.

Sample cURL Request

curl --request POST \
  --url https://signzy.tech/api/v2/patrons/...patronid..../organizations \
  --header 'Accept: */*' \
  --header 'Accept-Language: en-US,en;q=0.8' \
  --header 'Authorization: <Access-Token>' \
  --header 'content-type: application/json' \
  --data '{"identifier":"...companycin...","service":"roc","callbackUrl":"...call URL..."}'

Parameter	Type	Description
patronid	string	Required. The ID of the patron associated with the organization.
Access-Token	string	Required. A valid access token for authorization.
identifier	string	Required. The company's identifier (CIN).
service	string	Required. The service required by the organization.
callbackUrl	string	Required. The URL where the responses will be received.

Sample API Response

    {
        "callbackUrl": "...callback...",
        "accessToken": "...accestoken....",
        "id": "....id...",
        "patronId": "....patronid...",
        "identifier": "...identifier...",
        "service": "roc"
    }

Company's information

The API returns the following data about the company

companyName
rocOffice
registrationNumber
category
subCategory
class
authorisedCapital
paidUpCapital
numberOfMembers
dateOfIncorporation
registeredAddress
emailId
whetherListed
lastAgmDate
balanceSheetDate
status
addressOtherThanRegisteredOffice
suspendedAtStockExchange
cin
directorDetails

Director's information

For each director of the company you will receive the following information.

din
designation
dateOfAppointment
address
dscExpiryDate
name
whetherDscRegistered
fatherName
dob
pan
OtherDirectorships

For OtherDirectorships's information

For each OtherDirectorship of the director you will receive the following information.

companyName
beginDate
cin
endDate

Sample cURL (hunt)

curl --request POST \
  --url https://signzy.tech/api/v2/hunts \
  --header 'Accept: */*' \
  --header 'Accept-Language: en-US,en;q=0.8' \
  --header 'content-type: application/json' \
  --data '{"target":"Organization","itemId":"....id-of-the-organization-object-created.....","accessToken":"....accessToken-of-the-organization-object-created.....","task":"detailedSearchByCin","essentials":{"cin":"...cin-of-the-company..."}}'

Parameter	Type	Description
target	string	Required. The target object type for the search. Possible values: "Organization", "Director", "Charges", "Others".
itemId	string	Required. The ID of the object created.
accessToken	string	Required. A valid access token for authorization.
task	string	Required. The task to be performed. Possible values: "detailedSearchByCin", "simpleSearchByCin", "..."
essentials	object	Required. A JSON object containing the search criteria.
cin	string	Required. The CIN (Corporate Identification Number) of the company to be searched.

Sample API Response (hunt)

  {
      "companyName": "...company name...",
      "rocOffice": "...roc office....",
      "registrationNumber": "....Reg. number....",
      "category": "...category",
      "subCategory": "...subcategory...",
      "class": "...class...",
      "authorisedCapital": "..authorisedCapital..",
      "paidUpCapital": "...paidUpCapital...",
      "numberOfMembers": "....numberOfMembers..",
      "dateOfIncorporation": "...dateOfIncorporation...",
      "registeredAddress": "...registeredAddress..",
      "emailId": "..emailId....",
      "whetherListed": "...whetherListed...",
      "lastAgmDate": "...lastAgmDate...",
      "balanceSheetDate": "31/03/2016",
      "status": "..status..",
      "addressOtherThanRegisteredOffice": "",
      "suspendedAtStockExchange": "",
      "cin": "...cin...",
      "natureOfBusiness": "...natureOfBusiness...",
      "directorDetails": [{
        "din": "....din...",
        "designation": "....designation...",
        "dateOfAppointment": "03/11/2015",
        "address": "...address...",
        "dscExpiryDate": "...dscExpiryDate..",
        "name": "....name....",
        "whetherDscRegistered": "Yes",
        "splitAddress": {
          "state": [
            []
          ],
          "district": [],
          "city": [],
          "pincode": "...pincode...",
          "country": ["IN", "IND", "INDIA"],
          "addressLine": ".....address line...."
        },
        "fatherName": "...fatherName...",
        "dob": "08/03/1988",
        "pan": "",
        "otherDirectorships": {
          "listOfLLPs": [],
          "listOfCompanies": [{
            "cin": "...cin....",
            "companyName": ".....company name....",
            "beginDate": ".....begindate...",
            "endDate": "...end date...."
          }, {
            "cin": "...cin....",
            "companyName": ".....company name....",
            "beginDate": ".....begindate...",
            "endDate": "...end date...."
          }, {
            "cin": "...cin....",
            "companyName": ".....company name....",
            "beginDate": ".....begindate...",
            "endDate": "...end date...."
          }, {
            "cin": "...cin....",
            "companyName": ".....company name....",
            "beginDate": ".....begindate...",
            "endDate": "...end date...."
          }],
          "din": "...din..."
        }
      }
      }],
      "splitAddress": {
        "state": [
          [

          ]
        ],
        "district": ...dist..,
        "city": ...city...,
        "pincode": "..pincode...",
        "country": ["IN", "IND", "INDIA"],
        "addressLine": ".....addressLine...."
      },
      "pan": ""
    }


Parameter	Type	Description
companyName	string	Required. The name of the company.
rocOffice	string	Required. The ROC office of the company.
registrationNumber	string	Required. The registration number of the company.
category	string	Required. The category of the company.
subCategory	string	Required. The sub-category of the company.
class	string	Required. The class of the company.
authorisedCapital	string	Required. The authorised capital of the company.
paidUpCapital	string	Required. The paid-up capital of the company.
numberOfMembers	string	Required. The number of members in the company.
dateOfIncorporation	string	Required. The date of incorporation of the company.
registeredAddress	string	Required. The registered address of the company.
emailId	string	Required. The email ID of the company.
whetherListed	string	Required. Whether the company is listed or not.
lastAgmDate	string	Required. The last AGM date of the company.
balanceSheetDate	string	Required. The balance sheet date of the company.
status	string	Required. The status of the company.
addressOtherThanRegisteredOffice	string	Optional. The address other than the registered office of the company.
suspendedAtStockExchange	string	Optional. Whether the company is suspended at the stock exchange or not.
cin	string	Required. The CIN of the company.
natureOfBusiness	string	Required. The nature of business of the company.
directorDetails	array	Required. An array of director details.
directorDetails.din	string	Required. The DIN of the director.
directorDetails.designation	string	Required. The designation of the director.
directorDetails.dateOfAppointment	string	Required. The date of appointment of the director.
directorDetails.address	string	Required. The address of the director.
directorDetails.dscExpiryDate	string	Required. The DSC expiry date of the director.
directorDetails.name	string	Required. The name of the director.
directorDetails.whetherDscRegistered	string	Required. Whether the director's DSC is registered or not.
directorDetails.splitAddress	object	Required. The split address of the director.
directorDetails.fatherName	string	Required. The father's name of the director.
directorDetails.dob	string	Required. The date of birth of the director.
directorDetails.pan	string	Optional. The PAN of the director.
directorDetails.otherDirectorships	object	Optional. The other directorships of the director.
directorDetails.otherDirectorships.listOfLLPs	array	Optional. An array of LLP details.
directorDetails.otherDirectorships.listOfCompanies	array	Optional. An array of company details.
directorDetails.otherDirectorships.listOfCompanies.cin	string	Required. The CIN of the company.
directorDetails.otherDirectorships.listOfCompanies.companyName	string	Required. The name of the company.
directorDetails.otherDirectorships.listOfCompanies.beginDate	string