Quick Search API

7 min

Introduction

This API allows you to create a new organization associated with a specific patron on the Signzy platform. You can use this API to create an organization by providing details such as company identifier (CIN), service required, and a callback URL to receive responses. The API endpoint supports POST method and requires a valid Access Token for authorization.

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	Description
patronid	ID of the patron associated with the organization.
Access-Token	Valid access token for authorization.
identifier	Company's identifier (CIN) in string format.
service	Required service in string format.
callbackUrl	URL where the responses will be received in string format.

Sample Response

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

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

Parameter	Type	Description
target	string	Required. The target object for the hunt.
itemId	string	Required. The ID of the item being hunted.
accessToken	string	Required. A valid access token for authorization.
task	string	Required. The task to perform during the hunt.
essentials	object	Required. An object containing essential information for the hunt.

The essentials object contains the following fields:

Parameter	Type	Description
cin	string	Required. The company's CIN (Corporate Identification Number).

Sample Response

  {
    "category": "...category...",
    "subCategory": "...subCategory...",
    "registrationNumber": "...registrationNumber...",
    "dateOfIncorporation": "...dateOfIncorporation...",
    "numberOfMembers": "...numberOfMembers...",
    "cin": "...cin...",
    "companyName": "...companyName...",
    "companyType": "...companyType...",
    "registeredAddress": "...registeredAddress...",
    "authorisedCapital": "...authorisedCapital...",
    "class": "...class...",
    "paidUpCapital": "...paidUpCapital...",
    "rocOffice": "...rocOffice...",
    "noOfDirectors" : "...noOfDirectors...",
    "whetherListed": "...whetherListed...",
    "balanceSheetDate": "...balanceSheetDate...",
    "statusForEfiling": "...statusForEfiling...",
    "requestId": "...requestId...",
    "updatedTime": "...updatedTime...",
    "natureOfBusiness": "...natureOfBusiness...",
    "splitAddress": {
      "state": [
        [

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

Parameter	Type	Description
category	string	Category of the company
subCategory	string	Sub-category of the company
registrationNumber	string	Registration number of the company
dateOfIncorporation	string	Date of incorporation of the company
numberOfMembers	string	Number of members of the company
cin	string	CIN number of the company
companyName	string	Name of the company
companyType	string	Type of the company
registeredAddress	string	Registered address of the company
authorisedCapital	string	Authorised capital of the company
class	string	Class of the company
paidUpCapital	string	Paid up capital of the company
rocOffice	string	ROC office of the company
noOfDirectors	string	Number of directors of the company
whetherListed	string	Whether the company is listed or not
balanceSheetDate	string	Balance sheet date of the company
statusForEfiling	string	Status for e-filing of the company
requestId	string	Request ID for the API request
updatedTime	string	Time when the company details were last updated
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