Data Status

4 min

Introduction

This API documentation provides instructions for making a POST request to the Signzy API endpoint for retrieving company consolidated data status. The request requires the patron's ID, access token, and essential information such as Company Identification Number (CIN) and the task to perform. The response provides the status of the requested data.

Sample cURL

curl --request POST \
  --url https://signzy.tech/api/v2/patrons/...patronID.../companyconsolidated \
  --header 'Accept: */*' \
  --header 'Accept-Language: en-US,en;q=0.8' \
  --header 'Authorization: <Access-Token>' \
  --header 'content-type: application/json' \
  --data '{"task":"getDataStatus","essentials":{"cin":"...cin..."}}'

Parameter	Data Type	Required	Description
patronID	string	Yes	The unique identifier for the patron.
Access-Token	string	Yes	The access token for authentication.
Accept	string	No	The accepted response content type.
Accept-Language	string	No	The preferred language of the response.
content-type	string	Yes	The content type of the request payload.
task	string	Yes	The task to perform. In this case, the value must be getDataStatus.
cin	string	Yes	The Company Identification Number (CIN) of the company for which the consolidated data status is to be retrieved.

Sample Response

"result": {
    "dataStatus": {
        "eFilingStatus": "...eFilingStatus...",
        "nextCin": "...nextCin...",
        "lastBaseUpdated": "...lastBaseUpdated...",
        "lastDetailsUpdated": "...lastDetailsUpdated...",
        "lastFinYearEnd": "
Ctrl + shift + F
...lastFinYearEnd...",
        "lastFilingDate": "...lastFilingDate..."
    }
 }

Parameter	Data Type	Required	Description
eFilingStatus	string	Yes	The status of the e-filing of the company consolidated data.
nextCin	string	Yes	The CIN of the next company consolidated data to be processed.
lastBaseUpdated	string	Yes	The date of the last update to the company consolidated base data.
lastDetailsUpdated	string	Yes	The date of the last update to the company consolidated details data.
lastFinYearEnd	string	Yes	The end date of the last financial year for the company.
lastFilingDate	string	Yes	The date of the last filing of the company consolidated data.