Sign in

v1

latestOpenAPI 3.0.0Proprietary - Commercial Use Only2026-08-06172139621.6 KB
Compliance

Check the progress of uploading compliance related unique file by using the token returned.

The upload process is a heavy and complicated one, so, it's hard to predict the time it takes to process a compliance related file, however, 10 minutes to 1 hour is a meaningful period to wait under normal loads.

get/api/v2/companies/{id}/compliance/upload

Path parameters

idinteger required
Example:123

The id of the company that the compliance artifact upload progress is to be checked.

Query parameters

tokenstring required
Example:93ecadf5-0917-4f11-9c1c-3269ae1f1795

The token that uniquely identifies the upload process.

Response

Success

Tokenstring

The token identifying the upload process.

CompanyIdinteger

The ID of the company associated with the upload.

Status'Successfully processed' | 'Uploading the file' | 'Reading the content' | 'Running semantic analysis' | 'Gathering the current compliance data' | 'Failed to process the file'

The string representation of the upload process's status. Any value other than 'Successfully processed' means the process is still ongoing or failed. 'Failed to process the file' means the process has failed.

ErrorMessagestring

Error message if the upload process failed.

Example response

{
  "Token": "93ecadf5-0917-4f11-9c1c-3269ae1f1795",
  "CompanyId": 123,
  "Status": "Successfully processed",
  "ErrorMessage": "File format not supported."
}