Recurring checks
List monitored subjects
Scope: monitoring:read
The recurring checks set up in your workspace.
AuthorizationBearer <token>
Use Authorization: Bearer vrf_live_... or vrf_test_....
In: header
Query Parameters
page?integer
Zero-based page number. The first page is 0.
Range
0 <= valueDefault
0size?integer
Records per page. Large values are capped.
Range
1 <= value <= 200Default
20search?string
Free-text search. Supported fields vary by resource.
sortBy?string
Sort key. An unsupported key falls back to the endpoint's default order.
sortDirection?string
Sort direction.
Default
"asc"Value in
- "asc"
- "desc"
Response Body
application/json
curl -X GET "https://example.com/api/v1/monitoring?page=0&size=20&sortBy=createdAt"{ "items": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "subject": { "subjectType": "INDIVIDUAL", "fullName": "Jane Doe", "firstName": "string", "middleName": "string", "lastName": "string", "idNumber": "36901234", "registrationNumber": "PVT-7XUQ8KL", "email": "user@example.com", "phone": "+254712345678", "dateOfBirth": "2019-08-24", "country": "KE" }, "checkNames": [ "ACADEMIC_VERIFY" ], "cadence": "string", "status": "ACTIVE", "nextRunAt": "2019-08-24T14:15:22Z", "recentAlerts": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "title": "string", "message": "string", "severity": "LOW", "read": true, "actioned": true, "reportId": "836df459-dc40-4aa1-972a-6eb0a864dff9", "createdAt": "2019-08-24T14:15:22Z" } ] } ], "page": 0, "size": 20, "totalItems": 42, "totalPages": 3, "hasNext": true, "hasPrevious": true}