PDF form field values JSON format schema

Types

This section explains how to use type declarations in Instant JSON records.

The optional keys are specified as follows:

{ optionalKey?: value; }

To save traffic, these keys shouldn’t be included in the record if the value is undefined.

Form field values

Form field values were added as new Instant types to sync form field values across different devices. The name of a form field value must always be the fully qualified name of a PDF form field:

// Example of the Instant JSON schema of a form field value:
{
  "name": "Client name",
  "type": "pspdfkit/form-field-value",
  "v": 1,
  "value": "PSPDFKit"
}

declare type FormFieldValue = {
  v: 1,
  type: "pspdfkit/form-field-value",
  name: string,
  // Multiple values are allowed for combo boxes, list boxes, and checkboxes.
  value?: string | Array<string>
};