(Deprecated) Getting Upload Status

You can get the status of an upload activity by submitting a GET request to the Upload File API .

This API is deprecated. Please use the E-Waybill APIs from the unified set available here.

Get upload status

GET https://ewb.cleartax.in/api/v0.2/taxable_entities/{taxable_entity_id}/upload_activity/{activity_id}/status

This endpoint allows you to get file upload status. {taxable_entity_id} : taxable entity ID associated to the GSTIN. {activity_id} : activity id given by Creating or Updating Documents API. Sample request : https://ewb.cleartax.in/api/v0.2/taxable_entities/c5cc664c-d473-4ec5-9301-acf43349b7c4/upload_activity/02de95e9-864d-49b5-a793-5e29f718dd2b/status

Headers

Name	Type	Description
X-Cleartax-Auth-Token: <USER_AUTH_TOKEN>	string	Auth token will be generated & given upon request.

200 status successfully retrieved. status : Based on traffic on server, you may get status from given list. 'INIT', 'UPLOADED', 'QUEUED', 'PROCESSING', 'PROCESSED', 'ABORTED'

{
    "activityId": "02de95e9-864d-49b5-a793-5e29f718dd2b",
    "status": "PROCESSED",
    "errorMessage": null,
    "queuedCount": 0
}

404 in case provided activity_id or parameter incorrect

{
    "errors": {
        "err_1": {
            "code": "404",
            "message": "No activity found for id 02de95e9-864d-49b5-a793-5e29f718dd2",
            "error_group_code": 0,
            "error_id": 0
        }
    }
}