Monitoring
Create a recurring monitoring rule
Scope: monitoring:write
Re-runs the selected checks against a subject on a fixed cadence and raises an alert when a result changes. Each run is billable at the normal per-check price.
AuthorizationBearer <token>
Use Authorization: Bearer vrf_live_... or vrf_test_....
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/api/v1/monitoring" \ -H "Content-Type: application/json" \ -d '{ "subject": { "subjectType": "INDIVIDUAL", "fullName": "Jane Wanjiku Doe", "idNumber": "36901234" }, "checkNames": [ "CRB_STANDARD" ], "cadence": "MONTHLY" }'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "subject": { "subjectType": "INDIVIDUAL", "fullName": "Jane Wanjiku 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": [ "IDENTITY" ], "cadence": "string", "status": "ACTIVE", "nextRunAt": "2019-08-24T14:15:22Z", "recentAlerts": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "title": "string", "message": "string", "severity": "INFO", "read": true, "actioned": true, "reportId": "836df459-dc40-4aa1-972a-6eb0a864dff9", "createdAt": "2019-08-24T14:15:22Z" } ]}