Batches API — Monitors

The Batches API lets you create monitors — named collections of subjects that are periodically re-searched against criminal databases. Each monitor runs on a configurable schedule and stores results over time.

See Subjects for managing the individuals within a monitor.

Authentication

All requests require an API key passed as a header:

X-API-Key: your-api-key

Monitor Object

Field	Type	Description
id	Integer	Unique monitor identifier
status	String	Current status of the monitor (e.g., active, disabled)
title	String	Monitor name
description	String | null	Optional description
frequency	String	Run frequency code (e.g., month)
frequencyTitle	String	Human-readable frequency label
lastRunDate	DateTime | null	When the monitor last executed
nextRunDate	DateTime | null	When the monitor is next scheduled to run
createDate	DateTime	When the monitor was created

Frequency Values

Value	Description
day	Daily
week	Weekly
month	Monthly (default)

---

List Monitors

GET /batch/

Returns a paginated list of all monitors for the authenticated account.

Query Parameters

Parameter	Type	Default	Description
page	Integer	1	Page number
pageSize	Integer	25	Records per page
search	String	—	Filter monitors by title
orderBy	String	—	Sort field: createDate, lastRunDate, nextRunDate, title
orderDirection	String	asc	Sort direction: asc or desc

Response

{
  "success": true,
  "paging": {
    "size": 2,
    "num": 1,
    "hasMore": false
  },
  "data": [
    {
      "id": 101,
      "status": "active",
      "title": "Employee Background Checks",
      "description": "Monthly checks for all active employees",
      "frequency": "month",
      "frequencyTitle": "Monthly",
      "lastRunDate": "2026-03-01T00:00:00Z",
      "nextRunDate": "2026-04-01T00:00:00Z",
      "createDate": "2025-01-15T10:30:00Z"
    }
  ]
}

---

Create a Monitor

POST /batch/

Creates a new monitor.

Request Body

Field	Type	Required	Description
title	String	Yes	Name for the monitor
description	String	No	Optional description
frequency	String	No	Run frequency. Default: month
profile	String	No	Optional pre-configured search profile
options	Object	No	Search options applied to all subjects. Same structure as Search Options
clientRequestId	String (≤36)	No	Client-supplied correlation ID

Curl

curl -X POST "https://api.infocusinfo.com/batch/" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: your-api-key" \
  -d '{
  "title": "Employee Background Checks",
  "description": "Monthly checks for all active employees",
  "frequency": "month",
  "options": {
    "birthDate": {
      "includePartial": true
    }
  }
}'

IntelliJ HTTP Client

POST https://api.infocusinfo.com/batch/
Content-Type: application/json
X-API-Key: your-api-key

{
  "title": "Employee Background Checks",
  "description": "Monthly checks for all active employees",
  "frequency": "month",
  "options": {
    "birthDate": {
      "includePartial": true
    }
  }
}

Response

{
  "success": true,
  "message": "Batch was saved successfully.",
  "data": {
    "id": 101,
    "status": "active",
    "title": "Employee Background Checks",
    "description": "Monthly checks for all active employees",
    "frequency": "month",
    "frequencyTitle": "Monthly",
    "lastRunDate": null,
    "nextRunDate": "2026-04-01T00:00:00Z",
    "createDate": "2026-03-26T12:00:00Z"
  }
}

---

Get a Monitor

GET /batch/:id

Returns details for a specific monitor.

Path Parameters

Parameter	Type	Description
id	Integer	Monitor ID

Response Codes

Code	Description
200	Monitor returned successfully
400	Missing batch ID
404	Monitor not found

---

Update a Monitor

POST /batch/:id
PUT  /batch/:id

Both POST and PUT update an existing monitor. The request body is the same as Create a Monitor.

Curl

curl -X PUT "https://api.infocusinfo.com/batch/101" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: your-api-key" \
  -d '{
  "title": "Employee Background Checks — Quarterly",
  "frequency": "month"
}'

IntelliJ HTTP Client

PUT https://api.infocusinfo.com/batch/101
Content-Type: application/json
X-API-Key: your-api-key

{
  "title": "Employee Background Checks — Quarterly",
  "frequency": "month"
}

Response Codes

Code	Description
200	Monitor updated successfully
404	Monitor not found

---

Disable a Monitor

DELETE /batch/:id

Disables the monitor. Disabled monitors will no longer run on schedule.

Path Parameters

Parameter	Type	Description
id	Integer	Monitor ID

Response

{
  "success": true,
  "message": "Batch was disabled successfully."
}

Response Codes

Code	Description
200	Monitor disabled
400	Missing batch ID
404	Monitor not found