Ongoing Monitoring

Overview

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.

Retrieving monitoring results

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.

GET - Get monitoring verification statuses and result for a verification process

get

Authorizations

Bearer

AuthorizationstringRequired

JWT Authorization header using the Bearer scheme. Example: "Authorization: bearer {token}". You authenticate to the Tiller WealthXcel Verification API by providing your bearer token in the request header. Tiller WealthXcel Verification API requires the use of an access token used for requests made to the server side.

Path parameters

correlationIdstring · uuidRequired

Query parameters

fromDatestring · date-timeOptional

toDatestring · date-timeOptional

Responses

200

Ok request

application/json

400

Missing/invalid values

application/json

404

Verification result not found

application/json

500

Internal server error

get

/api/v1/ongoingmonitoring/{correlationId}

HTTPcURLJavaScriptPython

GET /api/v1/ongoingmonitoring/{correlationId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
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-12-13T13:00:57.355Z",
          "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"
    }
  }
]

Subcribing to the Monitoring Service

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.

Post - add / update subscription

post

Authorizations

Bearer

AuthorizationstringRequired

JWT Authorization header using the Bearer scheme. Example: "Authorization: bearer {token}". You authenticate to the Tiller WealthXcel Verification API by providing your bearer token in the request header. Tiller WealthXcel Verification API requires the use of an access token used for requests made to the server side.

Body

application/json

Subscriber Request Model

returnUrlstring | nullableOptional

Request Url

apiKeystring | nullableOptional

Api Key

Responses

200

OK

application/json

303

See Other

400

Bad Request

application/json

408

Request Timeout

application/json

500

Internal Server Error

post

/api/v1/ongoingmonitoring/subscribe

HTTPcURLJavaScriptPython

POST /api/v1/ongoingmonitoring/subscribe HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
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-12-13T13:00:57.355Z",
        "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"
  }
}

Unsubscribe from the Monitoring Service

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.

Unsubscribe the subscription

post

Authorizations

Bearer

AuthorizationstringRequired

JWT Authorization header using the Bearer scheme. Example: "Authorization: bearer {token}". You authenticate to the Tiller WealthXcel Verification API by providing your bearer token in the request header. Tiller WealthXcel Verification API requires the use of an access token used for requests made to the server side.

Responses

200

OK

application/json

303

See Other

400

Bad Request

application/json

408

Request Timeout

application/json

500

Internal Server Error

post

/api/v1/ongoingmonitoring/unsubscribe

HTTPcURLJavaScriptPython

POST /api/v1/ongoingmonitoring/unsubscribe HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
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-12-13T13:00:57.355Z",
        "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"
  }
}