Skip to content
New

Person Report API and New Zealand identity checks are now live.

See what's newarrow_forward
WatchEyeOnboarding & monitoring

Customer onboarding, screening and ongoing monitoring in one system, with real-time KYC and KYB alerts when a customer's risk changes.

Visit WatchEyearrow_forwardcheck_circleIncluded in the Global Data Portal
IDFEX ID CheckIdentity verification

One-to-one identity, document and data checks against the DVS and Australian data sources, run from the Portal or by API.

Visit IDFEX ID Checkarrow_forwardcheck_circleIncluded in the Global Data Portal
ID PassSelf-service verification

Customers verify their own identity and biometrics from a link on their phone. The result comes back to you, and they keep control of their data.

Visit ID Passarrow_forwardcheck_circleIncluded in the Global Data Portal
InsiightData quality

Verifies, corrects and enriches customer records so they stay accurate — one at a time or across your whole database.

Visit Insiightarrow_forwardcheck_circleIncluded in the Global Data Portal
Australian Death CheckDeceased data

The official national death data source. Match your records against it to find and remove deceased individuals.

Visit Australian Death Checkarrow_forwardcheck_circleIncluded in the Global Data Portal
QuesterMarketing lists

Build targeted, privacy-compliant Australian marketing lists with smart filters. Pay only for the records you download.

Visit Questerarrow_forwardcheck_circleIncluded in the Global Data Portal
verified_userVerify Identities7 solutions

Confirm a person or business is who they claim to be: government IDs, biometrics, business registries and employment checks against authoritative Australian sources.

All solutionsarrow_forwardcheck_circleAvailable in the Portal and by API
policy_alertScreen & Monitor7 solutions

Meet AUSTRAC obligations and understand customer risk: screening, risk assessment, fraud controls and investigation tools with evidence recorded for each check.

All solutionsarrow_forwardcheck_circleAvailable in the Portal and by API
databaseImprove your data3 solutions

Keep customer records accurate and put them to work: correct and enrich existing data, unify it into a single view, or build compliant marketing lists from opted-in records.

All solutionsarrow_forwardcheck_circleAvailable in the Portal and by API
monitoringWatchEye API14 categories

The WatchEye API gives programmatic access to everything in WatchEye: PEP and sanctions screening, identity checks, IDPass verifications, monitoring programs, events and reports.

View allarrow_forwardcheck_circleSandbox environment for integration testing
policyAML & screening5 use cases

Obligations under the AML/CTF Act, from screening at onboarding through to ongoing monitoring — with the evidence for each check recorded.

All use casesarrow_forwardcheck_circleMapped to the products and data that cover it
how_to_regOnboarding & identity3 use cases

Verifying who a customer, employee or account holder is — at sign-up and during ongoing checks — against authoritative Australian sources.

All use casesarrow_forwardcheck_circleMapped to the products and data that cover it
databaseData & enrichment4 use cases

Keeping customer records accurate, current and complete: validate contact detail, fill the gaps, locate people and remove deceased records.

All use casesarrow_forwardcheck_circleMapped to the products and data that cover it
Global Data
Portalarrow_forward
Productsexpand_more
Solutionsexpand_more
Use casesexpand_more
Dataexpand_more
APIarrow_forwardIndustriesarrow_forwardResourcesarrow_forwardAboutarrow_forwardContactarrow_forward Request a Demo
Talk to the team

9am–5pm AEST, Monday to Friday.

call03 9948 4089
WatchEye · Monitors

Update a monitor

Updating a monitor uses PATCH semantics: only the fields you send change. The configuration is merged key by key, so a single threshold can change without restating the rest. The operation type is fixed at creation, and a monitor that is mid-run cannot be updated until the run finishes.

  • Change a schedule, a threshold or a name without restating the monitor
  • Pause and resume a monitor by setting its status
For developers

After the technical detail?

For the technical detail, go to the API documentation. It holds the request and response schema, the integration guides and the error codes for this endpoint.

  • Request and response schema
  • Fields, partial config updates and restrictions
Go to the API docs

New accounts begin with sandbox access.

