WatchEye API v1
API reference
Everything you can call on the WatchEye API, grouped by resource. Pick an endpoint to see what to send, what comes back, and a worked JSON example of each.
You'll need an API key, sent as a bearer token on every request. New to the API? Start with the Getting started guide.
Base
Download OpenAPI spec
https://portal.watcheye.com.au/api/v1
The WatchEye API gives programmatic access to everything in WatchEye: PEP and sanctions screening, identity checks, IDPass verifications, monitoring programs, events and reports. Every request is authenticated with an API key and secret sent as a bearer token. The API guide covers the conventions, idempotency, rate limits, versioning and the sandbox.
Account
GET Show the calling account/account
Adhoc Checks
GET List adhoc checks/adhoc-checks
POST
Launch adhoc screening checks
/adhoc-checks
GET
Show an adhoc check
/adhoc-checks/{adhoc_check_uuid}
DELETE
Delete an adhoc check
/adhoc-checks/{adhoc_check_uuid}
GET
Download an adhoc check as PDF
/adhoc-checks/{adhoc_check_uuid}/pdf
Adhoc ID Checks
GET List adhoc ID checks/adhoc-id-checks
POST
Launch an adhoc ID check
/adhoc-id-checks
GET
Show an adhoc ID check
/adhoc-id-checks/{adhoc_id_check_uuid}
DELETE
Delete an adhoc ID check
/adhoc-id-checks/{adhoc_id_check_uuid}
GET
Download an adhoc ID check certificate as PDF
/adhoc-id-checks/{adhoc_id_check_uuid}/pdf
Audits
GET List audit entries/audits
GET
Show an audit entry
/audits/{audit_uuid}
Checks
GET List checks/checks
GET
Show a check
/checks/{check_uuid}
GET
Download a check as PDF
/checks/{check_uuid}/pdf
POST
Launch screening checks against an entity
/entities/{entity_uuid}/checks
Entities
GET List entities in a program/programs/{program_uuid}/entities
POST
Create an entity in a program
/programs/{program_uuid}/entities
GET
Show an entity
/entities/{entity_uuid}
PATCH
Update an entity
/entities/{entity_uuid}
DELETE
Delete an entity
/entities/{entity_uuid}
POST
Archive an entity
/entities/{entity_uuid}/archive
POST
Unarchive an entity
/entities/{entity_uuid}/unarchive
Events
GET List events/events
GET
Show an event
/events/{event_uuid}
PATCH
Update an event
/events/{event_uuid}
ID Checks
GET List ID checks/id-checks
GET
Show an ID check
/id-checks/{id_check_uuid}
GET
Download an ID check certificate as PDF
/id-checks/{id_check_uuid}/pdf
POST
Launch an ID check against an entity
/entities/{entity_uuid}/id-checks
IDPass
GET List IDPasses/idpasses
GET
Show an IDPass
/idpasses/{idpass_uuid}
POST
Launch an IDPass against an entity
/entities/{entity_uuid}/idpasses
POST
Launch an adhoc IDPass
/adhoc-idpasses
GET
Download an IDPass image
/idpasses/{idpass_uuid}/images/{image_type}
GET
Download an IDPass certificate as PDF
/idpasses/{idpass_uuid}/pdf
Monitors
GET List monitors in a program/programs/{program_uuid}/monitors
POST
Create a monitor
/programs/{program_uuid}/monitors
GET
Show a monitor
/monitors/{monitor_uuid}
PATCH
Update a monitor
/monitors/{monitor_uuid}
DELETE
Delete a monitor
/monitors/{monitor_uuid}
POST
Run a monitor on demand
/monitors/{monitor_uuid}/run
Notes
GET List notes/notes
POST
Create a note on an entity
/entities/{entity_uuid}/notes
GET
Show a note
/notes/{note_uuid}
PATCH
Update a note
/notes/{note_uuid}
DELETE
Delete a note
/notes/{note_uuid}
Programs
GET List programs/programs
POST
Create a program
/programs
GET
Show a program
/programs/{program_uuid}
PATCH
Update a program
/programs/{program_uuid}
DELETE
Delete a program
/programs/{program_uuid}
Relationships
GET List an entity's relationships/entities/{entity_uuid}/relationships
POST
Create a relationship on an entity
/entities/{entity_uuid}/relationships
GET
Resolve an entity's ultimate beneficial owners
/entities/{entity_uuid}/ubos
DELETE
Delete a relationship
/relationships/{relationship_uuid}
Test
GET Test endpoint/test
Users
GET List users/users
GET
Show user
/users/{user_uuid}
PATCH
Update user
/users/{user_uuid}