Monitoring

Monitoring continuously checks an enrolled candidate against our monitored data sets on a daily basis. If a hit is found, Yardstik automatically generates a report and processes it through the standard background check flow, including any configured adverse action workflow.

Currently-available monitor types:
- Sex Offender Registry (SOR)

Use these endpoints to enroll a candidate, list and inspect existing monitors, and unenroll a candidate when monitoring is no longer needed.

Enrollment requires evergreen candidate consent and full candidate data (name, date of birth, and current address). Monitor account package IDs are configured for your account by Yardstik during onboarding — reach out to support@yardstik.com if you need to know which monitor account packages are available to you.

When a monitor generates a report, the report will include a monitor object pointing back to the monitor that produced it. See the Reports section.

List monitors

Retrieve a paginated list of monitors on your account. See Pagination.

SecurityApiKey
Request
query Parameters
page
integer

The page number to retrieve.

per_page
integer

The maximum number of results per page.

object

Filter the listing by candidate, email, or status.

Examples:
query[candidate_id_eq]=a1b2c3d4-e5f6-7890-abcd-ef1234567890
query[candidate_email_eq]=candidate@example.com
query[status_eq]=active
Responses
200

List of monitors.

401

Unauthorized

get/monitoring/monitors
Request samples 
Response samples 
application/json
{
  • "object": "list",
  • "meta": {
    },
  • "data": [
    ]
}
Enroll a candidate in monitoring
Enroll a candidate in continuous monitoring against the specified monitor account package.


Before enrolling, the candidate must satisfy all of the following:


    

  • Belong to your account.
    • 

  • Have evergreen consent on file (either evergreen: true on the candidate, or account_candidate_consented_evergreen: true set when the candidate was created).
    • 

  • Have a first_name, last_name, date_of_birth, and a current address on file.
    • 

  • Be 18 years of age or older.
    • 

  • For candidates with a California address, your account must be configured with either Prop 22 or AB-506; otherwise enrollment is blocked.

    
A candidate can only be enrolled in a given monitor account package once at a time. Re-enrolling while an active monitor already exists returns 422. After a monitor has been unenrolled, the candidate may be enrolled again.

    
On successful enrollment, Yardstik immediately performs the first search. If a potential match is found, a report is generated and processed through the standard background check flow.

    
Monitor account package IDs are configured for your account by Yardstik during onboarding. Reach out to support@yardstik.com if you need to know which monitor account packages are available to you.
    • 



SecurityApiKey 
Request 
Request Body schema: application/json
required
candidate_id
required
string <uuid> 
Unique identifier for the candidate to enroll.


 
monitor_account_package_id
required
string <uuid> 
Unique identifier for the monitor account package to enroll under. Provisioned during onboarding by Yardstik.


 
Responses 
201
The candidate was enrolled successfully.


401
Unauthorized


422
Unprocessable Entity


post/monitoring/monitors
Request samples 
application/json
{
  • "candidate_id": "2f28f791-f0fd-4155-a356-c24e996beeda",
  • "monitor_account_package_id": "91f10237-3fb8-40c1-8edc-74cb0647d974"
}
Response samples 
application/json
{
  • "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  • "status": "active",
  • "deactivated_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "candidate": {
    },
  • "monitor_account_package": {
    },
  • "reports": [
    ]
}
Get a monitor
Retrieve a single monitor by its id. The response includes the candidate, the monitor account package the candidate is enrolled under, and a list of any reports that have been generated by this monitor.


SecurityApiKey 
Request 
path Parameters
id
required
string <uuid> 
The unique identifier of the monitor.


 
Responses 
200
The monitor.


401
Unauthorized


404
Not Found


get/monitoring/monitors/{id}
Request samples 
Response samples 
application/json
{
  • "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  • "status": "active",
  • "deactivated_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "candidate": {
    },
  • "monitor_account_package": {
    },
  • "reports": [
    ]
}
Unenroll a monitor
Unenroll a candidate from monitoring. The monitor will transition to inactive and Yardstik will stop running daily searches. The monitor record is preserved for historical reference and returned in the response.


If the monitor is already inactive, this endpoint returns the monitor unchanged with a 200 response.


Note: this is implemented as a deactivation, not a hard delete — it returns 200 with the updated monitor body, not 204.


SecurityApiKey 
Request 
path Parameters
id
required
string <uuid> 
The unique identifier of the monitor to unenroll.


 
Responses 
200
The monitor was unenrolled (or was already inactive).


401
Unauthorized


404
Not Found


delete/monitoring/monitors/{id}
Request samples 
Response samples 
application/json
{
  • "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  • "status": "active",
  • "deactivated_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "candidate": {
    },
  • "monitor_account_package": {
    },
  • "reports": [
    ]
}
➔ Next to Groups