Skip to main content
DELETE
https://api.theary.ai
/
background-check
/
v1
/
batches
/
{id}
Delete Batch
curl --request DELETE \
  --url https://api.theary.ai/background-check/v1/batches/{id} \
  --header 'Authorization: Bearer <token>'
{
  "batchId": "<string>",
  "status": "<string>",
  "deletedAt": "<string>",
  "affectedOrders": 123
}

​
Delete Background Check Batch

Cancels or deletes a background check batch and all associated orders. This operation will remove the batch and all its contained orders from the system.

​
Request

​
Path Parameters

​
id
string
required
Unique identifier of the background check batch to delete (UUID format)

​
Response

Returns confirmation of the batch deletion operation.
​
batchId
string
Unique identifier of the deleted batch (UUID format)
​
status
string
Deletion status (e.g., “deleted”, “cancelled”)
​
deletedAt
string
Timestamp when the batch was deleted (ISO 8601 format)
​
affectedOrders
number
Number of orders that were deleted along with the batch

​
Example Request

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

​
Example Response

{
  "batchId": "550e8400-e29b-41d4-a716-446655440000",
  "status": "deleted",
  "deletedAt": "2024-01-15T14:30:00Z",
  "affectedOrders": 25
}