ISO 27001 certified Handled under Australian privacy law Every API call written to the audit log
What the check gives you

Tuning ongoing screening without rebuilding it

A threshold that raises too many false positives, a schedule that should move to weekdays, a monitor that should stop while a data issue is fixed: each is one PATCH, and the response carries the monitor as it now stands.

Only what you sent has changed

Name, status, schedule and configuration are all optional. Configuration keys you do not supply are preserved, and only the keys you send are validated.

What cannot change

The operation type is fixed; a different operation means deleting the monitor and creating a new one. A monitor with a process status of pending, processing or paused is mid-run and returns 409 until the run finishes.

Whether it runs

A status of paused stops scheduled and on-demand runs while the monitor, its configuration and its history stay visible. Active resumes them.

How a check runs

The lifecycle a monitor moves through

A monitor is created active, can be paused and resumed with this endpoint, and is soft-deleted rather than destroyed. It has no archive state.

Set status back to active to resume a paused monitor.

What it costs

Charged when screening runs, not when records are managed

Charges arise when screening runs against the entities in a program: each check type launched against an entity is charged at launch, and a monitor run is charged for each entity eligible for its operation. Rates are set for your account and communicated by your Global Data account manager, and statements with a per-call breakdown are in the WatchEye portal.

  • Billed per screening operation
  • Refunded if the provider fails
How billing works
Credits drawn down against your account balance
  • A screening check is charged per check type when it is launched, and refunded if the provider fails.
  • A monitor run bills only for the entities eligible for its operation; a UK check skips businesses outside the UK, for example.
  • A run that would exceed the account's credit is refused with 402 and a billing breakdown, before anything is queued.
  • Reads, lists and PDF downloads are not billed.
Talk to us about rates
Related checks

Others in WatchEye Monitors

Show a monitor reads the result. Create a monitor starts a new one when the operation must change. Delete a monitor retires one. Run a monitor on demand re-screens everything after a configuration change.

Questions

Questions we get asked about updating a monitor

Do we need a developer to implement this?
Yes. This is a single REST PATCH by UUID, so a developer wires it to whatever tunes screening in your system. A sandbox account is available for development at no charge. It is a separate account with its own API keys, it returns test data in the same response shapes as live, and the same base URL serves both environments.
What does our system need to send?
The monitor UUID in the path and any of: monitor name, status of active or paused, schedule, and a config object with the keys to change. All fields are optional.
What schedules are available?
Manual, which never runs on its own; every day; weekdays; weekends; a single weekday from Monday to Sunday; the first of the month; the fifteenth; the first and fifteenth; or quarterly. A manual monitor is triggered with Run a monitor on demand.
What goes in the configuration?
Whatever the chosen operation expects. A PEP and sanction monitor takes a search type, a similarity threshold, PEP and sanction country lists, a maximum number of results and whether extended results are included. A business check takes name matching and the signals that raise an alert. Court, banned and disqualified, UK business, real estate, ADC, adverse media, email and phone monitors each have their own keys. The monitor configuration guide lists every key, its allowed values and its default.
What comes back?
A 200 with the monitor as it now stands, in the same shape as Show a monitor. A 409 if the monitor is mid-run.
How do we change the operation a monitor runs?
You cannot. Delete the monitor and create a new one with the operation you need.
What if the monitor has been deleted?
Soft-deleted records return 404 from this endpoint and are no longer returned by the list. They remain in the database for compliance and audit purposes and can be restored in the portal within 30 days by a user with the account manager role.
How many calls can we make?
The default rate limit is 600 requests per minute, enforced in a 60-second fixed window. Requests over the limit receive a 429 response, so pace requests evenly and back off before retrying. A higher limit can be arranged on a case-by-case basis.
Getting started

The first step to access is a conversation

Sandbox accounts are provisioned by your Global Data account manager. API keys are created and managed in the WatchEye portal, and the same endpoints serve sandbox and live; the account behind the key decides which environment you are in.

Call 03 9948 4089, 9am–5pm AEST Monday to Friday

ISO 27001 certified
Handled under Australian privacy law
Every API call written to the audit log