Skip to main content
GET
https://api.theary.ai
/
background-check
/
v1
/
batches
/
{id}
Get Batch
curl --request GET \
  --url https://api.theary.ai/background-check/v1/batches/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "status": "<string>",
  "orderCount": 123,
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "createdBy": "<string>",
  "entityName": "<string>"
}

​
Get Background Check Batch

Retrieves details of a specific background check batch including its current status and associated information.

​
Path Parameters

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

​
Response

Returns detailed information about the specified background check batch.
​
id
string
Unique identifier of the background check batch (UUID format)
​
status
string
Current status of the batch (e.g., pending, processing, completed, failed)
​
orderCount
number
Number of orders in this batch
​
createdAt
string
Timestamp when the batch was created (ISO 8601 format)
​
updatedAt
string
Timestamp when the batch was last updated (ISO 8601 format)
​
createdBy
string
User or system that created the batch
​
entityName
string
Name of the entity associated with this batch

​
Example Request

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

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "completed",
  "orderCount": 25,
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-16T14:45:00Z",
  "createdBy": "user_123",
  "entityName": "Apple Inc."
}