GET Downloaded Files API

7 min

Introduction

This API allows users to create an organization by providing the CIN (Corporate Identification Number) of the company. The API requires authentication via an access token and returns a response with details of the created organization.

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	Required	Description
identifier	string	Required	The CIN (Corporate Identification Number) of the company for which the organization is being created
service	string	Required	The type of service required by the organization (in this case, ROC)
callbackUrl	string	Required	The URL where the response will be received

Sample Response

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

Parameter	Type	Description
callbackUrl	string	Required. The URL where the responses will be received.
accessToken	string	Required. A valid access token for authorization.
id	string	Optional. The ID of the organization to be created.
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.

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":"getFileByCin","essentials":{"requestId":"...requestId..."}}'

Parameter	Type	Description
target	string	Required. Specifies the type of object to be targeted. In this case, it should be "Organization".
itemId	string	Required. The ID of the organization object created.
accessToken	string	Required. A valid access token for authorization.
task	string	Required. Specifies the task to be performed. In this case, it should be "getFileByCin".
essentials	object	Required. A JSON object containing the essential parameters required for performing the task. In this case, it should contain the "requestId" of the file to be fetched for the given CIN.

sample response

  {
      "result": {
          "companyDocuments": {
            "cin": ".....company's-cin-to-search-for.....",
            "callbackUrl" ".....callbackUrl.....",
            "requestId": ".....requestId.....",
             "files": [
                 {
                     "documentType": "...documentType...",
                     "documentUrl": "...documentUrl...",
                     "documentName": "...documentName..",
                     "documentFilingDate": "..documentFilingDate.."
                 },

             ],
             "status": "..status..",
             "updatedTimestamp": ..updatedTimestamp..,
             "isComplete": ..isComplete..
         }
      }
  }

Parameter Name	Type	Description
cin	string	The CIN of the company whose documents are being requested.
callbackUrl	string	The URL where the response will be sent.
requestId	string	The ID of the request made for the documents.
files	array	An array of documents for the company.
documentType	string	The type of the document.
documentUrl	string	The URL of the document.
documentName	string	The name of the document.
documentFilingDate	string	The date on which the document was filed.
status	string	The status of the request.
updatedTimestamp	string	The time when the response was updated.
isComplete	bool	Indicates whether all documents have been retrieved or not.