Checking the Status of a Positive Selection Request
GET https://<votiro_appliance>/disarmer/api/disarmer/v4/status/<requestId>
Checks the processing status of a file using the requestId you received when uplaoding the file for positive selection processing.
The positive selection process relies on polling. If no polling takes place for over 60 seconds there is a chance the positive selection request may be deleted. You can configure setting values for the polling interval and the keep alive interval attributes. See the Votiro Cloud User Guide,
Note
To cancel the processing of a file you can use the GET command. The cancellation may take upto 60 seconds to take effect.
Request Data
Request URL Parameters
Request parameters are case sensitive.
Parameter | Description | Type | Required/Optional |
|---|---|---|---|
requestId | Upload request ID | string | Required |
Request Header Parameters
Request parameters are case sensitive.
Parameter | Description | Type | Required/Optional |
|---|---|---|---|
Authorization | Bearer <token> used for authentication | string | Required. |
Request Example
GET https://api.votiro.com/disarmer/api/disarmer/v4/status/
c94f00a4-7a36-4152-977d-dda71cccfb95
Authorization: "Bearer <token>"
Response Data
Response Parameters
Parameter | Description | Type |
|---|---|---|
Status | The status of the positive selection request | string |
Positive Selection Request Statuses
Status Name | Description |
|---|---|
NotExist | The requestId of the file uploaded is not found.The requestId may be incorrect or the positive selection report data has been removed. |
Processing | The file you uploaded is being processed by Votiro Cloud. |
Done | The file you uploaded is processed, and you can download the file. |
Error | The file you uploaded was not processed because of an internal Votiro error. |
Blocked | The file you uploaded was blocked in the positive selection process. Download the file for more information on why the file was blocked. |
Response Example
"Done"
Comments
0 comments
Please sign in to leave a comment.