Sync PDF form field values using Instant JSON

Types

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

The optional keys are specified as follows:

{ optionalKey?: value; }

To reduce payload size, omit optional keys when their values are 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 list boxes and checkboxes. Combo boxes are single-select.
  value?: string | Array<string>,
};

Date form fields

A date form field uses the same FormFieldValue structure as other text form fields. Store the date as a string that matches the field’s date formatting action — for example, AFDate_FormatEx("mm/dd/yy"):

{
  "format": "https://pspdfkit.com/instant-json/v1",
  "formFieldValues": [
    {
      "name": "Appointment date",
      "type": "pspdfkit/form-field-value",
      "v": 1,
      "value": "08/20/26"
    }
  ]
}

The name must be the fully qualified form field name. The value must match the date format configured by the field’s JavaScript formatting action, such as mm/dd/yy.

Instant JSON form field values don’t define a separate placeholder property. The value property represents the field’s actual value, not placeholder text. Refer to the form field schema and widget annotation guides for field configuration options.