The Ocrolus API is most commonly leveraged to process PDF Bank Statements. The essential workflows involved in this process are outlined below.
To upload PDF Bank Statements:
- Generate your API credentialsAPI credentials - API Credentials are the API Key and Secret used to authenticate all requests to the API. as described in the Authentication section.
- Create a new BookBook - A Book is a container for all Documents in a Case or Loan Application. This container primarily serves as a boundary to correlate data. As such, objects in different Books can never be associated or correlated with each other. to upload all the Bank Statements for a given Case.
- Upload the PDF files to the Book. Reference the
book_pkfrom the response of the Create Book call. This will ensure that the files are organized within the appropriate Book.
While you can request results at any point, you will only receive data from documents with
In order to receive results from a Case, poll for completion for Documents in a Book. In this scenario, poll for Book Status. Alternatively, configure a Webhook to be notified when a Document or Book is complete.
Once processed, Bank Statements produce two results:
To extract the results from a Book:
Updated about a year ago