Ongoing Monitoring
Last updated
Last updated
The Ongoing Monitoring API allows you to manage and retrieve updates for continuous background checks. When ongoing monitoring is enabled during a verification request (enableOngoingMonitoring: true), the system monitors the individual on a daily basis to identify new PEP & Sanctions, Adverse Media, or Watchlist events. Alerts are sent to the subscribed return URL whenever there is a status change, and results can be retrieved using the relevant endpoints.
Endpoint:
GET /api/v1/ongoingmonitoring/{correlationId}
Description:
Retrieves the verification statuses and results for a specific ongoing monitoring record using the correlationId provided during the initial verification request.
Path parameters:
correlationId (string, required): The unique ID associated with the monitoring request.
Query Parameters:
fromDate (date-time, optional): Filter results starting from this date.
toDate (date-time, optional): Filter results up to this date.
Endpoint:
POST /api/v1/ongoingmonitoring/subscribe
Description:
Subscribes to the ongoing monitoring service by registering a return URL and API key. This URL will receive webhook notifications for updates in monitored results.
Endpoint:
POST /api/v1/ongoingmonitoring/unsubscribe
Description:
Unsubscribes the provided return URL from ongoing monitoring. After unsubscribing, you will no longer receive updates for monitored profiles.
GET /api/v1/ongoingmonitoring/{correlationId} HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
[
{
"correlationId": "123e4567-e89b-12d3-a456-426614174000",
"externalReferenceId": "text",
"checkStatuses": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"checkTypeId": 1,
"externalCheckReferenceId": "text",
"status": {
"id": 1,
"status": "text"
},
"resultCount": {
"totalSourcesChecked": 1,
"totalSourcesPassed": 1,
"totalSourcesFailed": 1,
"totalSourcesForReview": 1
},
"matchesRequired": 1,
"sourceResults": {
"id": 1,
"date": "2025-05-04T07:30:37.271Z",
"rule": "text",
"ruleId": 1,
"status": {
"id": 1,
"status": "text"
},
"result": {
"id": 1,
"result": "text"
},
"title": "text",
"summaryTitle": "text",
"summary": [
{
"id": 1,
"key": "text",
"value": "text"
}
],
"results": [
{
"id": 1,
"title": "text",
"description": "text",
"result": "text",
"recordedDate": "text",
"detail": {
"reasons": [
{
"id": 1,
"key": "text",
"result": "text",
"reason": "text",
"code": "text",
"metaData": {
"sourceName": "text",
"sourceOriginName": "text",
"title": "text",
"date": "text",
"name": "text",
"dob": [
"text"
],
"matchScore": 1,
"riskScore": 1,
"gender": "text",
"relations": [
{
"relationType": "text",
"entityName": "text"
}
],
"positions": [
{
"position": "text",
"fromYear": "text",
"toYear": "text"
}
],
"aliases": [
{
"type": "text",
"name": "text"
}
],
"regNumber": "text",
"branch": "text",
"address": "text",
"currentStatus": "text",
"incorporationDate": "text",
"dissolutionDate": "text",
"type": "text",
"officers": [
{
"id": 1,
"name": "text",
"position": "text",
"startDate": "text",
"endDate": "text",
"status": "text",
"address": "text"
}
],
"parentCompanyInfo": {
"companyName": "text",
"countryCode": "text",
"regNumber": "text"
},
"primaryCompanyInfo": {
"companyName": "text",
"countryCode": "text",
"regNumber": "text"
},
"filings": {
"lastFilingDate": "text",
"filingType": {
"filingTypeCode": "text",
"filingTypeDescription": "text"
}
},
"officerId": "text",
"position": "text",
"startDate": "text",
"endDate": "text",
"actedCompany": "text",
"actedRegNumber": "text",
"country": "text",
"state": "text"
}
}
]
}
}
],
"resultsExcludedByFilters": [
{
"id": 1,
"title": "text",
"description": "text",
"recordedDate": "text",
"detail": {
"reasons": [
{
"id": 1,
"key": "text",
"result": "text",
"reason": "text",
"code": "text",
"metaData": {
"sourceName": "text",
"sourceOriginName": "text",
"title": "text",
"date": "text",
"name": "text",
"dob": [
"text"
],
"matchScore": 1,
"riskScore": 1,
"gender": "text",
"relations": [
{
"relationType": "text",
"entityName": "text"
}
],
"positions": [
{
"position": "text",
"fromYear": "text",
"toYear": "text"
}
],
"aliases": [
{
"type": "text",
"name": "text"
}
],
"regNumber": "text",
"branch": "text",
"address": "text",
"currentStatus": "text",
"incorporationDate": "text",
"dissolutionDate": "text",
"type": "text",
"officers": [
{
"id": 1,
"name": "text",
"position": "text",
"startDate": "text",
"endDate": "text",
"status": "text",
"address": "text"
}
],
"parentCompanyInfo": {
"companyName": "text",
"countryCode": "text",
"regNumber": "text"
},
"primaryCompanyInfo": {
"companyName": "text",
"countryCode": "text",
"regNumber": "text"
},
"filings": {
"lastFilingDate": "text",
"filingType": {
"filingTypeCode": "text",
"filingTypeDescription": "text"
}
},
"officerId": "text",
"position": "text",
"startDate": "text",
"endDate": "text",
"actedCompany": "text",
"actedRegNumber": "text",
"country": "text",
"state": "text"
},
"excludedReasons": [
"text"
]
}
]
}
}
]
},
"result": {
"id": 1,
"result": "text"
}
}
],
"overallResult": {
"id": 1,
"result": "text"
},
"overallStatus": {
"id": 1,
"status": "text"
}
}
]POST /api/v1/ongoingmonitoring/unsubscribe HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
{
"correlationId": "123e4567-e89b-12d3-a456-426614174000",
"externalReferenceId": "text",
"checkStatuses": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"checkTypeId": 1,
"externalCheckReferenceId": "text",
"status": {
"id": 1,
"status": "text"
},
"resultCount": {
"totalSourcesChecked": 1,
"totalSourcesPassed": 1,
"totalSourcesFailed": 1,
"totalSourcesForReview": 1
},
"matchesRequired": 1,
"sourceResults": {
"id": 1,
"date": "2025-05-04T07:30:37.271Z",
"rule": "text",
"ruleId": 1,
"status": {
"id": 1,
"status": "text"
},
"result": {
"id": 1,
"result": "text"
},
"title": "text",
"summaryTitle": "text",
"summary": [
{
"id": 1,
"key": "text",
"value": "text"
}
],
"results": [
{
"id": 1,
"title": "text",
"description": "text",
"result": "text",
"recordedDate": "text",
"detail": {
"reasons": [
{
"id": 1,
"key": "text",
"result": "text",
"reason": "text",
"code": "text",
"metaData": {
"sourceName": "text",
"sourceOriginName": "text",
"title": "text",
"date": "text",
"name": "text",
"dob": [
"text"
],
"matchScore": 1,
"riskScore": 1,
"gender": "text",
"relations": [
{
"relationType": "text",
"entityName": "text"
}
],
"positions": [
{
"position": "text",
"fromYear": "text",
"toYear": "text"
}
],
"aliases": [
{
"type": "text",
"name": "text"
}
],
"regNumber": "text",
"branch": "text",
"address": "text",
"currentStatus": "text",
"incorporationDate": "text",
"dissolutionDate": "text",
"type": "text",
"officers": [
{
"id": 1,
"name": "text",
"position": "text",
"startDate": "text",
"endDate": "text",
"status": "text",
"address": "text"
}
],
"parentCompanyInfo": {
"companyName": "text",
"countryCode": "text",
"regNumber": "text"
},
"primaryCompanyInfo": {
"companyName": "text",
"countryCode": "text",
"regNumber": "text"
},
"filings": {
"lastFilingDate": "text",
"filingType": {
"filingTypeCode": "text",
"filingTypeDescription": "text"
}
},
"officerId": "text",
"position": "text",
"startDate": "text",
"endDate": "text",
"actedCompany": "text",
"actedRegNumber": "text",
"country": "text",
"state": "text"
}
}
]
}
}
],
"resultsExcludedByFilters": [
{
"id": 1,
"title": "text",
"description": "text",
"recordedDate": "text",
"detail": {
"reasons": [
{
"id": 1,
"key": "text",
"result": "text",
"reason": "text",
"code": "text",
"metaData": {
"sourceName": "text",
"sourceOriginName": "text",
"title": "text",
"date": "text",
"name": "text",
"dob": [
"text"
],
"matchScore": 1,
"riskScore": 1,
"gender": "text",
"relations": [
{
"relationType": "text",
"entityName": "text"
}
],
"positions": [
{
"position": "text",
"fromYear": "text",
"toYear": "text"
}
],
"aliases": [
{
"type": "text",
"name": "text"
}
],
"regNumber": "text",
"branch": "text",
"address": "text",
"currentStatus": "text",
"incorporationDate": "text",
"dissolutionDate": "text",
"type": "text",
"officers": [
{
"id": 1,
"name": "text",
"position": "text",
"startDate": "text",
"endDate": "text",
"status": "text",
"address": "text"
}
],
"parentCompanyInfo": {
"companyName": "text",
"countryCode": "text",
"regNumber": "text"
},
"primaryCompanyInfo": {
"companyName": "text",
"countryCode": "text",
"regNumber": "text"
},
"filings": {
"lastFilingDate": "text",
"filingType": {
"filingTypeCode": "text",
"filingTypeDescription": "text"
}
},
"officerId": "text",
"position": "text",
"startDate": "text",
"endDate": "text",
"actedCompany": "text",
"actedRegNumber": "text",
"country": "text",
"state": "text"
},
"excludedReasons": [
"text"
]
}
]
}
}
]
},
"result": {
"id": 1,
"result": "text"
}
}
],
"overallResult": {
"id": 1,
"result": "text"
},
"overallStatus": {
"id": 1,
"status": "text"
}
}Subscriber Request Model
Request Url
Api Key
POST /api/v1/ongoingmonitoring/subscribe HTTP/1.1
Host:
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 36
{
"returnUrl": "text",
"apiKey": "text"
}{
"correlationId": "123e4567-e89b-12d3-a456-426614174000",
"externalReferenceId": "text",
"checkStatuses": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"checkTypeId": 1,
"externalCheckReferenceId": "text",
"status": {
"id": 1,
"status": "text"
},
"resultCount": {
"totalSourcesChecked": 1,
"totalSourcesPassed": 1,
"totalSourcesFailed": 1,
"totalSourcesForReview": 1
},
"matchesRequired": 1,
"sourceResults": {
"id": 1,
"date": "2025-05-04T07:30:37.271Z",
"rule": "text",
"ruleId": 1,
"status": {
"id": 1,
"status": "text"
},
"result": {
"id": 1,
"result": "text"
},
"title": "text",
"summaryTitle": "text",
"summary": [
{
"id": 1,
"key": "text",
"value": "text"
}
],
"results": [
{
"id": 1,
"title": "text",
"description": "text",
"result": "text",
"recordedDate": "text",
"detail": {
"reasons": [
{
"id": 1,
"key": "text",
"result": "text",
"reason": "text",
"code": "text",
"metaData": {
"sourceName": "text",
"sourceOriginName": "text",
"title": "text",
"date": "text",
"name": "text",
"dob": [
"text"
],
"matchScore": 1,
"riskScore": 1,
"gender": "text",
"relations": [
{
"relationType": "text",
"entityName": "text"
}
],
"positions": [
{
"position": "text",
"fromYear": "text",
"toYear": "text"
}
],
"aliases": [
{
"type": "text",
"name": "text"
}
],
"regNumber": "text",
"branch": "text",
"address": "text",
"currentStatus": "text",
"incorporationDate": "text",
"dissolutionDate": "text",
"type": "text",
"officers": [
{
"id": 1,
"name": "text",
"position": "text",
"startDate": "text",
"endDate": "text",
"status": "text",
"address": "text"
}
],
"parentCompanyInfo": {
"companyName": "text",
"countryCode": "text",
"regNumber": "text"
},
"primaryCompanyInfo": {
"companyName": "text",
"countryCode": "text",
"regNumber": "text"
},
"filings": {
"lastFilingDate": "text",
"filingType": {
"filingTypeCode": "text",
"filingTypeDescription": "text"
}
},
"officerId": "text",
"position": "text",
"startDate": "text",
"endDate": "text",
"actedCompany": "text",
"actedRegNumber": "text",
"country": "text",
"state": "text"
}
}
]
}
}
],
"resultsExcludedByFilters": [
{
"id": 1,
"title": "text",
"description": "text",
"recordedDate": "text",
"detail": {
"reasons": [
{
"id": 1,
"key": "text",
"result": "text",
"reason": "text",
"code": "text",
"metaData": {
"sourceName": "text",
"sourceOriginName": "text",
"title": "text",
"date": "text",
"name": "text",
"dob": [
"text"
],
"matchScore": 1,
"riskScore": 1,
"gender": "text",
"relations": [
{
"relationType": "text",
"entityName": "text"
}
],
"positions": [
{
"position": "text",
"fromYear": "text",
"toYear": "text"
}
],
"aliases": [
{
"type": "text",
"name": "text"
}
],
"regNumber": "text",
"branch": "text",
"address": "text",
"currentStatus": "text",
"incorporationDate": "text",
"dissolutionDate": "text",
"type": "text",
"officers": [
{
"id": 1,
"name": "text",
"position": "text",
"startDate": "text",
"endDate": "text",
"status": "text",
"address": "text"
}
],
"parentCompanyInfo": {
"companyName": "text",
"countryCode": "text",
"regNumber": "text"
},
"primaryCompanyInfo": {
"companyName": "text",
"countryCode": "text",
"regNumber": "text"
},
"filings": {
"lastFilingDate": "text",
"filingType": {
"filingTypeCode": "text",
"filingTypeDescription": "text"
}
},
"officerId": "text",
"position": "text",
"startDate": "text",
"endDate": "text",
"actedCompany": "text",
"actedRegNumber": "text",
"country": "text",
"state": "text"
},
"excludedReasons": [
"text"
]
}
]
}
}
]
},
"result": {
"id": 1,
"result": "text"
}
}
],
"overallResult": {
"id": 1,
"result": "text"
},
"overallStatus": {
"id": 1,
"status": "text"
}
}