WatchEye · Checks

List checks

List checks returns the screening checks on the calling account as a paginated list. Each record is a compact envelope: what ran, against which entity in which program, its status and outcome, and how many events it raised. Filters narrow the list by check type, outcome, program, entity, parent group and date, and the show endpoint reads any one of them in full.

Every screening check on the account, 30 per page by default and up to 500, newest first
Filter by check type, outcome, program, entity, parent group, date range and archive status

Request access Talk to sales

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
Filters, sort fields and pagination

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

Finding the checks that matter across every program

An account accumulates checks from monitor runs and manual launches across many entities. The list is how a reporting job, a reconciliation or a reviewer's queue finds the right ones without walking every entity. Group checks appear as first-class records, with their children one filter away.

What ran and what it found

Each record carries the check type, the status, the outcome of pass or warning once complete, a one-line check summary such as Found 2 PEP matches, and a one-line data summary of the subject.

Where it belongs

The program and the entity are embedded with their UUIDs, numbers and display names. A child of a group check carries its parent UUID. Adhoc checks with no program or entity return null for both.

How much attention it needs

The events count says how many events were raised against the check, and is zero when no match required one. The checked at timestamp and the archived at timestamp show when it ran and whether it has been hidden from the active list.

Only the checks you asked for

Filters cover check type, outcome, program, entity, parent, checked after and checked before. The archived parameter selects archived or non-archived records. Sort by checked at, check type or outcome, ascending or descending.

How a check runs

Where checks sit in the WatchEye model

A check is a screening run against an entity in a program. Its matches become events in the triage queue, and every call that touches it is written to the audit log.

A filter that targets a program, entity or parent UUID returns an empty page when that UUID does not exist on the calling account, the same as for a UUID that does not exist at all.

What it costs

Charged per check type, at launch, against your account balance

Each screening check type you launch is charged to your WatchEye account when the request is accepted. The rate for each check type is set for your account and communicated by your Global Data account manager. Statements with a breakdown of API calls and their costs are available in the WatchEye portal.

Billed at launch
Refunded if the provider fails

How billing works

Credits drawn down as each check is queued

Each check type in the request is charged when the launch is accepted.
If the upstream provider returns an error, the check is marked failed and the credit for that check is refunded.
A 402 response means the account has reached its credit or call limit. Nothing is queued and nothing is charged.
Reads, lists and PDF downloads are not billed.

Talk to us about rates

Related checks

Others in WatchEye Checks

Show a check reads one record with its results and details. Launch screening checks against an entity creates them. List adhoc checks covers the checks that ran without an entity record.

Download a check as PDF Launch screening checks against an entity Show a check

All WatchEye checks endpoints

Questions

Questions we get asked about listing checks

Do we need a developer to implement this?

Yes. This is a paginated REST list with query-string filters, so a developer connects it to whatever reporting or reconciliation job needs it. 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?

Nothing is required. Optional query parameters are page, per page, the filters for check type, outcome, program UUID, entity UUID, parent UUID, checked after and checked before, a sort field, and the archived flag.

What comes back?

A data array of check envelopes, a meta object with the current page, per page, total and last page, and an API reference for the call. Each envelope carries the UUID, check number, type, status, failed reason, outcome, check summary, data summary, timestamps, program, entity, parent UUID and events count.

How do we find the children of a group check?

Filter by parent UUID with the group's UUID. The group itself appears in the list with a check type of group; its status is rolled up from its children, and its outcome is null until child results exist.

How is the list ordered and paged?

Newest first by default. Sort by checked at, check type or outcome, with a leading minus for descending. Pages hold 30 records by default and up to 500.

Is listing billed?

No. Reads are not charged; the charge is made when a check is launched.

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.

Request access Talk to sales

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