Ocrolus API

Introduction
HTTP status codes
Ocrolus status codes
API Rate Limit Policy

Authentication

Grant authentication tokenpost

Book Commands

Create a Bookpost
Delete a Bookpost
Update a Bookpost

Book Queries

Book informationget
Book listget
Book statusget

File Uploads

Multipart/form-data payloads
Upload PDF to Bookpost
Upload Mixed Document PDF to Bookpost
Upload Pay stub PDF to Bookpost
Upload Image to Bookpost
Finalize Image Grouppost
Upload Plaid JSON to Bookpost
Import Plaid Asset Reportpost

File Commands

Cancel Document verificationpost
Delete a Documentpost
Download a Documentget
Update a Documentpost
Update a Mixed Documentpost

File Queries

Retrieve Mixed Document statusget

Classify

Book classification summaryget
Mixed Doc classification summaryget

Capture

Book form dataget
Book pay stub dataget
Doc form dataget
Doc pay stub dataget
Form dataget
Pay stub dataget
Transactionsget

Detect

Book-level Fraud Signalsget
Document-Level Fraud Signalsget
Signal visualizationget
Suspicious Activity Flags (Legacy)get
Business Verification
Object Definitions

Analyze

Bank Statement Income Calculatorget
Bank Statement Income Calculator (Excel)get
Book summaryget
Cash Flow Featuresget
Enriched transactionsget
SMB Analytics (Excel)get
Risk Scoreget

Account Level Webhooks

Configure webhookpost
Get webhook configurationget
Test webhookget

Org Level Webhooks

Add a webhookpost
Delete a webhookdelete
List webhooksget
List events for a webhookget
Retrieve a webhookget
Test a webhookpost
Update a webhookpost

Ocrolus API

Introduction
HTTP status codes
Ocrolus status codes
API Rate Limit Policy

Authentication

Grant authentication tokenpost

Book Commands

Create a Bookpost
Delete a Bookpost
Update a Bookpost

Book Queries

Book informationget
Book listget
Book statusget

File Uploads

Multipart/form-data payloads
Upload PDF to Bookpost
Upload Mixed Document PDF to Bookpost
Upload Pay stub PDF to Bookpost
Upload Image to Bookpost
Finalize Image Grouppost
Upload Plaid JSON to Bookpost
Import Plaid Asset Reportpost

File Commands

Cancel Document verificationpost
Delete a Documentpost
Download a Documentget
Update a Documentpost
Update a Mixed Documentpost

File Queries

Retrieve Mixed Document statusget

Classify

Book classification summaryget
Mixed Doc classification summaryget

Capture

Book form dataget
Book pay stub dataget
Doc form dataget
Doc pay stub dataget
Form dataget
Pay stub dataget
Transactionsget

Detect

Book-level Fraud Signalsget
Document-Level Fraud Signalsget
Signal visualizationget
Suspicious Activity Flags (Legacy)get
Business Verification
Object Definitions

Analyze

Bank Statement Income Calculatorget
Bank Statement Income Calculator (Excel)get
Book summaryget
Cash Flow Featuresget
Enriched transactionsget
SMB Analytics (Excel)get
Risk Scoreget

Account Level Webhooks

Configure webhookpost
Get webhook configurationget
Test webhookget

Org Level Webhooks

Add a webhookpost
Delete a webhookdelete
List webhooksget
List events for a webhookget
Retrieve a webhookget
Test a webhookpost
Update a webhookpost

Configure webhook

post https://api.ocrolus.com/v1/account/settings/update/webhook_endpoint

Set up a webhook for your account so your application can react to Ocrolus events.

You can find a list of supported account-level event types and their sample notifications in the Account-level webhook guide.

📘
Your webhook integration should respond to incoming notifications with a status of 200 OK to indicate that it's working properly.

🚧
We have a better version!
This product is superseded by Org Level Webhooks, which we recommend for improved functionality and integration.

Body Params

webhook_endpoint

url

required

The URL of the endpoint that will receive notifications of Ocrolus events. This should be on your own infrastructure, protected from the outside world on a network level. See here for a list of IP addresses that you can add to your firewall's allowlist.

The domain will be checked for validity, although the webhook itself won't be called. We suggest testing the endpoint after configuring it.

event

array of strings

A comma-separated list of events that will trigger a call to your webhook. To deregister the webhook, provide an empty array.
The event list given in this parameter will replace all existing subscriptions, i.e. providing a single event will subscribe only to that event while unsubscribing from the others.

Responses

Response body

object

status

integer

required

Defaults to 200

Numerical code indicating the status of this request. Will be 200 for a successful response.

code

integer

Numerical code indicating the nature of an error. Will not be present if the response is successful.

message

string

required

Defaults to OK

A textual description that indicates details about this response's status. Will be "OK" for a successful request.

response

object

required

An object that describes the active webhook registration. Only one webhook can be registered at this time; if you need multiple event handlers, your implementation should inspect the request payload and direct events as needed.

webhook_endpoint

url

required

