WatchEye API

Build with the WatchEye API

Programmatic access to everything in WatchEye: PEP and sanctions screening, identity checks, IDPass verifications, ongoing monitoring programs and reports. A RESTful API with JSON payloads, one API key, and a sandbox environment for integration testing.

Get started Browse the API reference

Base URL

Base https://portal.watcheye.com.au/api/v1

Authenticate every request with Authorization: Bearer <your-api-key>. Sandbox and live share the same URL: the account your API key belongs to decides the environment.

Guide

How the API works, from authentication and conventions through to each resource and the sandbox.

Read the guide

WatchEye API System Resource Overview Integration security and data handling 2 Access Overview 1 Authentication and Authorization 5 Quick Start 4 API Conventions 8 List Endpoint Conventions 4 Synchronous and Asynchronous Endpoints 3 Billing and Account Management 5 Adhoc check data fields 3 Rate Limiting 5 Idempotency 9 API Versioning 6 Maintenance Windows 3 Errors 2 Soft Deletion 6 Monitor Configuration 12 ID Checks 4 IDPass 6 Sandbox 5 IDPass Test Documents 2

API reference

Every endpoint, with its parameters, response fields and JSON examples.

Open full reference

Account 1 Adhoc Checks 5 Adhoc ID Checks 5 Audits 2 Checks 4 Entities 7 Events 3 ID Checks 4 IDPass 6 Monitors 6 Notes 5 Programs 5 Relationships 4 Test 1 Users 3

Machine readable

OpenAPI 3 specification

The same file this reference is built from. Use it with Postman, client generators and API tools.

/docs/openapi.yaml

Offline

PDF bundle

The guide and the full endpoint reference in one document.

API documentation (PDF)

For coding agents

llms.txt

A plain-text index of every guide page and endpoint, so tools find the canonical source first.

/docs/llms.txt

Plain text

Markdown for every page

Append .md to any guide or endpoint URL to get the source without the page chrome.

/docs/reference/….md