> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cynopsis.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Quick Scan

The **Quick Scan** feature allows users to perform an **ad-hoc preliminary screening** based on the name of an **individual** or a **corporate entity**.

Quick Scan is designed for **fast checks** outside the full customer onboarding workflow, making it useful for spot-checks, investigations, or pre-onboarding assessments.

***

## Workflow

<Steps>
  <Step title="Trigger a Quick Scan">
    Call [`POST /api/quickscan/screen`](./post-quick-scan-screen) with the entity name, customer type, and chosen screening engines.
    The API returns a `screeningId` you will use in subsequent calls.
  </Step>

  <Step title="Poll for completion (optional)">
    Call [`GET /api/quickscan/screen/{screeningId}`](./get-quick-scan-screening) to check the screening `finalStatus`.
    Repeat until the status is `DONE` or `FAILED`.
  </Step>

  <Step title="Retrieve hits by screening type">
    Call [`GET /api/quickscan/screen/{screeningId}/hit`](./get-quick-scan-screening-hits) with the desired `screeningType` to get paginated potential hits.
  </Step>
</Steps>

***

## Key Features

* Screen by **individual name** or **corporate name**.
* Choose which **screening engines** to include (e.g., `ARTEMISCAN`, `DJ`, `OWN_RESTRICTED_LIST`, `INTERNET_SEARCH`, `TR`).
* Retrieve past scans and review **detailed hits** for each screening engine.

***

## Screening Engines

| Engine                | Description                                |
| --------------------- | ------------------------------------------ |
| `ARTEMISCAN`          | Cynopsis proprietary screening engine      |
| `DJ`                  | Dow Jones screening                        |
| `TR`                  | World-Check (Refinitiv / LSEG)             |
| `INTERNET_SEARCH`     | Internet-based adverse media search        |
| `OWN_RESTRICTED_LIST` | Your organisation's custom restricted list |

***

## Notes

* Quick Scan results provide a **snapshot** of potential risk indicators.
* For ongoing monitoring and audit trails, use the full **Customer Creation and Screening Workflow** instead.

***

## Endpoints in This Section

| Endpoint                                                         | Description                              |
| ---------------------------------------------------------------- | ---------------------------------------- |
| [Trigger Quick Scan Screening](./post-quick-scan-screen)         | Start a new Quick Scan                   |
| [Get Quick Scan Screening](./get-quick-scan-screening)           | Check screening status and details       |
| [Get Quick Scan Screening Hits](./get-quick-scan-screening-hits) | Retrieve hits filtered by screening type |
| [Get Quick Scan List](./get-quick-scan-list)                     | List all historical Quick Scans          |