The API allows users to check the status of their submitted data scan requests. Users can provide a single tracking ID or a list of tracking IDs to receive the current status of each scan.
Endpoint: /data-scan/status
Method: PUT
For authentication, include the following token in the request headers:
Headers: {“Authorization”: “Bearer <AUTH_TOKEN>”}
Note: To obtain the <auth token>, please refer to the Step-by-Step Guide to Obtain Your Auth Token.
Request Payload:
Eg Json
[ "47882682-9f38-4f45-afec-daadaa1b230b", "97d18b52-ade8-44f8-9176-802e329c0d2b" ]
Request Parameters
- A list of tracking_id values to check the status of multiple scans.
Response:
{
"data": [
{
"tracking_id": "47882682-9f38-4f45-afec-daadaa1b230b",
"status": "PENDING",
"submitted_at": "2023-11-18 06:20:38.346615",
"process_started_at": "2023-11-18 06:20:38.346615",
"process_ended_at": "2023-11-18 06:20:38.346615",
"error_msg": "-"
},
{
"tracking_id": "97d18b52-ade8-44f8-9176-802e329c0d2b",
"status": "SUCCESS",
"submitted_at": "2023-11-18 06:20:38.346615",
"process_started_at": "2023-11-18 06:20:38.346615",
"process_ended_at": "2023-11-18 06:20:38.346615",
"error_msg": "-"
}
],
"success": "true",
"error": {
"message": ""
}
}
Returns a JSON object with the following keys:
- tracking_id: The unique identifier for the scan request.
- status: The current status of the scan. Possible values are:
- PENDING
- IN-PROGRESS
- SUCCESS
- FAILED
