v1
latestOpenAPI 3.0.02026-07-2482421001.1 KBDetect
Book-level Fraud Signals
Scan every <glossary:Document> in an uploaded <glossary:Book> for signs of potentially fraudulent tampering.
📘 This is the better version! This endpoint supersedes our existing Suspicious Activity Flags endpoint, as well as the primary_recon_error_reason and secondary_recon_error_reason attributes returned by the Analytics endpoints. A deprecation plan will be announced in the future.
get/v2/detect/book/{book_uuid}/signals
Path parameters
book_uuidstring uuid required
Example:88fca8c7-aa20-4bc0-a4f3-2dfcf96c3c27
The unique identifier of a <glossary:Book>.
Query parameters
exclude_dashboard_urlboolean
Example:true
determines whether Ocrolus will return the unique Ocrolus Dashboard URL that links directly to the Dashboard for the given book.
Response
The <glossary:Book> was scanned for potential fraud, and the results are enclosed.