The value of webhook_endpoint that was provided in the request. Can contain query parameters, port numbers, authentication credentials, and other URL components.

events

array of strings

required

length ≥ 0

The webhook events that were successfully registered. Invalid event names will not be included here.

events*

Response body

object

status

integer

required

Defaults to 200

Numerical code indicating the status of this request. Will be 200 for a successful response.

code

integer

Numerical code indicating the nature of an error. Will not be present if the response is successful.

message

string

required

Defaults to OK

A textual description that indicates details about this response's status. Will be "OK" for a successful request.

response

object

required

webhook_endpoint

url

required

The value of webhook_endpoint that was provided in the request. Can contain query parameters, port numbers, authentication credentials, and other URL components.

events

array of strings

required

length ≥ 0

The webhook events that were successfully registered. Invalid event names will not be included here.

events*

Updated 8 months ago

Risk Score

Get webhook configuration

Did this page help you?

Language

Credentials

OAuth2

Bearer


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.ocrolus.com/v1/account/settings/update/webhook_endpoint \
3
     --header 'accept: application/json' \
4
     --header 'content-type: multipart/form-data'

Choose an example:

application/json

Updated 8 months ago

Risk Score

Get webhook configuration

Did this page help you?

Ocrolus API
Introduction
HTTP status codes
Ocrolus status codes
API Rate Limit Policy

Authentication
Grant authentication tokenpost

Book Commands
Create a Bookpost
Delete a Bookpost
Update a Bookpost

Book Queries
Book informationget
Book listget
Book statusget

File Uploads
Multipart/form-data payloads
Upload PDF to Bookpost
Upload Mixed Document PDF to Bookpost
Upload Pay stub PDF to Bookpost
Upload Image to Bookpost
Finalize Image Grouppost
Upload Plaid JSON to Bookpost
Import Plaid Asset Reportpost

File Commands
Cancel Document verificationpost
Delete a Documentpost
Download a Documentget
Update a Documentpost
Update a Mixed Documentpost

File Queries
Retrieve Mixed Document statusget

Classify
Book classification summaryget
Mixed Doc classification summaryget

Capture
Book form dataget
Book pay stub dataget
Doc form dataget
Doc pay stub dataget
Form dataget
Pay stub dataget
Transactionsget

Detect
Book-level Fraud Signalsget
Document-Level Fraud Signalsget
Signal visualizationget
Suspicious Activity Flags (Legacy)get
Business Verification
Vendor authenticationput
Retrieve business verificationget
Create business verificationpost
Object Definitions
Supporting data values
Supporting data
Visualization region
Visualization
Signal
Form analysis
Document analysis
Signal analysis

Analyze
Bank Statement Income Calculatorget
Bank Statement Income Calculator (Excel)get
Book summaryget
Cash Flow Featuresget
Enriched transactionsget
SMB Analytics (Excel)get
Risk Scoreget

Account Level Webhooks
Configure webhookpost
Get webhook configurationget
Test webhookget

Org Level Webhooks
Add a webhookpost
Delete a webhookdelete
List webhooksget
List events for a webhookget
Retrieve a webhookget
Test a webhookpost
Update a webhookpost

Ocrolus API
Introduction
HTTP status codes
Ocrolus status codes
API Rate Limit Policy

Authentication
Grant authentication tokenpost

Book Commands
Create a Bookpost
Delete a Bookpost
Update a Bookpost

Book Queries
Book informationget
Book listget
Book statusget

File Uploads
Multipart/form-data payloads
Upload PDF to Bookpost
Upload Mixed Document PDF to Bookpost
Upload Pay stub PDF to Bookpost
Upload Image to Bookpost
Finalize Image Grouppost
Upload Plaid JSON to Bookpost
Import Plaid Asset Reportpost

File Commands
Cancel Document verificationpost
Delete a Documentpost
Download a Documentget
Update a Documentpost
Update a Mixed Documentpost

File Queries
Retrieve Mixed Document statusget

Classify
Book classification summaryget
Mixed Doc classification summaryget

Capture
Book form dataget
Book pay stub dataget
Doc form dataget
Doc pay stub dataget
Form dataget
Pay stub dataget
Transactionsget

Detect
Book-level Fraud Signalsget
Document-Level Fraud Signalsget
Signal visualizationget
Suspicious Activity Flags (Legacy)get
Business Verification
Vendor authenticationput
Retrieve business verificationget
Create business verificationpost
Object Definitions
Supporting data values
Supporting data
Visualization region
Visualization
Signal
Form analysis
Document analysis
Signal analysis

Analyze
Bank Statement Income Calculatorget
Bank Statement Income Calculator (Excel)get
Book summaryget
Cash Flow Featuresget
Enriched transactionsget
SMB Analytics (Excel)get
Risk Scoreget

Account Level Webhooks
Configure webhookpost
Get webhook configurationget
Test webhookget

Org Level Webhooks
Add a webhookpost
Delete a webhookdelete
List webhooksget
List events for a webhookget
Retrieve a webhookget
Test a webhookpost
Update a webhookpost

200Success

400Client Errors