latestOpenAPI 3.0.32026-08-12367267.0 KB
cda4b2b11372
Set person on monitoring
Enable ongoing monitoring of a specific individual in screening databases. If the person is already on monitoring, an appropriate error will be returned.
Parameters:
- companyKey (string, required) - The company's secret key.
- query (object, required) – The parameters for querying the database.
- fullName (string, required) – The last name of the individual.
- birthdayTimeFrom (string, optional) – The start date and time of the birthday range in ISO 8601 format.
post/monitor-screening-query
Request body
Example request
{
"companyKey": "your-company-secret-key",
"query": {
"fullName": "John Doe",
"birthdayTimeFrom": "1982-12-12T00:00:00Z"
}
}Response
Success
Example response
{
"result": "64ad3b14090678e34512eab8"
}