GET All Downloaded Files API

5 min

Introduction

The Company Details Retrieval API allows you to retrieve the details of a company using its CIN number. The API requires authentication through an access token and returns the company details in a JSON format. The API also allows you to specify a callback URL to receive the response asynchronously.

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..."}'

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/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":{"requestId":"... requestId ..."}}'

Sample Response

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

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