Simple Search API

7 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

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.
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.
Accept	string	Required. The response format to accept. Default is /.
Accept-Language	string	Required. The language preference for the response. Default is en-US, en;q=0.8.
Authorization	string	Required. A valid access token for authorization.
content-type	string	Required. The format of the request body. Default is application/json.
data	object	Required. The request body containing the organization's details in JSON format.

Sample API Response

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

Parameter	Type	Description
target	string	Required. The target entity type.
itemId	string	Required. The ID of the organization object created.
accessToken	string	Required. A valid access token for authorization.
task	string	Required. The type of task to perform.
essentials	object	Required. A JSON object containing the essential parameters needed for the task.

The essentials parameter should be a JSON object with the following keys and values:

Parameter	Type	Description
cin	string	Required. The CIN (Corporate Identification Number) of the company.

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":"simpleSearchByCin","essentials":{"cin":"...cin-of-the-company..."}}'

Parameter	Type	Description
target	string	Required. The target for the hunt.
itemId	string	Required. The ID of the organization object created.
accessToken	string	Required. A valid access token for authorization.
task	string	Required. The task to perform for the hunt.
essentials	object	Required. The essentials for the hunt, including the company's CIN (cin).
cin	string	Required. The CIN of the company to be searched.

Sample API Response (hunt)

  {
    "companyName": "...companyName...",
    "rocOffice": "...rocOffice...",
    "registrationNumber": "...registrationNumber...",
    "category": "...category...",
    "subCategory": "...subCategory...",
    "class": "...class...",
    "authorisedCapital": "...authorisedCapital...",
    "paidUpCapital": "...paidUpCapital...",
    "numberOfMembers": "...numberOfMembers...",
    "dateOfIncorporation": "...dateOfIncorporation...",
    "countryOfIncorporation": "...countryOfIncorporation...",
    "descriptionOfMainDivision": "...descriptionOfMainDivision...",
    "registeredAddress": "...registeredAddress...",
    "pan": "...pan...",
    "emailId": "...emailId...",
    "whetherListed": "...whetherListed...",
    "lastAgmDate": "...lastAgmDate...",
    "balanceSheetDate": "...balanceSheetDate...",
    "status": "...status...",
    "addressOtherThanRegisteredOffice": "...addressOtherThanRegisteredOffice...",
    "suspendedAtStockExchange": "...suspendedAtStockExchange...",
    "natureOfBusiness": "...natureOfBusiness...",
    "splitAddress": {
      "state": [
        [

        ]
      ],
      "district": [

      ],
      "city": [],
      "pincode": "...pincode...",
      "country": [
        "IN",
        "IND",
        "INDIA"
      ],
      "addressLine": "...addressLine..."
    },
    "cin": "...cin...",
    "directorDetails": [
      {
        "name": "...name...",
        "fatherName": "...fatherName...",
        "dob": "...dob...",
        "pan": "...pan...",
        "din": "...din...",
        "dscExpiryDate": "...dscExpiryDate...",
        "dateOfAppointment": "...dateOfAppointment...",
        "designation": "...designation...",
        "address": "...address...",
        "splitAddress": {
          "state": [
            [

            ]
          ],
          "district": [

          ],
          "city": [],
          "pincode": "...pincode...",
          "country": [
            "IN",
            "IND",
            "INDIA"
          ],
          "addressLine": "...addressLine..."
        },
        "whetherDscRegistered": "...whetherDscRegistered..."
      }
    ]
  }

Parameter	Type	Description
companyName	string	Name of the company.
rocOffice	string	ROC office of the company.
registrationNumber	string	Registration number of the company.
category	string	Category of the company.
subCategory	string	Sub-category of the company.
class	string	Class of the company.
authorisedCapital	string	Authorised capital of the company.
paidUpCapital	string	Paid up capital of the company.
numberOfMembers	string	Number of members of the company.
dateOfIncorporation	string	Date of incorporation of the company.
countryOfIncorporation	string	Country of incorporation of the company.
descriptionOfMainDivision	string	Description of the main division of the company.
registeredAddress	string	Registered address of the company.
pan	string	PAN number of the company.
emailId	string	Email ID of the company.
whetherListed	string	Whether the company is listed or not.
lastAgmDate	string	Date of last annual general meeting of the company.
balanceSheetDate	string	Balance sheet date of the company.
status	string	Status of the company.
addressOtherThanRegisteredOffice	string	Address other than the registered office of the company.
suspendedAtStockExchange	string	Whether the company is suspended at the stock exchange or not.
natureOfBusiness	string	Nature of business of the company.
splitAddress.state	array	State of the company's registered address.
splitAddress.district	array	District of the company's registered address.
splitAddress.city	array	City of the company's registered address.
splitAddress.pincode	string	Pincode of the company's registered address.
splitAddress.country	array	Country of the company's registered address.
splitAddress.addressLine	string	Address line of the company's registered address.
cin	string	CIN number of the company.
directorDetails	array	Array of objects containing details of the directors of the company.
directorDetails.name	string	Name of the director.
directorDetails.fatherName	string	Father's name of the director.
directorDetails.dob	string	Date of birth of the director.
directorDetails.pan	string	PAN number of the director.
directorDetails.din	string	DIN number of the director.
directorDetails.dscExpiryDate	string	DSC expiry date of the director.
directorDetails.dateOfAppointment	string	Date of appointment of the director.
directorDetails.designation	string	Designation of the director.
directorDetails.address	string	Address of the director.
directorDetails.splitAddress.state	array	State of the director's address.
directorDetails.splitAddress.district	array	District of the director's address.
directorDetails.splitAddress.city	array	City of the director's address.
directorDetails.splitAddress.pincode	string	Pincode of the director