getQuickScan
Quick Scan APIs
Get Quick Scan List
GET
getQuickScan
The Quick Scan List endpoint retrieves a history of Quick Scans performed within the domain.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.
Description
- Displays all previously executed Quick Scans, including metadata such as:
id— Unique identifier of the Quick Scan.quickscanName— The searched individual or corporate name.quickscanType— Type of scan performed: INDIVIDUAL or CORPORATE.screenedWith— The screening engine(s) used for the scan (e.g., ARTEMISCAN , INTERNET_SEARCH , OWN_RESTRICTED_LIST).potentialHits— Number of potential matches identified by the specified screening engine(s).
Notes
- Use this API to review past Quick Scan activities.
- Results may include both active and archived scans.
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Headers
X-Domain-ID
Query Parameters
searchString
