WatchEye · Monitors

Create a monitor

Q: Is it safe to retry this call?

Yes, if you send an Idempotency-Key header. A connection can drop after WatchEye has processed a request but before the response reaches you, and a blind retry would risk a duplicate record or a double charge. The key is any string of your choosing up to 255 characters, unique per logical operation, and a fresh UUID per request is the usual approach. Sending the same key again returns the original response byte for byte, with no new database changes and no new billable charge. The header is honoured on POST only. It is silently ignored on GET, PATCH and DELETE, which are already idempotent at the HTTP level.

POST

/programs/{program_uuid}/monitors

LIVE

Create a new monitor in the given program. The monitor_check_type is fixed at
creation - to change a monitor's operation type, delete it and create a new one.

Request a Demo Contact Sales

Home
API
Endpoints
WatchEye · Monitors
Create a monitor

Create a monitor

Example Request

POST

request.json

key Auth: BearerAuth

{
  "monitor_name": "Weekly PEP Sweep",
  "monitor_check_type": "pep_sanction_check",
  "status": "active",
  "schedule": "weekdays",
  "config": {
    "search_type": "pep_and_sanction",
    "similarity_threshold": 90
  }
}

Request Schema

program_uuid

Required

uuid · path

The program UUID

Idempotency-Key

Optional

string · header, max 255 chars

Optional client-generated key (typically a UUID) that lets you safely retry a write request without risk of duplicate work or duplicate billing. A retry with the same key and body returns the original response verbatim, with the `Idempotent-Replay: true` response header. Honoured on `POST` requests

monitor_name

Required

string · max 255 chars

monitor_check_type

Required

string

The screening operation to run. Must be one of the operation types enabled on the calling account.

status

Required

enum · active | paused

schedule

Required

config

Optional

object

Per-operation configuration; see the Configuration section above.

Available Response Data

13 Data Points

inventory_2 What You Receive

fingerprint

uuid uuid

The monitor's UUID

fingerprint

monitor_number string (A short obfuscated public identifier for the monitor (e.g. "M-12-34-56"))

person

monitor_name string

The display name of the monitor

data_object

monitor_check_type string

The screening operation this monitor runs

person

monitor_check_type_name string (Human-readable name for monitor_check_type (e.g. "PEP & Sanction Check"))

monitor_heart

status enum

Lifecycle status: active, paused

monitor_heart

process_status enum

In-flight run state, or null when the monitor is idle: pending, processing, failed, paused

monitor_heart

process_status_comment string (Optional human-readable detail accompanying process_status (e.g. failure message))

data_object

schedule enum

How often the monitor runs unattended: manual, every_day, weekdays, weekends, monday, tuesday, …

person

schedule_name string (Human-readable description of the schedule (e.g. "Every Day (Mon-Sun)"))

data_object

config object

Per-operation configuration

schedule

last_run_at timestamp

ISO 8601 timestamp of the most recent run, or null if the monitor has never run

fingerprint

api_reference uuid

unique request identifier for log tracing and audit

lock Full API documentation provided after vetting from our compliance team. Request sample response arrow_forward

By The Numbers

API Data Scale & Coverage tag

Unmatched data depth to power your compliance and verification workflows.

50M+

Phone & Email Records

40M+

Adverse Court Records

2BN+

Australian Universe Records

18M+

Real Estate Records

7M+

Deceased Records

980M+

Social Media & Employment Records

science

Sandbox Environment

Build and test against a sandbox account. Sandbox is a separate account with its own UUID and its own API keys, and the environment is fixed at the account level, so you cannot switch an existing key between live and sandbox with a parameter or header. Both share the same base URL, so the account behind your key is what determines which environment you are in. GET /v1/account returns an environment field of live or sandbox, and that is the authoritative answer.

Calls on a sandbox key are not billed. Every endpoint, response shape, error envelope, idempotency and rate-limit behaviour mirrors live, so the only change when you move to production should be the credentials. Sandbox accounts are provisioned by your Global Data account manager.

Practical Applications

Technical Use Cases tag

add_circle

Onboarding straight from your system

Create the monitor as part of your own onboarding flow, so WatchEye is populated at the moment the customer is captured instead of by a later import.

upload_file

Bulk migration

Load an existing book into WatchEye programmatically. Spread the calls evenly instead of bursting, and send an Idempotency-Key so a retried request cannot create a duplicate.

link

Keeping two systems in step

Mirror creations from your CRM or core system so the monitored population matches the customers you hold.

Trust & Assurance

Compliance & Security tag

Enterprise-grade infrastructure audited against the standards your regulators require.

verified_user

ISO 27001 Certified

enhanced_encryption

AES-256 Encryption

public

Australian Data Sovereignty

Integration & Support

Common Questions tag

Everything you need to know about implementation details and compliance infrastructure.

Filter by topic

help

Compliance Team

Global Data Support

Need help planning your custom integration or understanding our compliance coverage? Our team is here to assist.

rocket_launch Implementation

Is it safe to retry this call?

add

Yes, if you send an Idempotency-Key header. A connection can drop after WatchEye has processed a request but before the response reaches you, and a blind retry would risk a duplicate record or a double charge.

The key is any string of your choosing up to 255 characters, unique per logical operation, and a fresh UUID per request is the usual approach. Sending the same key again returns the original response byte for byte, with no new database changes and no new billable charge.

The header is honoured on POST only. It is silently ignored on GET, PATCH and DELETE, which are already idempotent at the HTTP level.

help_center General

Is this call billed?

add

Yes. This is a chargeable endpoint, and the fee is billed to your account at the time of the request. Your rates are set per account and confirmed by your Global Data account manager.

If your balance reaches zero or an agreed call limit is reached, further chargeable requests return 402 Payment Required until the account is topped up. Calls made with a key on a sandbox account are never charged.

rocket_launch Implementation

What are the rate limits?

add

600 requests per minute by default, enforced with a 60-second fixed window. Every response carries X-RateLimit-Limit and X-RateLimit-Remaining.

Exceeding the limit returns 429 Too Many Requests with a Retry-After header giving the number of seconds to wait, and X-RateLimit-Reset giving the reset timestamp. Schedule retries from Retry-After instead of a fixed sleep, and slow down before you hit zero, not after.

Higher limits can be arranged case by case through WatchEye support.

Enquire now

Ready to integrate Create a monitor?

Talk to our team about credentials, sandbox access and the right combination of endpoints for your workflow.

Call 03 9948 4089 · sales@globaldata.net.au

Request a Demo Contact Sales