9am–5pm AEST, Monday to Friday.
03 9948 4089Launching adhoc screening checks queues one or more screening operations against a subject supplied in the request body, with no program or entity record. The call returns a 202 with the adhoc check UUID and the screening runs in the background. It uses the same operations, configuration and results as entity checks.
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.
New accounts begin with sandbox access.
Not every screen belongs to an entity you monitor. A prospect, a one-off counterparty or a name from a form can be screened as an adhoc check: the subject travels in the request, the check runs in the background, and the result is read from Show an adhoc check. The response shape is the same as an entity check, so one integration reads both.
The response carries the adhoc check UUID, a status of pending and the path to poll. A group launch lists each child with its own UUID, status, resolved configuration and detail path, in the order requested.
The required keys in the data object depend on the operations requested, and each operation validates the same data object independently. A missing or malformed field returns 400 naming the offending key, before any check row is created or credit charged.
A check type not enabled for the account returns 403 and insufficient credit for the total projected cost returns 402, both before anything is queued.
An optional Idempotency-Key header makes retries safe. The same key and body returns the original response with an Idempotent-Replay header; the same key with a different body is rejected with 422.
The launch returns 202 as soon as the checks are queued. Your system polls Show an adhoc check with the UUID until the status is complete or failed, then reads the outcome and the results overview.
Subject kinds are not mixed: for a PEP and sanction check exactly one of an individual, a business name or a vessel name is supplied, and a business name sent together with a first name is rejected. Dates of birth are accepted as YYYY-MM-DD or DD/MM/YYYY.
The status field says whether the check has finished. Once it is complete, the outcome field says whether anything needs your attention.
The check completed and no result needs review. For a PEP and sanction screen that means no match above the similarity threshold. The check summary states the result in a sentence, and the events count is zero.
The check completed with results to look at. Each row in the results overview carries a title, its own status of pass, warning or fail, and the alert identifiers that link it to the events raised in the triage queue.
The upstream provider returned an error. The failed reason is recorded on the check and the credit charged at launch is refunded. Launch the check again once the cause is understood.
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.
Show an adhoc check reads the results. List adhoc checks finds them. Download an adhoc check as PDF produces the report. Launch screening checks against an entity runs the same operations against an entity you monitor.
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