Create Book

post

https://api.ocrolus.com/v1/book/add

Create a Book that you can use to group related Documents. Each document must be uploaded to a Book, so you'll need to create one with this endpoint before you can upload files. Books are generally used to store related Documents, such as for a loan application or a case file.

Body Params

name

string

required

The name of the Book that will be created.

book_class

string

enum

The processing type of the book. Can be either 'COMPLETE' or 'INSTANT'.
By default this value will be set to COMPLETE unless your organization is configured to have INSTANT as the default.

Allowed:

book_type

string

enum

Describes how the Book was created. This feature is in beta. See our guides on OPTIMA and WIDGET for additional information.

Allowed:

is_public

boolean

true allows all users in your organization to see and upload Documents into this Book.

xid

string

A free form field that can be used to associate a Book with some identity outside of Ocrolus.

Responses

200Success

400Client Errors