v1
latestOpenAPI 3.0.02026-07-2482421001.1 KBDetect
Document-Level Fraud Signals
Scan a <glossary:Document> 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/uploaded_doc/{uploaded_doc_uuid}/signals
Path parameters
uploaded_doc_uuidstring uuid required
Example:88fca8c7-aa20-4bc0-a4f3-2dfcf96c3c27
The unique identifier of a <glossary:Document>.
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 Document was successfully scanned for potential fraud, and the results are enclosed. The doc_analysis attribute in the returned object will have exactly one element representing the requested document.