Skip to main content
DELETE
/
background-check
/
v1
/
batches
/
{id}
Delete Batch
curl --request DELETE \
  --url https://sandbox.theary.com/background-check/v1/batches/{id}
{
  "success": true,
  "batchId": "<string>",
  "message": "<string>",
  "note": "<string>"
}

​
Delete Background Check Batch

Placeholder implementation. This endpoint does not cancel or delete orders. Use DELETE /background-check/v1/orders/{orderId} for each order you need to cancel.

​
Path Parameters

​
id
string
required
Echoed back as batchId; not used to remove data.

​
Response

​
success
boolean
Always false in the current implementation
​
batchId
string
Same as the path id
​
message
string
Explains that batch deletion is not implemented
​
note
string
Use per-order DELETE endpoints

​
Example Request

curl -X DELETE "https://sandbox.theary.com/background-check/v1/batches/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json"

​
Example Response

{
  "success": false,
  "batchId": "550e8400-e29b-41d4-a716-446655440000",
  "message": "Batch deletion not yet implemented - orders are processed individually",
  "note": "Use individual order DELETE endpoints to cancel specific orders"
}

​
See also