Instant JSON

Information

PSPDFKit Processor has been deprecated and replaced by Document Engine. To start using Document Engine, refer to the migration guide. With Document Engine, you’ll have access to robust new capabilities (read the blog for more information).

Instant JSON is a format we created for bringing annotations and bookmarks into a modern format while keeping all important properties to make the Instant JSON spec work with PDF. The format is fully documented and can be easily converted to XFDF to make it interoperable.

It’s designed for synchronizing annotations to a server, and across users, devices, or sessions. It can be used without licensing PSPDFKit Instant or Document Engine.

Key Capabilities

  • Annotation diff – Built-in support for comparing changes

  • Deleted annotations – Can store deleted annotations, unlike XFDF

  • Minimal syntax – Easy to understand and use

  • Compact file size – Faster loading, less storage & network transfer

Guides for Instant JSON

How It Works
Learn how PSPDFKit applies Instant JSON files to documents

Annotations Schema
Learn about the Instant JSON schema used for annotations

File Attachments Schema
Learn about the Instant JSON schema used for file attachments

Form Field Values Schema
Learn about the Instant JSON schema used for form field values

Form Fields Schema
Learn about the Instant JSON schema used for form fields

Bookmarks Schema
Learn about the Instant JSON schema used for bookmarks

Actions Schema
Learn about the Instant JSON schema used for actions

Comments Schema
Learn about the Instant JSON schema used for comments

Reference for Instant JSON

Please refer to Instant JSON Reference for a full description of the Instant JSON format.