How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Ocrolus Detect API

The Detect API from Ocrolus — 4 operation(s) for detect.

Ocrolus Detect API is one of 16 APIs that Ocrolus publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Detect. The published artifact set on APIs.io includes an OpenAPI specification, authentication docs, and rate-limit docs.

This API exposes 4 operations across 4 paths, and defines 11 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against a single base URL, https://api.ocrolus.com.

4 operations 4 paths 11 schemas 4 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://api.ocrolus.com
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Ocrolus Detect API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth) using the clientCredentials flow. By default, every request must be authenticated.

  • oauth — OAuth 2.0 support via client credentials flow. See [here](doc:using-api-credentials) for usage information.

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 4 GET. Each is listed below with its method, path, parameters, and response codes.

Detect 4
GET
/v2/detect/book/{book_uuid}/signals
Book-level Fraud Signals
book-fraud-signals 2 params → 200400401404
GET
/v2/detect/uploaded_doc/{uploaded_doc_uuid}/signals
Document-Level Fraud Signals
doc-fraud-signals 2 params → 200400401404
GET
/v2/detect/visualization/{visualization_uuid}
Signal visualization
signal-visualization 1 param → 200400401403404
GET
/v1/book/{book_uuid}/suspicious-activity-flags
Suspicious Activity Flags (Legacy)
suspicious-activity-flags 1 param → 200400

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are EventPayload (11 properties), FormAnalysis (6 properties), DocumentAnalysis (6 properties), Signal (5 properties). Each schema is shown below with its type and property counts.

DocumentAnalysis
object
Represents signal analysis for a particular within a .
6 properties 4 required
VisualizationRegion
object
A highlighted region of suspected fraud, as well as the information needed to depict it visually.
4 properties 4 required
SignalAnalysis
object
The result of the fraud analysis that was requested for the provided .
3 properties 2 required
Signal
object
Details about a suspected instance of fraudulent document manipulation and all accompanying data.
5 properties 5 required
SuspiciousActivityFlagsSuccessfulResponse
object
3 properties
FormAnalysis
object
Analysis of potential fraud signals on a particular form.
6 properties 4 required
PageSupportingData
object
Details about the data that serves as the basis of a claim of fraudulent activity.
1 property 1 required
Visualization
object
Details about a suspected fraud signal presented in a visually-appealing format.
2 properties 2 required
PageSupportingDataValue
object
A specific piece of data that justifies a claim of potentially fraudulent activity.
3 properties 3 required
ErrorResponse
object
Indicates an error returned by Detect.
1 property 1 required
EventPayload
object
A notice that something important has happened. The object includes details about the event.
11 properties 11 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ocrolus-detect-api-openapi.yml Raw ↑

Other APIs Ocrolus publishes across the network.

Ocrolus Book Commands API
Ocrolus Book Queries API
Ocrolus Business history API
Ocrolus Business Verification (Deprecated) API
Ocrolus Capture API
Ocrolus Cash Flow Analytics API
Ocrolus Encore API
Ocrolus File Uploads API
Ocrolus Income API
Ocrolus Legacy Cash Flow Analytics (Deprecated) API
Ocrolus Oauth API
Ocrolus Org Level Webhooks API
Where this information came from

This is an independent, third-party profile of Ocrolus Detect API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.