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

Archive an entity

Archiving an entity takes it out of day-to-day workflows together with its checks, reports, events, notes and identification checks, while keeping every record fully readable through list and show endpoints. It is the documented alternative to deletion when compliance, audit or historical reporting still needs the record.

  • History kept and readable; monitor runs and default reports stop including the entity
  • Reversible with Unarchive an entity
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
  • Archive versus delete
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

Standing a record down without losing anything

A customer who has left, a supplier no longer used, an applicant who withdrew: none of these should keep being screened, and none of their history should disappear. Archiving is the state for that.

That monitoring has stopped

An archived entity is not included in monitor runs or default reports. The response carries the entity with its archived at timestamp set.

That nothing is hidden

The entity and its checks, reports, events, notes and identification checks remain visible through list and show endpoints, and the entities list can include or exclude them with the archived parameter.

That the call is safe to repeat

Archiving an entity that is already archived returns it in its current state without a new audit entry or a second cascade. An Idempotency-Key header is also accepted.

How a check runs

The lifecycle an entity moves through

An entity is created active, archived to stop monitoring while keeping history, unarchived to resume, and soft-deleted only when it should leave the working views.

Prefer archiving over deletion where the record must stay accessible for compliance.

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 Entities

Unarchive an entity reverses this call. Delete an entity hides the record instead. List entities in a program filters by archive state.

Questions

Questions we get asked about archiving an entity

Do we need a developer to implement this?
Yes. This is a single REST call by UUID, so a developer wires it to whatever offboards a customer 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 entity UUID in the path. Nothing else; an Idempotency-Key header is optional.
What comes back?
A 200 with the entity, its archived at field set to the time the archive took effect. The field is always present on entity responses and is null when the entity is not archived.
What is the difference between archive and delete?
Archived records stay fully visible and readable, and can be filtered in or out of lists. Deleted records are hidden from the API and the portal, return 404, and can only be restored in the portal within 30 days.
What happens if we archive an already archived entity?
It is returned in its current state. No new audit entry is recorded and the child records are not cascaded again.
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