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

​
Get Background Check Batch

Placeholder implementation. There is no stored batch entity for id. The response explains that batch tracking is not implemented and points you to order endpoints.

​
Path Parameters

​
id
string
required
Path parameter echoed back as batchId (not looked up in a database).

​
Response

​
batchId
string
Same as the path id
​
message
string
Explains placeholder behavior
​
note
string
Use individual order endpoints to track orders

​
Example Request

curl -X GET "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

{
  "batchId": "550e8400-e29b-41d4-a716-446655440000",
  "message": "Batch tracking not yet implemented - orders are processed individually",
  "note": "Use individual order endpoints to track order status"
}

​
See also