Skip to main content
GET
/
background-check
/
v1
/
batches
List Batches
curl --request GET \
  --url https://sandbox.theary.com/background-check/v1/batches
{
  "batches": [
    {}
  ],
  "pagination": {},
  "message": "<string>",
  "note": "<string>"
}

​
List Background Check Batches

Placeholder implementation. The API does not persist batch entities. The response always includes an empty batches array and notes that orders should be tracked individually.

​
Request

​
page
string
Page number (default 1). Accepted for API compatibility; does not change placeholder behavior.
​
limit
string
Page size (default 10). Accepted for API compatibility.

​
Response

​
batches
array
Always empty in the current implementation.
​
pagination
object
Pagination object (page, limit, total, totalPages, hasNext, hasPrev). total is 0.
​
message
string
Explains that batch tracking is not yet implemented.
​
note
string
Directs you to order endpoints for status.

​
Example Request

curl -X GET "https://sandbox.theary.com/background-check/v1/batches?page=1&limit=20" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json"

​
Example Response

{
  "batches": [],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 0,
    "totalPages": 0,
    "hasNext": false,
    "hasPrev": false
  },
  "message": "Batch tracking not yet implemented - orders are processed individually",
  "note": "Use individual order endpoints to track order status"
}

​
What to use instead