All File Download API

6 min

Introduction

This API is used to search and fetch the details of an organization based on its Company Identification Number (CIN). It accepts the CIN of the company as input and returns the company details including its registration number, category, subcategory, authorized capital, paid-up capital, number of members, date of incorporation, registered address, email id, balance sheet date, status for e-filing, whether listed, and more.

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	The ID of the patron account.
identifier	string	The company's CIN (Corporate Identification Number)
service	string	The ROC (Registrar of Companies) service to use.
callbackUrl	string	The URL where the API will send a callback response.
Access-Token	string	The access token used for authorization.

Sample Response

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

Parameter	Type	Description
callbackUrl	string	URL where the response will be sent to
accessToken	string	Access token to authenticate the API request
id	string	ID of the organization object created
patronId	string	Patron ID associated with the organization object
identifier	string	Company CIN for which the service is being called
service	string	Name of the ROC service being used

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 '{"target":"Organization","itemId":"....id-of-the-organization-object-created.....","accessToken":"....accessToken-of-the-organization-object-created.....","task":"fetchCompanyAllDocuments","essentials":{"cin":"... cin no ...","callbackUrl":"...url..."}}'

Sample response

  {
      "result": {
          "cin": ".....company's-cin-to-search-for....",
          "requestId": "...requestId...",
          "callbackUrl": "...callback...",
      }
  }