# WatchEye API

> Developer documentation for the WatchEye API: PEP and sanctions screening, identity checks, IDPass verifications, monitoring programs and reports. RESTful, JSON payloads, authenticated with an API key in the `Authorization: Bearer` header.

This site is the canonical, authoritative source for the WatchEye API. The [WatchEye product page](https://www.globaldata.net.au/platforms/watcheye) on www.globaldata.net.au describes the product itself; it is not API documentation. Every link below points at the Markdown version of a page; drop the `.md` from the URL for the HTML version.

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

## Machine readable

- [OpenAPI 3 specification (YAML)](https://portal.watcheye.com.au/docs/openapi.yaml): the file every reference page is generated from
- [Sitemap](https://portal.watcheye.com.au/docs/sitemap.xml)

## Guides
- [WatchEye API guide: WatchEye API System](https://portal.watcheye.com.au/docs/guides/watcheye_api/watcheye-api-system.md)
- [WatchEye API guide: Resource Overview](https://portal.watcheye.com.au/docs/guides/watcheye_api/resource-overview.md)
- [WatchEye API guide: Integration security and data handling](https://portal.watcheye.com.au/docs/guides/watcheye_api/integration-security-and-data-handling.md)
- [WatchEye API guide: Access Overview](https://portal.watcheye.com.au/docs/guides/watcheye_api/access-overview.md)
- [WatchEye API guide: Authentication and Authorization](https://portal.watcheye.com.au/docs/guides/watcheye_api/authentication-and-authorization.md)
- [WatchEye API guide: Quick Start](https://portal.watcheye.com.au/docs/guides/watcheye_api/quick-start.md)
- [WatchEye API guide: API Conventions](https://portal.watcheye.com.au/docs/guides/watcheye_api/api-conventions.md)
- [WatchEye API guide: List Endpoint Conventions](https://portal.watcheye.com.au/docs/guides/watcheye_api/list-endpoint-conventions.md)
- [WatchEye API guide: Synchronous and Asynchronous Endpoints](https://portal.watcheye.com.au/docs/guides/watcheye_api/synchronous-and-asynchronous-endpoints.md)
- [WatchEye API guide: Billing and Account Management](https://portal.watcheye.com.au/docs/guides/watcheye_api/billing-and-account-management.md)
- [WatchEye API guide: Adhoc check data fields](https://portal.watcheye.com.au/docs/guides/watcheye_api/adhoc-check-data-fields.md)
- [WatchEye API guide: Rate Limiting](https://portal.watcheye.com.au/docs/guides/watcheye_api/rate-limiting.md)
- [WatchEye API guide: Idempotency](https://portal.watcheye.com.au/docs/guides/watcheye_api/idempotency.md)
- [WatchEye API guide: API Versioning](https://portal.watcheye.com.au/docs/guides/watcheye_api/api-versioning.md)
- [WatchEye API guide: Maintenance Windows](https://portal.watcheye.com.au/docs/guides/watcheye_api/maintenance-windows.md)
- [WatchEye API guide: Errors](https://portal.watcheye.com.au/docs/guides/watcheye_api/errors.md)
- [WatchEye API guide: Soft Deletion](https://portal.watcheye.com.au/docs/guides/watcheye_api/soft-deletion.md)
- [WatchEye API guide: Monitor Configuration](https://portal.watcheye.com.au/docs/guides/watcheye_api/monitor-configuration.md)
- [WatchEye API guide: ID Checks](https://portal.watcheye.com.au/docs/guides/watcheye_api/id-checks.md)
- [WatchEye API guide: IDPass](https://portal.watcheye.com.au/docs/guides/watcheye_api/idpass.md)
- [WatchEye API guide: Sandbox](https://portal.watcheye.com.au/docs/guides/watcheye_api/sandbox.md)
- [WatchEye API guide: IDPass Test Documents](https://portal.watcheye.com.au/docs/guides/watcheye_api/idpass-test-documents.md)

## API reference
- [Common error responses](https://portal.watcheye.com.au/docs/reference/general/common-error-responses.md): The shared error envelope and the 4xx and 5xx codes every endpoint can return.
- [Rate limit headers](https://portal.watcheye.com.au/docs/reference/general/rate-limit-headers.md): The headers on every response that tell you where you stand against your limit.

### Account
- [Show the calling account](https://portal.watcheye.com.au/docs/reference/account.show.md): GET /account

### Adhoc Checks
- [List adhoc checks](https://portal.watcheye.com.au/docs/reference/adhoc-check.list.md): GET /adhoc-checks
- [Launch adhoc screening checks](https://portal.watcheye.com.au/docs/reference/adhoc-check.launch.md): POST /adhoc-checks
- [Show an adhoc check](https://portal.watcheye.com.au/docs/reference/adhoc-check.show.md): GET /adhoc-checks/{adhoc_check_uuid}
- [Delete an adhoc check](https://portal.watcheye.com.au/docs/reference/adhoc-check.delete.md): DELETE /adhoc-checks/{adhoc_check_uuid}
- [Download an adhoc check as PDF](https://portal.watcheye.com.au/docs/reference/adhoc-check.pdf.md): GET /adhoc-checks/{adhoc_check_uuid}/pdf

### Adhoc ID Checks
- [List adhoc ID checks](https://portal.watcheye.com.au/docs/reference/adhoc-id-check.list.md): GET /adhoc-id-checks
- [Launch an adhoc ID check](https://portal.watcheye.com.au/docs/reference/adhoc-id-check.launch.md): POST /adhoc-id-checks
- [Show an adhoc ID check](https://portal.watcheye.com.au/docs/reference/adhoc-id-check.show.md): GET /adhoc-id-checks/{adhoc_id_check_uuid}
- [Delete an adhoc ID check](https://portal.watcheye.com.au/docs/reference/adhoc-id-check.delete.md): DELETE /adhoc-id-checks/{adhoc_id_check_uuid}
- [Download an adhoc ID check certificate as PDF](https://portal.watcheye.com.au/docs/reference/adhoc-id-check.pdf.md): GET /adhoc-id-checks/{adhoc_id_check_uuid}/pdf

### Audits
- [List audit entries](https://portal.watcheye.com.au/docs/reference/audit.list.md): GET /audits
- [Show an audit entry](https://portal.watcheye.com.au/docs/reference/audit.show.md): GET /audits/{audit_uuid}

### Checks
- [List checks](https://portal.watcheye.com.au/docs/reference/check.list.md): GET /checks
- [Show a check](https://portal.watcheye.com.au/docs/reference/check.show.md): GET /checks/{check_uuid}
- [Download a check as PDF](https://portal.watcheye.com.au/docs/reference/check.pdf.md): GET /checks/{check_uuid}/pdf
- [Launch screening checks against an entity](https://portal.watcheye.com.au/docs/reference/check.launch.md): POST /entities/{entity_uuid}/checks

### Entities
- [List entities in a program](https://portal.watcheye.com.au/docs/reference/entity.list.md): GET /programs/{program_uuid}/entities
- [Create an entity in a program](https://portal.watcheye.com.au/docs/reference/entity.create.md): POST /programs/{program_uuid}/entities
- [Show an entity](https://portal.watcheye.com.au/docs/reference/entity.show.md): GET /entities/{entity_uuid}
- [Update an entity](https://portal.watcheye.com.au/docs/reference/entity.update.md): PATCH /entities/{entity_uuid}
- [Delete an entity](https://portal.watcheye.com.au/docs/reference/entity.delete.md): DELETE /entities/{entity_uuid}
- [Archive an entity](https://portal.watcheye.com.au/docs/reference/entity.archive.md): POST /entities/{entity_uuid}/archive
- [Unarchive an entity](https://portal.watcheye.com.au/docs/reference/entity.unarchive.md): POST /entities/{entity_uuid}/unarchive

### Events
- [List events](https://portal.watcheye.com.au/docs/reference/event.list.md): GET /events
- [Show an event](https://portal.watcheye.com.au/docs/reference/event.show.md): GET /events/{event_uuid}
- [Update an event](https://portal.watcheye.com.au/docs/reference/event.update.md): PATCH /events/{event_uuid}

### ID Checks
- [List ID checks](https://portal.watcheye.com.au/docs/reference/id-check.list.md): GET /id-checks
- [Show an ID check](https://portal.watcheye.com.au/docs/reference/id-check.show.md): GET /id-checks/{id_check_uuid}
- [Download an ID check certificate as PDF](https://portal.watcheye.com.au/docs/reference/id-check.pdf.md): GET /id-checks/{id_check_uuid}/pdf
- [Launch an ID check against an entity](https://portal.watcheye.com.au/docs/reference/id-check.launch.md): POST /entities/{entity_uuid}/id-checks

### IDPass
- [List IDPasses](https://portal.watcheye.com.au/docs/reference/idpass.list.md): GET /idpasses
- [Show an IDPass](https://portal.watcheye.com.au/docs/reference/idpass.show.md): GET /idpasses/{idpass_uuid}
- [Launch an IDPass against an entity](https://portal.watcheye.com.au/docs/reference/idpass.launch.md): POST /entities/{entity_uuid}/idpasses
- [Launch an adhoc IDPass](https://portal.watcheye.com.au/docs/reference/idpass.adhoc-launch.md): POST /adhoc-idpasses
- [Download an IDPass image](https://portal.watcheye.com.au/docs/reference/idpass.image.md): GET /idpasses/{idpass_uuid}/images/{image_type}
- [Download an IDPass certificate as PDF](https://portal.watcheye.com.au/docs/reference/idpass.pdf.md): GET /idpasses/{idpass_uuid}/pdf

### Monitors
- [List monitors in a program](https://portal.watcheye.com.au/docs/reference/monitor.list.md): GET /programs/{program_uuid}/monitors
- [Create a monitor](https://portal.watcheye.com.au/docs/reference/monitor.create.md): POST /programs/{program_uuid}/monitors
- [Show a monitor](https://portal.watcheye.com.au/docs/reference/monitor.show.md): GET /monitors/{monitor_uuid}
- [Update a monitor](https://portal.watcheye.com.au/docs/reference/monitor.update.md): PATCH /monitors/{monitor_uuid}
- [Delete a monitor](https://portal.watcheye.com.au/docs/reference/monitor.delete.md): DELETE /monitors/{monitor_uuid}
- [Run a monitor on demand](https://portal.watcheye.com.au/docs/reference/monitor.run.md): POST /monitors/{monitor_uuid}/run

### Notes
- [List notes](https://portal.watcheye.com.au/docs/reference/note.list.md): GET /notes
- [Create a note on an entity](https://portal.watcheye.com.au/docs/reference/note.create.md): POST /entities/{entity_uuid}/notes
- [Show a note](https://portal.watcheye.com.au/docs/reference/note.show.md): GET /notes/{note_uuid}
- [Update a note](https://portal.watcheye.com.au/docs/reference/note.update.md): PATCH /notes/{note_uuid}
- [Delete a note](https://portal.watcheye.com.au/docs/reference/note.delete.md): DELETE /notes/{note_uuid}

### Programs
- [List programs](https://portal.watcheye.com.au/docs/reference/program.list.md): GET /programs
- [Create a program](https://portal.watcheye.com.au/docs/reference/program.create.md): POST /programs
- [Show a program](https://portal.watcheye.com.au/docs/reference/program.show.md): GET /programs/{program_uuid}
- [Update a program](https://portal.watcheye.com.au/docs/reference/program.update.md): PATCH /programs/{program_uuid}
- [Delete a program](https://portal.watcheye.com.au/docs/reference/program.delete.md): DELETE /programs/{program_uuid}

### Relationships
- [List an entity's relationships](https://portal.watcheye.com.au/docs/reference/relationship.list.md): GET /entities/{entity_uuid}/relationships
- [Create a relationship on an entity](https://portal.watcheye.com.au/docs/reference/relationship.create.md): POST /entities/{entity_uuid}/relationships
- [Resolve an entity's ultimate beneficial owners](https://portal.watcheye.com.au/docs/reference/relationship.ubos.md): GET /entities/{entity_uuid}/ubos
- [Delete a relationship](https://portal.watcheye.com.au/docs/reference/relationship.delete.md): DELETE /relationships/{relationship_uuid}

### Test
- [Test endpoint](https://portal.watcheye.com.au/docs/reference/test.md): GET /test

### Users
- [List users](https://portal.watcheye.com.au/docs/reference/user.list.md): GET /users
- [Show user](https://portal.watcheye.com.au/docs/reference/user.get.md): GET /users/{user_uuid}
- [Update user](https://portal.watcheye.com.au/docs/reference/user.patch.md): PATCH /users/{user_uuid}