Ocrolus Status Codes

All successfully processed API requests return a JSON response with a status of 200 and a message of OK.

{
  "status": 200,
  "message": "OK",
  "response": "..."
}

If processing a request generates an application error, the JSON response reports the errors as follows:

  • The status attribute will have a value other than 200.
  • The message attribute will contain a descriptive explanation of the error.
  • The code attribute will identify the category of error.
{
  "status": 400,
  "message": "Authentication failed",
  "code": 1200,
  "response": null
}

Ocrolus API error codes

Status

Code

Reason

400

1002

Could not decode JSON string

400

1003

Request validation failure; check parameter values and types.

400

1005

Request verification rate limit exceeded

400

1100

The request could not be processed (are any of the fields mutually exclusive?)

400

1101

The requested endpoint does not exist

400

1103

Required parameter not found

400

1104

The parameter value is not a valid file

400

1109

The file is not a valid PDF

400

1200

Authentication failed

400

1201

Invalid refresh token

400

1202

Invalid access token

400

1204

Invalid API key credentials

400

1306

Email and/or password not found

400

1307

Account is not active

400

1308

Account is not verified

400

1313

Account info not found

400

1316

Account does not have required manager permissions

400

1317

Account is not a member of the organization

400

1323

Your organization has been deleted

400

1324

For your protection, your account has been locked after 3 failed login attempts. To reset your password, visit https://app.ocrolus.com/recover.

400

1325

For your protection, your account has been locked for 20 minutes after 20 failed login attempts. To reset your password, visit https://app.ocrolus.com/recover.

400

1398

Organization not found

400

1399

Account not found

400

1401

Book not found

400

1402

Book already exists

400

1404

Book containing documents pending verification

400

1406

Business is not associated with the book

400

1407

Business exists

400

1408

Business not found

400

1500

A DocumentError occurred

400

1501

Document not found

400

1502

Document exists

400

1504

PageDoc not found

400

1508

Page index out of range

400

1511

Mixed document is pending classification.

400

1512

Document contains more than the maximum allowed pages. See here for more information.

400

1513

An error occured while processing instant ML document.

400

1601

Transaction not found

400

1609

Transaction is already marked as a transfer

400

1702

Bank account was not found

400

2100

Invalid permission

400

2101

No permission to access this endpoint

400

2102

No permission to access this book

400

2103

Account permission error

400

2104

No permission to access this doc

400

2105

No permission to access this page

400

2106

No permission to access this txn

400

2107

No permission to access this form

400

2108

No permission to access this uploaded image group

400

2109

No permission to access this bank account

400

2300

Database error

400

2401

Error fetching final result from paystub service

400

2500

Error from mortgage service

400

5001

Filter exists

400

5002

Filter not found

400

6001

Form type not found

400

7001

Tag not found

400

7002

Image group not found

400

7003

No form config found

400

7004

Page index missing from uploaded images in image bucket

400

8001

This endpoint only accepts 1 file uploaded each time

400

9001

The analytics generation exceeded the maximum execution time. Please try again later or contact [email protected]

400

9002

Analytics is not supported for this type of case

400

9003

Analytics (JSON) can only process analytics for bank statements

400

9101

This organization does not have the permission required to retrieve the SentiLink score. Please contact support for more information.

400

9102

SentiLink score could not be retrieved due to an invalid field. Please contact support for further assistance

400

9103

SentiLink score could not be retrieved due to a missing field. Please contact support for further assistance

400

9104

SentiLink is not reachable. Please try again later


Did this page help you?