Processing

Security and OCR Nodes Reference

Technical reference for `ocrPdf`, `signPdf`, `protectPdf`, and `unlockPdf`, including current async OCR behavior and signing constraints.

Updated 2 min read

Overview

These nodes add text extraction, signature overlays, password protection, or password removal to PDF workflows.

Configuration / Settings

NodeKey settingsDetails
ocrPdflanguage, outputFormatSidebar exposes text or JSON output selection.
signPdfsignature placements, coordinates, showTimestampMultiple signatures are applied sequentially.
protectPdfpasswordThe API also supports permission flags such as print/modify/extract/annotate.
unlockPdfpasswordRequired to remove encryption.

Inputs Expected

  • All covered nodes expect PDF files.
  • signPdf expects either a legacy text signature or the newer multi-signature configuration from the signature panel.
  • protectPdf requires a password of at least 6 characters at the API layer.

Variables Exported / Outputs

NodeOutput shapeNotes
signPdfBlob[]Signed PDFs only.
protectPdfBlob[]Protected PDF files.
unlockPdfBlob[]Unlocked PDF files.
ocrPdfcurrent implementation nuanceThe OCR route enqueues an async job and returns a JSON job payload, so workflow automation should treat OCR as currently constrained until status polling is wired into the executor.

Common Use Cases

  • Apply visible signatures before a download or Drive upload.
  • Lock sensitive PDFs before emailing them externally.
  • Unlock encrypted inbound PDFs before conversion.
  • Submit OCR work for scanned documents that need later extraction.

Edge Cases

  • OCR is asynchronous in the current API design. The route returns a job reference rather than final extracted text in the first response.
  • signPdf processes signatures one at a time per file, so large signature sets increase run time linearly.
  • protectPdf and unlockPdf both fail fast when the password is missing or invalid.