Sign in

v1

latestOpenAPI 3.0.0Proprietary - Commercial Use Only2026-08-06172139621.6 KB
Company Report

Get the current status of the generated report.

Get the current progress status of the generated report.

get/api/v2/companies/{id}/report-status

Path parameters

idinteger required
Example:123

The id of the company related to the report.

Query parameters

tokenstring required

The token for the generated report, prepared by the generateCompanyReport action.

Response

Success

Status'Queued' | 'Processing' | 'Ready' | 'Archived' | 'Failed' | 'Deleted'

The current status of the report associated with the token. Explanations of the possible statuses are; <br/> Queued: The report generation request has been received and is waiting to be processed,<br/> Processing: The report is currently being generated, <br/> Ready: The report has been successfully generated and is ready for download, <br/> Archived: The generated report is automatically deleted 30 days after creation, <br/> Failed: The report generation process encountered an error and did not complete, <br/> Deleted: The file has been removed and is no longer available <br/>

ExpirationDatestring date-time

The expiration date of the report to be prepared.

Example response

{
  "Status": "Ready",
  "ExpirationDate": "2021-08-09T08:30:30.682Z"
}