Error
A valid request URL is required to generate request examples{}Orders API
Delete Order
Cancels or soft-deletes a verification order
DELETE
/
background-check
/
v1
/
orders
/
{id}
Error
A valid request URL is required to generate request examples{}Delete Background Check Order
Cancels or soft-deletes a verification order and all associated searches.Request
string
required
Unique identifier of the verification order to delete (UUID format)
Response
Cancellation is best-effort: the order and its searches are moved to a cancelled state and outstanding outbound work is cancelled.boolean
true when cancellation succeeded.string
Identifier of the cancelled verification order (UUID).
string
Resulting status.
CANCELLED on success.string
Human-readable confirmation message.
If the order does not exist, the response is
{ "error": "Order not found", "orderId": "<id>" }. If cancellation fails, the response is { "error": "<reason>", "orderId": "<id>" }.Example Request
curl -sS -X DELETE "https://sandbox.theary.ai/background-check/v1/orders/550e8400-e29b-41d4-a716-446655440000" \
-H "Authorization: Bearer YOUR_JWT_TOKEN" \
-H "Accept: application/json"
const orderId = '550e8400-e29b-41d4-a716-446655440000'
const response = await fetch(`/background-check/v1/orders/${orderId}`, {
method: 'DELETE',
headers: {
Authorization: 'Bearer YOUR_JWT_TOKEN',
'Content-Type': 'application/json',
},
})
const result = await response.json()
import requests
order_id = "550e8400-e29b-41d4-a716-446655440000"
headers = {
'Authorization': 'Bearer YOUR_JWT_TOKEN',
'Content-Type': 'application/json'
}
response = requests.delete(
f'https://sandbox.theary.ai/background-check/v1/orders/{order_id}',
headers=headers
)
result = response.json()
Example Response
{
"success": true,
"orderId": "550e8400-e29b-41d4-a716-446655440000",
"status": "CANCELLED",
"message": "Order and associated searches cancelled successfully"
}
Order not found
{
"error": "Order not found",
"orderId": "550e8400-e29b-41d4-a716-446655440000"
}
Path Parameters
Response
200 - application/json
The response is of type object.