Cash Flow Analytics

Run Docs-to-Digital on an existing Plaid JSON

Triggers a Docs-to-Digital comparison on a Plaid JSON <glossary:Document> already uploaded to a <glossary:Book>, without re-uploading the file. Use this when a Plaid JSON was uploaded with upload_intent=add_analytics (or before Docs-to-Digital intent was set) and you now want to compare it against the Book's bank statement data.

To upload a new Plaid JSON and request Docs-to-Digital in the same call, see Upload aggregator JSON to Book instead.

📘 Prerequisites

  • The Book already contains at least one Plaid JSON Document.
  • The Book already contains bank statement data to compare against.
  • Complete the Docs-to-Digital matching — Prerequisites steps.

Retry behavior

This endpoint is safe to call more than once with the same uploaded_doc_uuids. A Document that already completed a Docs-to-Digital run comes back in skipped_doc_uuids instead of being reprocessed, so retrying doesn't create a duplicate Document or duplicate transactions.

post/v2/book/{book_uuid}/docs-to-digital

Request

  • Base URL
    https://api.ocrolus.com
  • URL
    https://api.ocrolus.com/v2/book/{book_uuid}/docs-to-digital
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://auth.ocrolus.com/oauth/token

Path parameters

book_uuidstring uuid required

UUID of the <glossary:Book> that contains the Plaid JSON Document(s).

Request body

uploaded_doc_uuidsstring[] required

Document UUIDs of Plaid JSON Documents already uploaded to the Book. Get these from Book information or Book list endpoints.

Example request

{
  "uploaded_doc_uuids": [
    "8dc88eed-2b6f-414a-82f2-a99bd181cf6e",
    "e3f2f66a-2792-439e-905f-240c33a84bd1"
  ]
}

Response

Document processing and skip status

startedboolean

Returns true if at least one requested document was newly triggered, or false if all requested documents were skipped.

accepted_doc_uuidsstring[]

Document UUIDs for which a new Docs-to-Digital job started. Processing is asynchronous, results arrive through the same channels as the upload-based flow.

skipped_doc_uuidsstring[]

Document UUIDs excluded from this run because they already completed a Docs-to-Digital comparison.

Example response

{
  "started": true,
  "accepted_doc_uuids": [
    "8dc88eed-2b6f-414a-82f2-a99bd181cf6e"
  ],
  "skipped_doc_uuids": [
    "e3f2f66a-2792-439e-905f-240c33a84bd1"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.