File Download API

7 min

Introduction

This is an API endpoint that creates an organization object using the provided data. The organization object is created under the specified patron ID. The endpoint uses the POST method and accepts a JSON payload in the request body. The request must include an access token for authentication, as well as the organization's identifier (CIN) and the service required by the organization. The response contains the details of the created organization object, including its ID, the patron ID it was created under, and its identifier and service details. The response will be in JSON format.

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 under which the organization object will be created.
identifier	string	Required. The identifier (CIN) of the organization to be created.
service	string	Required. The service required by the organization.
callbackUrl	string	Required. The URL where the responses will be received.
accessToken	string	Required. A valid access token for authentication.

Sample API Response

    // Expected 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 Request (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":"fileDownloadByCin","essentials":{"cin":"...cin-of-the-company...","callbackUrl":"...url..."}}'

Parameter	Type	Description
target	string	Required. The target object type. In this case, it should be "Organization".
itemId	string	Required. The ID of the organization object that was created.
accessToken	string	Required. A valid access token for authentication.
task	string	Required. The type of task to perform. In this case, it should be "fileDownloadByCin".
essentials	object	Required. A JSON object containing the essential data for the task. It should contain the CIN of the company and the URL where the file will be downloaded to.

Sample API Response

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

Parameter	Type	Description
cin	string	The CIN of the company being searched.
result	object	Object containing the search result.
requestId	string	The ID of the search request.
callbackUrl	string	The URL where the search result will be sent to.