List screening records that are monitored

Retrieves a list of individuals currently being monitored for screening. This includes basic metadata like name, ID, and optionally the last updated date.

Parameters:

  • companyKey (string, required) - The company's secret key.
  • start (integer, optional) – The number of items to skip from the beginning of the results.
  • limit (integer, optional) – The maximum number of records to return.
  • date (string, optional, ISO 8601 format) – Filters records after a specific date. If no date is provided, the entire list will be returned.
post/list-screening-monitoring-records

Request body

companyKeystring
startnumber
limitnumber

Example request

{
  "companyKey": "your-company-secret-key",
  "start": 0,
  "limit": 50
}

Response

Success

Example response

{
  "result": {
    "start": 0,
    "limit": 50,
    "total": 4,
    "data": [
      {
        "fullName": "John Smith1",
        "id": "64ad3b14090678e34512eab8"
      },
      {
        "fullName": "John Smith2",
        "id": "64ad3ef45fcf054afc73ebb4",
        "lastUpdatedDate": "2023-07-01T10:50:42.389Z"
      },
      {
        "fullName": "John Smith3",
        "id": "64ad3f3a8b3f54aca29fc0a2",
        "lastUpdatedDate": "2023-07-20T10:50:42.389Z"
      },
      {
        "fullName": "John Smith4",
        "id": "64ad3f3a8b3f54aca29fc0a3"
      }
    ]
  }
}