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 · Programs

Update a program

Updating a program uses PATCH semantics: only the fields you send change and everything else is left as it is. Pass null to clear an optional field. Pausing a program stops its monitors running while its entities and checks stay accessible; setting it back to active resumes them.

  • Change one setting without restating the rest
  • Pause and resume a program 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 and the event-grouping rule
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

Changing how a program runs without rebuilding it

Retention policies change, notification lists change, and sometimes a program needs to stop while something is investigated. A PATCH changes only what you name and returns the program as it now stands.

Only what you sent has changed

Fields you omit are untouched. A field sent as null is cleared. The response carries the full program after the change.

Whether monitors will run

A status of paused stops the program's monitors running while everything in it remains readable. A status of active resumes them.

A consistent event-grouping setting

Changing event grouping to separate requires a maximum separate events value in the same request. Changing it to grouped clears any stored maximum, and one sent with it is ignored.

How a check runs

The lifecycle a program moves through

A program is created active, can be paused and resumed with this endpoint, and is soft-deleted rather than destroyed.

Set status back to active to resume a paused program. Deletion is handled by Delete a program.

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 Programs

Show a program reads the result. Create a program starts one. Delete a program retires one. Update a monitor pauses a single monitor rather than the whole program.

Questions

Questions we get asked about updating a program

Do we need a developer to implement this?
Yes. This is a single REST PATCH by UUID, so a developer wires it to whatever changes a program's settings 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 program UUID in the path and any of: program name, status of active or paused, report emails, data retention months, event grouping with a maximum of separate events, and default risk level. All fields are optional; null clears an optional field.
What can a program be configured with?
A name of 2 to 255 characters; a status of active or paused; up to five report email addresses that receive event report notifications; data retention in months, one of 0, 1, 3, 6, 12, 24, 36, 48, 60, 72 or 84; event grouping of separate, capped by a maximum of 5 to 100 separate events per entity, or grouped into one event per entity; and a default risk level of low, medium or high that new entities are pre-filled with, or null to leave it unassigned.
What comes back?
A 200 with the program as it now stands, in the same shape as Show a program.
What happens to a paused program?
Its monitors do not run, on schedule or on demand, while its entities and checks remain accessible. Set the status back to active to resume.
What if the program 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