POST
/
v1
/
users
/
data
/
delete
/
status
curl --request POST \
  --url https://api.velt.dev/v1/users/data/delete/status \
  --header 'Content-Type: application/json' \
  --header 'x-velt-api-key: <x-velt-api-key>' \
  --header 'x-velt-auth-token: <x-velt-auth-token>' \
  --data '{
  "data": {
    "jobId": "<string>"
  }
}'
{
    "result": {
        "status": "success",
        "message": "Data fetched successfully.",
        "data": {
            "isDeleteCompleted": true,
            "tasksLeft": 0
        }
    }
}

Use this API to get the status of the data deletion process for a user.

This API may take a few seconds to return a response depending on the dataset size.

Endpoint

POST https://api.velt.dev/v1/users/data/delete/status

Headers

x-velt-api-key
string
required

Your API key.

x-velt-auth-token
string
required

Body

Params

data
object
required

Example Request

{
  "data": {
    "jobId": "yourJobId"
  }
}

Response

Success Response

{
    "result": {
        "status": "success",
        "message": "Data fetched successfully.",
        "data": {
            "isDeleteCompleted": true,
            "tasksLeft": 0
        }
    }
}

Failure Response

{
   "error": {
       "message": "ERROR_MESSAGE",
       "status": "INVALID_ARGUMENT",
       "code": 500
   }
}
{
    "result": {
        "status": "success",
        "message": "Data fetched successfully.",
        "data": {
            "isDeleteCompleted": true,
            "tasksLeft": 0
        }
    }
}